Files
BlueArchiveToolkit/docs/architecture/official-resource-backend.md
T
nyaKazuha f441f1810e
bat-rust / Build and test Rust (push) Canceled after 0s
bat-rust / Build and test Go API (push) Canceled after 0s
feat(i18n): 接入翻译 provider worker
Closes #44
2026-08-30 21:13:31 +08:00

29 KiB
Raw Blame History

官方资源后端说明

本文档说明 BlueArchiveToolkit 中“官方资源后端”的职责、数据流和工作原理,供审核使用。

1. 范围

这个后端只处理 日服官方资源,只接受官方 .jp/.com 域名下的资源链路。

Release 布局、URL→磁盘映射、seed 模板与 bat-api 分发 path 的冻结契约见:

  • docs/architecture/resource-release-layout.md

明确排除:

  • bluearchive.cafe
  • 任何镜像层、转写层、二次代理层
  • 人工拼接出来的样例 URL
  • Linux 生产环境安装或执行官方启动器
  • 把已安装客户端目录或官方启动器安装目录当作生产输入

本地 HTTP/SOCKS 代理只允许作为 curl 传输层配置使用,不改变资源来源判定。无论是否配置代理,下载器仍只接受官方 URL,并拒绝镜像、转写或非官方资源域名。

当前默认平台集合是:

  • Windows
  • Android

iOSmacOS 已从默认支持中移除。

2. 后端负责什么

任务 结果
发现层 读取官方 server-info,选择 connection group 和版本覆盖 得到官方资源根和种子端点
清单层 解析 BundlePackingInfo.bytesTableCatalog.bytesMediaCatalog.bytes 得到完整文件清单
计划层 合并 discovery + inventory,去重并保序 得到全量 pull plan
下载层 校验官方 URL,调用下载器,落盘并记录字节数 得到本地资源副本
导入层 可配置将已校验官方 release 写入 CAS 和 ResourceRepository 得到可查询的资源索引
同步层 比较当前快照和历史快照 决定下载、校验、发布
更新层 保存上次官方 snapshot,定期执行 discovery + diff + pull 形成自动更新闭环

3. 工作原理

3.0 Linux 生产约束

生产环境目标是 Linux 后端任务,不是 Windows 桌面客户端环境。

因此生产同步入口必须满足:

  1. 不要求安装官方启动器。
  2. 不要求启动官方启动器进程。
  3. 不要求把生产环境当作客户端安装目录。
  4. 可以显式执行 official metadata discovery 自动发现 server-info URL、connection-groupapp-version
  5. 也可以通过配置、调度状态或已审计 metadata snapshot 显式提供这些值。
  6. --auto-discover 只允许通过官方 HTTP metadata 和临时目录解析 GameMainConfiglauncher metadata 与 remote manifest 文件列表 digest 均未变时必须复用缓存,任一变化时才按 manifest 重新下载必要 resources.assets 或旧版官方 game zip。

3.1 发现官方资源根

入口是 YostarJpServerInfo

流程是:

  1. 读取官方 server-info JSON。
  2. connection_group + app_version 规则选择版本覆盖。
  3. AddressablesCatalogUrlRoot 提取 root token
  4. 校验该 root 只能落在官方 prod-clientpatch.bluearchiveyostar.com 之下。
  5. 基于 root token 生成 discovery 端点。

对应实现主要在:

  • adapters/src/official/yostar_jp.rs

3.2 枚举完整资源清单

资源清单不是“猜几个文件”,而是从官方 catalog 字节里提取完整文件名或相对路径列表。

当前做法:

  1. 读取 BundlePackingInfo.bytes
  2. 提取所有 FullPatch_*.zip 包名。
  3. 读取 TableCatalog.bytes
  4. 提取所有表资源名,例如 ExcelDB.db
  5. 读取 MediaCatalog.bytes
  6. 提取所有媒体下载相对路径,例如 GameData/Audio/VOC_JP/JP_Airi.zipPrologue/Scenario/Event/10000_Title_Sound.ogg

然后对 verified platforms 生成完整 URL 集:

  • Windows patch pack
  • Android patch pack
  • TableBundles
  • MediaResources-Windows
  • MediaResources

对应实现主要在:

  • adapters/src/official/inventory.rs
  • adapters/src/official/yostar_jp.rs

3.3 组装全量 pull plan

