Files
persionalBrand/docs/adr/0012-brand-publication-lifecycle.md

3.3 KiB

ADR 0012:品牌内容发布生命周期

背景

当前后台直接修改品牌、业务提供项、信任内容和咨询表单,公开接口会读取这些实时记录。这样无法区分“正在编辑的草稿”和“用户已经看到的版本”,也无法在模板导入、批量修改或误操作后安全预览、发布和撤回。多品牌场景下还必须保证发布版本按 brandId 隔离。

决策

引入品牌级发布版本(BrandRelease)作为公开内容的唯一读取边界:

  1. 后台编辑继续写入品牌工作区的草稿数据;草稿不直接影响公开接口。
  2. 发布时由服务端在事务中校验必填身份、视觉模板兼容性、已启用模块、公开业务项、表单字段和模板能力,然后生成不可变的运行时快照。
  3. public/* 和 public/workspace 只读取当前品牌的已发布快照;没有发布版本时返回明确的“尚未发布”状态,不回退到草稿或静态示例数据。
  4. 每个品牌最多一个当前发布版本,但保留历史版本用于审计和显式回滚。回滚是将历史快照重新发布为新版本,不直接修改草稿数据。
  5. 模板安装快照与发布快照分别负责不同职责:安装快照记录模板基线,发布快照记录用户可见的完整运行时投影;发布不能覆盖用户草稿。
  6. 发布、回滚和撤回都必须记录操作者、品牌、版本号、校验结果和时间;公开缓存按品牌发布版本失效。
  7. 发布前检查、快照读取和版本写入在同一个 Serializable 事务内完成;并发版本冲突有限重试。撤回单独记录 revokedBy,不覆盖原发布者。客户提交使用发布快照中的表单字段、业务项名称与报价,同时实时拦截已禁用业务。

不采用的方案

  • 仅在现有表上增加 published 布尔字段:无法保证跨表一致性,也不能恢复一组完整内容。
  • 公开接口继续读取实时表,同时由前端自行判断:客户端无法提供可靠的发布边界,并会造成不同页面读到不同版本。
  • 复制整套业务表作为发布表:数据重复、迁移成本高,且难以支持模板扩展字段。

后果

  • 需要新增发布版本表、生成快照的应用服务、发布/回滚 API 及集成测试。
  • 公开接口的响应需要增加 publication 元数据和未发布状态;小程序必须展示明确的空状态,而不是静默使用示例数据。
  • 后台首次配置流程可以围绕“选择模板 → 导入或空白 → 完善内容 → 预览 → 发布”组织,普通用户不需要理解模板内部结构。
  • 后台目前提供发布前的内容核对,不将其称作小程序视觉预览;最终视觉仍应通过小程序开发者工具验收。小程序不使用本地旧 workspace 兜底,以免撤回后离线缓存继续展示过期内容。

迁移计划

  1. 新增 BrandRelease 数据模型和可逆 migration;为现有 demo 品牌生成一次基线发布版本。
  2. 抽取运行时投影生成器,保证发布快照与当前 public/workspace 契约一致。
  3. 增加发布、回滚、撤回和未发布状态的授权与集成测试,再切换公开接口读取发布快照。
  4. 后台增加首次配置引导和发布检查清单;通过后再移除公开接口对草稿表的直接读取。