OfficialResourcePullPlan 是这个后端的关键对象。

它做三件事:

  1. 保存 discovery 端点。
  2. 保存完整 inventory。
  3. 用默认平台集或指定平台集生成最终 URL 列表。

all_urls() 是执行层的权威输入:

  • 先放 discovery URLs
  • 再放 content URLs
  • 统一去重
  • 保持顺序

这意味着后端拉取的是 完整资源包集合,不是抽样下载。

对应实现主要在:

  • infrastructure/src/official_pull.rs

3.4 执行下载

OfficialResourcePullService 负责真正下载。

工作方式:

  1. 检查 URL 是否属于官方 host。
  2. 把 URL 映射到当前工作根目录下的本地输出路径;在自动更新服务中,读侧根目录是 current 指向的 versioned 目录,写侧根目录是 staging。
  3. 读取工作根目录下的 official-download-manifest.json
  4. 已存在目标文件只有在本地清单中的相对路径、size、BLAKE3 都匹配时才跳过;.zip 文件还必须通过 ZIP central directory / local header 结构校验。
  5. 缺少清单、清单不匹配、ZIP 结构无效或文件损坏时重新下载。
  6. TableCatalog.bytesBundlePackingInfo.bytesMediaCatalog.bytes 总是刷新并用官方 .hash 强校验;该 .hashxxHash32(seed=0) 的十进制文本。
  7. catalog_*.hash 当前只作为 Addressables catalog 变更标记,不作为 zip/JSON 内容校验算法;Unity Addressables/SBP builder 对 JSON/bin catalog 使用 HashingMethods.Calculate 生成 Hash128 文本,运行时用它判断 remote catalog cache 是否过期,它不能套用 seed catalog 的 xxHash32 规则。
  8. 官方 seed .hash 校验失败会让当前下载失败,并移除对应 data/hash URL 的本地 manifest 条目,避免失败产物在下一轮被本地 BLAKE3 audit 误判为健康缓存。
  9. 官方启动器/server-info 先于 client-patch CDN 开放是合法上游状态。若 seed marker 或必需 seed catalog 在进入 staging 前返回 403/404/普通 4xx,更新服务返回 waiting_for_official_resourcesunavailable_endpoints,保留现有 current,不创建失败 staging,不写入 failed_versionswatch/daemon 使用 waiting 状态按错误重试间隔继续探测。
  10. 存在 .part 临时文件时通过 curl --continue-at - 尝试断点续传。
  11. 新下载写入 .part,成功并通过必要校验后原子 rename 到 staging 内最终路径;断点续传后的 .zip 如果结构无效,会删除 .part 并重新全量下载。
  12. 成功下载后更新本地下载清单。
  13. 上一轮失败或中断留下的 staging 只有在 official-version-state.json 中存在同一 app version、bundle version 和 Addressables root 的失败记录,且 <output>/.staging/<id> 仍安全存在、versions/<id> 尚未发布时才会复用;复用后仍按 manifest、BLAKE3、ZIP 结构和官方 .hash 逐 URL 校验,不信任散落文件。
  14. curl 默认自动检测 HTTPS_PROXY / ALL_PROXY / HTTP_PROXY 及小写环境变量,保留 NO_PROXY;带凭据的代理推荐用这些环境变量配置。CLI 也可用 --proxy <URL> 显式指定代理,或用 --no-proxy 强制直连。代理决策会进入 progress log、daemon log 和 doctor 诊断输出。代理凭据全程不落世界可读位置:日志与 status 输出脱敏;传给 curl 子进程时经 ALL_PROXY 环境变量而非 --proxy 参数,不进 curl 的 /proc/<pid>/cmdline--daemon 模式下经环境变量下传后台子进程,不进子进程 argv 或 bat-status.json,复用凭据单独存于 bat-proxy.secret0600),clean-stable 会在后台停止后清除。
  15. curl 失败按 HTTP/网络类型分类:403/404/普通 4xx 不重试,5xx、429、DNS、连接、超时、中断和网络类错误按尝试次数重试。
  16. 单个 URL 最终失败时写入 official-download-quarantine.json,发出 Failed progress,并阻止发布不完整资源。
  17. 旧 launcher 包或 resources.assets 下载使用官方 launcher CDN 配置,primary CDN 失败后切换 official backup CDN;资源 patch host 不猜测非官方镜像。
  18. 记录最终文件大小、本次传输字节数、官方 hash 校验数和执行状态。
  19. 非官方 URL 直接拒绝。
  20. 下载调度默认并发数为 8,允许范围是 1..=256,由 --download-concurrency / BAT_DOWNLOAD_CONCURRENCY 配置。worker 从共享 plan 队列逐项领取任务,单个任务完成后立即领取下一个,不等待其他 worker 的当前任务;完成结果在协调线程即时更新 manifest、hash 事件和进度计数。 最终 OfficialResourcePullReport.items 仍按 OfficialResourcePullPlan 顺序排列,避免并发完成顺序泄露到发布和 API 读侧。

路径映射时会做分段清理,并在写入前做输出目录安全校验、相对路径归属校验和现有路径组件 symlink 检查,避免把不安全路径写进输出目录或通过 symlink 跳出输出目录。

对应实现主要在:

  • infrastructure/src/official_download.rs

3.5 导入到 CAS 和资源仓储

官方同步下载、校验并发布 release 后,可以通过 --import-repository.envBAT_IMPORT_REPOSITORY=1 自动触发 CAS + ResourceRepository 导入:

  1. 读取已发布 release 下的 official-download-manifest.json
  2. 逐条按 manifest 的相对路径、size 和 BLAKE3 重新校验本地文件。
  3. 把已校验字节写入 CAS;默认 CAS 根目录是 <output>/.cas,也可用 --import-cas-root / BAT_IMPORT_CAS_ROOT 覆盖。
  4. 将资源条目写入 SQLite ResourceRepository;默认索引路径是 <output>/resources.sqlite,也可用 --import-resource-db / BAT_IMPORT_RESOURCE_DB 覆盖。
  5. AssetBundle、TextAsset、TableBundle、Media、Manifest/Other 会按资源类型分类;资源 metadata 会通过 metadata_json 保存 release、平台、bundle path、parse status、TextAsset 名称和 TextUnit 数量/格式。
  6. 当前 release 的单条 TextUnit 明细和解析错误会写入 official-textunit-index.json,可通过 parse.text_units / parse.errors RPC 和 parse-text-units / parse-errors CLI 只读查询。

这层的意义是把“下载到磁盘的文件”变成“可查询、可复用、可去重”的资源对象。 resource.index RPC / CLI 只读查询现有 SQLite 索引;索引不存在时返回 available=false,不会因为查询创建空库。发布后的 TextUnit 队列还会在当前 release 根目录写入 translation-tasks.sqlite,由版本化 schema_migrations 管理 queued/running/failed/completed/skipped、provider run、lease、失败分类、 重试计划和 TextUnit 级译文结果。translation.tasks 优先查询这份状态库, translation.worker.run 由 Rust worker 回写状态;translation.task.update 仍供外部 provider 流程回写状态; 没有状态库的旧 release 才回退到 immutable JSON 队列。G-011 剩余工作是 CAS 诊断入口和面向大索引的查询优化。

对应实现主要在:

  • infrastructure/src/import.rs
  • infrastructure/src/resources.rs

3.6 同步决策

同步层只做判断,不做重业务。

它比较当前快照和历史快照,关注:

  • root token 是否变化
  • addressables root 是否变化
  • endpoint 是否变化
  • bundle version 是否变化

判断结果分三类:

  • UpToDate
  • DownloadAndVerify
  • DownloadVerifyAndPublish

对应实现主要在:

  • infrastructure/src/official_sync.rs

3.7 自动更新闭环

OfficialUpdateService 是当前 Rust 侧的自动更新核心,正式命令入口是 bat

集成边界:

  1. 当前生产集成路径是 Rust bat --watch / bat --daemon 持久运行;Go bat-api 应优先通过 internal/backendrpc 调用 daemon RPCone-shot/fallback 场景才运行 bat --json 并消费结构化 report。
  2. systemd、容器或上层 Go 进程只负责守护 bat --watch / bat --daemon,不直接接管下载器内部状态。
  3. bat-ffi 只允许作为可选无状态 C ABI 兼容层,用于 Manifest inspect 和 sync plan 这类一次性 JSON helper;它不是官方同步 daemon、下载器、资源锁、CAS handle 或主控制面的承载位置。

流程是:

  1. 显式执行 --auto-discover 或读取已审计 server-info 输入。
  2. --auto-discover 先抓官方 launcher metadata、launcher CDN config 和 remote manifestmetadata 与 remote manifest 文件列表 digest 均未变时复用 official-bootstrap-cache.json 中的 GameMainConfig 摘要,任一变化时按 manifest 临时下载 resources.assets 或旧版官方 game zip 并重新解析。
  3. 生成当前 v2 snapshot,记录 app_versionconnection_groupbundle_versionaddressables_root、endpoint URL、seed .hash 内容、catalog_*.hash marker、launcher metadata 摘要、remote manifest 文件列表 digest 和 GameMainConfig 摘要。
  4. 读取上一次成功同步写出的 snapshot。
  5. 使用 OfficialSyncPlan 和扩展 snapshot diff 判断是否需要下载;URL 未变但 .hash / marker 内容变化也会触发更新。
  6. 每轮都会基于最新 seed catalog 构建当前 pull plan,并检查输出目录是否已有当前 plan 的 manifest 条目或目标文件。
  7. 如果远端 snapshot 未变化但输出目录没有任何当前 plan 的本地资源,仍按首次运行处理并执行全量拉取。
  8. 远端无变化且本地已有资源时执行 download manifest audit,检查路径、size、BLAKE3 和 ZIP 结构。
  9. 远端变化、本地 audit 发现 repair_needed,首次空目录运行,或缺少 current 原子发布指针时,进入下载/发布流程。
  10. 下载先写入 <output>/.staging/<id>;若已有 active release,会先 seed staging 以复用已验证文件;若 version-state 中存在同一版本的失败 staging,则优先复用该 staging 并跳过 active seed,避免旧 active 覆盖已下载的新文件。
  11. 下载、manifest、本地 BLAKE3、ZIP 和官方 .hash 校验完成后写入新的 snapshot,并在 staging 中写入 official-launcher-bootstrap.json(若本轮启用 --auto-discover)。
  12. 将 staging rename 为 <output>/versions/<id>,再原子替换 <output>/current symlink 指向该 versioned 目录。
  13. 发布完成后先对比上一完整 release 和当前 release 的 official-download-manifest.json,写出 official-resource-changes.jsoncrowdin-translation-handoff.json。同一 destination 只有 size 或 BLAKE3 变化才算 modified;新增+变更资源进入解析/翻译 handoff,删除资源只进入差异记录。当前只预留 Crowdin 本地 handoff,不发外部 API 请求。
  14. 随后刷新 active release 下的 official-parse-cache.jsonofficial-textunit-index.json,并从 Added/Modified 资源、parse cache 与 TextUnit 明细索引派生 official-textunit-tasks.jsoncrowdin-textunit-queue.json 和版本化的 translation-tasks.sqliteup-to-date 轮询在已有有效解析缓存、TextUnit 明细索引和 TextUnit 队列时只读取摘要,不重复解析,重新同步队列时保留已有 worker 状态。
  15. 若启用 --import-repository,已校验 release 会被导入 CAS + ResourceRepository,并可经 resource.index 查询。
  16. 官方同步报告默认给出 localized_release_status=not_localized,表示原版资源已发布、汉化资源未发布;UnityFS TextAsset patch 发布成功并通过 localized-patch-manifest.json、current symlink 和 release ID 校验后,localized.status 才返回 localized,表示原版和汉化两套资源都已发布。translation.proofread 只会把 workflow 标记成 manual_proofreading / translation.manual_proofreading,不会回退已发布汉化 release 的发布状态。

维护期特殊分支:如果官方 launcher/server-info 已经指向新资源根,但 client-patch seed marker 或必需 seed catalog 仍返回 403/404 等未开放状态,bat 返回 waiting_for_official_resources,保留现有 current,不创建失败 staging;若本轮启用 --auto-discover,会在 <output>/official-launcher-bootstrap.pending.json 写入待处理 launcher bootstrap 证据,供后续排障和自研客户端开发使用。

该入口不安装、不执行官方启动器,也不读取生产外的本地客户端目录。Rust 正式 binary bat 支持单次运行、--watch 常驻模式、--daemon 后台模式,以及 statusstoprestartreloadlogsrefreshverifyrepairdoctorclean-stable 管理命令。--daemon 会在后台状态目录下创建 bat.sock,使用 Unix socket JSON-RPC 作为 live control planebat.pidbat-status.jsonbat-daemon.log 是快照、诊断和兼容 fallback;bat-events.jsonl 是带轮转的结构化 JSONL 事件日志;bat-control.lock 串行化控制命令,并在 stale/corrupt 时由下一次控制命令或 clean-stable 恢复。bat-status.jsonstatus 子命令包含最后成功时间、下次检查时间、最后错误摘要、当前阶段和当前下载 URL 进度。PID、status、log 和控制锁文件创建时使用私有权限,读取和写入时不跟随 symlink。statusstoprestartlogsreload、默认形态的 refresh 和默认形态的 repair 优先走 RPCreload 会唤醒或排队 watch 循环重新自动发现并强制刷新,默认 repair 会通过 resource.repair 入队本地 manifest 审计+修复任务,live RPC restart 会启动 Rust lifecycle controller 并复用 CLI restart 路径替换进程;显式 --proxy / --no-proxy 会作为启动参数保存并在后台重启时复用。后台 daemon 管理某个资源目录时,前台 run/watch/refresh/repair 不允许直接写入同一目录;默认形态 refresh 会通过 RPC 触发后台刷新,默认形态 repair 会通过 RPC 入队任务。正常情况下默认每 1 小时执行一次检查;每天北京时间(UTC+8)03:0016:0018:00 会中断普通 sleep 并强制执行一次自动刷新,该轮注入 force=true。远端和本地一致时静默等待下次检查,不一致时自动下载或 repair。下载、发现或校验失败时不等待完整正常周期,默认 60 秒后重试;如果固定时间强制刷新失败,会保留 pending force 并按失败重试周期继续重试,可用 --error-retry--error-retry-seconds 调整。默认官方原版资源输出目录是 ./bat-resources,默认汉化产物目录是 ./bat-localized,默认后台状态目录是 /tmp/bat-pid,三者分别通过 --output--localized-output--state-dir 配置;官方目录和汉化目录不能相同或互相嵌套。单次运行仍保留为核心幂等路径,systemd service、容器或 Go 进程可以只负责守护该常驻进程;cron/systemd timer 调单次模式只是可选集成方式。项目是否热更新、热重载或重启进程,由上层业务集成决定。

对应实现主要在:

  • infrastructure/src/official_update.rs
  • infrastructure/src/bin/bat_official_sync.rs(薄入口)
  • infrastructure/src/bin/bat/app.rs(控制面组合)
  • infrastructure/src/bin/bat/task_registry.rs(任务注册表、持久化和 worker
  • infrastructure/src/bin/bat/readonly_query.rstranslation_query.rs(只读查询)
  • infrastructure/src/bin/bat/patch_commands.rspatch 命令)
  • infrastructure/examples/official_update_check.rs(历史/开发入口)

4. 官方 bootstrap 与用户流程

当前已经提供的官方用户流程分两类。

Linux 生产路径:

  1. 显式执行 --auto-discover,或提供已审计的官方 metadata snapshot。
  2. official_pull_plan 依据官方 server-info、catalog 和 verified platforms 生成全量拉取计划。
  3. bat 对比上次 snapshot 和远端 .hash marker;远端无变化时 audit 本地清单,有变化或本地损坏时下载、校验并落盘官方资源。

开发/审计辅助路径:

  1. official_launcher_bootstrap 获取官方 launcher 信息。
  2. official_game_main_config 按官方 manifest 获取 resources.assets(旧 ZIP manifest 则先解出)并解密 GameMainConfig
  3. 手动确认最新 PC metadata、server-info URL 和默认 connection group。

自动发现路径和开发/审计辅助路径都只使用官方 HTTP 和临时目录,不安装或启动官方 launcher。

这些入口都只接受官方域名,不走 bluearchive.cafe 镜像链。

5. 已验证行为

当前代码已经验证:

  • 默认平台是 Windows + Android
  • iOSmacOS 不再进入默认官方流程
  • verified inventory 会产出完整内容 URL 集
  • pull plan 会同时包含 discovery URLs 和 content URLs
  • 全量样本下是 2 个 discovery URL + 5 个内容 URL = 7 个 URL
  • OfficialUpdateService 能持久化 v2 snapshot,并在远端 marker 内容变化时触发下载决策
  • bat 默认向 stderr 输出 BlueArchiveToolkit ASCII banner 和 progress logstdout 默认输出人类可读摘要;progress log 覆盖代理决策、下载已完成计数、单文件开始/完成状态、下载中断失败分类和校验结果摘要;支持 --proxy / --no-proxy 控制 curl 传输代理,支持 --json 输出稳定 JSON,支持 --no-progress 关闭进度日志,支持 --no-banner 只关闭横幅,支持 --watch --interval 1h --error-retry 60s 常驻运行,支持 --daemon Unix socket JSON-RPC live control/backenddaemon.status/logs/stop/restart/reload/refresh/doctorresource.sync/verify/repair/state/manifest/list/indexparse.status/text_units/errorstranslation.tasks/handoff/task.updatelocalized.statuscatalog.*task.*、文件级 patch.apply / unityfs.patch_*);restart 通过 Rust lifecycle controller 复用 CLI restart 路径,clean-stable 仍由 CLI 侧按进程生命周期显式执行,非 dry-run 使用 .official-sync.lock 防止并发写资源目录,控制命令使用 bat-control.lock 防止并发状态修改,资源发布使用 .stagingversionscurrent 原子切换,daemon 写 bat-events.jsonl 结构化日志并在 status 中暴露下载进度、失败类型、HTTP 状态和调度状态
  • curl 失败分类和重试策略已覆盖 404 不重试、5xx 重试耗尽后 quarantine、launcher primary CDN 失败后切换 official backup CDN
  • official-version-state.json 已覆盖当前完成版本、正在拉取版本、上一个可用版本和失败版本;同一 app version、bundle version 和 Addressables root 的失败只保留最新一条,重新拉取或成功发布后清理同版本失败记录,同版本失败 staging 会在路径安全且未发布时复用,bat status 会暴露版本状态摘要和最近历史失败原因
  • 资源导入链路已覆盖可配置 CAS 写入、ResourceRepository 索引、metadata_json release/平台/bundle/TextAsset/TextUnit 摘要,以及 TextAsset/Table/Media 分类;resource.index 可只读查询现有索引
  • 官方 release 发布后会生成 official-resource-changes.jsoncrowdin-translation-handoff.jsonofficial-parse-cache.jsonofficial-textunit-index.jsonofficial-textunit-tasks.jsoncrowdin-textunit-queue.json,为后续增量解析和 Crowdin worker 预留稳定输入
  • 离线回归样本已覆盖当前 catalog、上一个版本 catalog、catalog 结构变化、403、404 和 seed hash mismatch
  • OfficialUpdateService 能读写 official-bootstrap-cache.json,并支持默认开启的 audit_local / repair CLI 行为
  • 下载层能在本地文件 size/BLAKE3/path、ZIP 结构或 manifest 不匹配时重新下载
  • 官方 seed .hash mismatch 会导致下载失败,而不是降级为本地 BLAKE3 猜测
  • 非官方 URL 会在 fetch/download 入口被拒绝
  • 真实官方网络全量下载 smoke 已固化为 scripts/official-full-pull-smoke.shmake official-smokedocs/guides/official-full-pull-smoke.md;大型资源文件和运行报告默认保留在 /tmp 隔离目录,不纳入 Git

相关验证主要来自:

  • cargo test -p bat-adapters -- --nocapture
  • cargo test -p bat-ffi -- --nocapture
  • cargo test -p bat-infrastructure -- --nocapture
  • cargo test -p bat-infrastructure --bin bat -- --nocapture
  • cargo run -p bat-infrastructure --bin bat -- --help

6. 审核重点

请重点检查这几件事:

  1. 是否只接受官方 host。
  2. 是否默认只走 Windows + Android。
  3. 是否把完整 content URL 集都纳入 all_urls()
  4. 是否拒绝镜像域名和手工拼接样例。
  5. 是否在下载前做了 URL 和路径安全校验。
  6. 是否能在官方客户端变动时只改适配层。

7. RPC Backend API 与 Go 调用边界

daemonbat --daemon)在 <state-dir>/bat.sock 上提供 Unix socket JSON-RPC 2.0 服务,是面向上层服务(Go 层)的主要跨语言边界。 稳定方法、schema 和错误语义以 docs/reference/rpc-backend-api.md 为准。

7.1 协议契约

  • 应用层统一 envelope(装入 JSON-RPC result):ok / status / data / error / request_id;传输层解析失败走 JSON-RPC 顶层 error-32700)。
  • error 为统一 ApiErrorcodeBAT-ERR-<6 位>)、kinddomainlocationmessageretryable。码表以 core/src/error_code.rs 为准。
  • 长任务(resource.sync / resource.verify / resource.repair / catalog.refresh 入队即返回 task_id,经 task.status / task.list / task.logs 轮询,task.cancel 协作式取消。任务执行器是单 worker FIFO与 watch 循环经进程内锁互斥。任务历史持久化于 <state-dir>/bat-tasks.json (版本化、0600 原子写,生命周期转换时落盘),daemon 重启后历史任务 仍可经 task.* 查询,中断任务标记 task_interrupted700005)。
  • 方法命名空间与实现状态、请求/响应示例见 docs/reference/rpc-backend-api.mddaemon.status/logs/stop/restart/reload/refresh/doctorresource.state/sync/verify/repair/manifest/list/indexparse.status/text_units/errorstranslation.tasks/handoff/task.update/proofreadlocalized.statuscatalog.*task.status/list/cancel/logs 已实现;文件级 patch.apply / unityfs.patch_* 已实现,发布级 patch 与复杂 UnityFS 语义编辑待引擎; task.create 按设计暂不开放通用任务入口; daemon.restart 通过 Rust lifecycle controller 复用 CLI restart 路径; daemon.clean-stable 仍由 CLI 侧按进程生命周期显式执行。

7.2 Go 层职责边界

  • Rust bat / daemon 是资源生产者和状态拥有者;Go bat-api 是资源读侧、 bootstrap 和 HTTP 分发入口。二者之间的稳定边界是 bat.sock RPC 和 resource_root 中已发布的只读文件。
  • Go 层负责:资源 bootstrap、资源内容分发(cmd/bat-api)、HTTP API 进程配置、 以及通过 internal/backendrpc 作为 RPC client 调用本机 daemon(连接 bat.sock,每行一个 JSON-RPC 请求/响应)。cmd/bat 仍是试验骨架,不是产品级用户 CLI。
  • bat-api(资源分发,issue #19
    • 提供 /v1/bootstrap,把 bat 的 RPC 健康、release 摘要、server-info URL、 client-patch base 和改写后的 Addressables root 组织成启动前资源发现响应。
    • 提供 /healthz 作为 liveness + 最近一次 RPC refresh 诊断,提供 /readyz 作为 release readiness;当前无可分发 release 时 /readyz 返回 503
    • 只读提供 Rust bat 已发布 release 中的资源字节(官方 CDN host/path 形态)。
    • CDN path 支持 GET / HEAD / Range / 条件请求;ETag 优先使用 download manifest 中的 BLAKE3,响应包含 Last-Modified、Accept-Ranges 和长期缓存头。
    • 版本/清单发现优先走 RPC:先 daemon.status,再 daemon.doctor,再 catalog.status / resource.manifest(可用 --socket 指定 socket 文件)。
    • 支持 .env / 环境变量配置监听端口、public base URL、RPC socket 和 RPC 刷新周期,并预留 database/redis 键供后续 API 持久化;负责资源自动拉取。
    • 可选改写 server-info 中的 AddressablesCatalogUrlRoot 指向自身;不伪装 完整游戏业务 API。启动前资源 metadata 兼容属于资源 bootstrap;账号、登录、 Gateway、游戏业务 ApiUrl 和鉴权全链非本服务关闭条件。
  • Rust bat / daemon 负责:官方资源自动发现与拉取、校验、catalog 更新检查、 版本状态与发布、任务队列/日志/错误/进度管理等长期状态型工作。
  • Go 层直接嵌入 Rust FFI,不直接读写 daemon 的状态文件;跨语言控制面 只经 RPC 契约。生产文件字节从 RPC 给出的 resource_root 读取,bat-api 与 daemon 同服务器、同容器或同一共享文件系统部署;显式 --resource-root 只用于 fixture、本地开发或 RPC 不可用时的应急只读诊断。

7.3 FFI 的定位(降级说明)

bat-ffi crate(cgo 头文件 + 静态/动态库链接,见 Makefilebuild-ffi / build-go降级为可选的历史兼容边界:保留用于既有 cgo 试验路径与本地工具,不再作为 Go 服务层的主要集成方式,也不会按 RPC 契约的节奏扩展。新能力一律先落 RPC 方法。