Skip to content

Latest commit

 

History

History
89 lines (62 loc) · 8.41 KB

registry.md

File metadata and controls

89 lines (62 loc) · 8.41 KB

registry/ · 资源命名登记处

定位:共享基础设施(一台服务器多项目共用 PG/Redis/Kafka/Nacos/MinIO…)的租户边界标识唯一登记处;前端应用名(微前端)同样在此登记(第四节,2026-09-07 起);移动 App 亦在此登记(第五节,2026-09-09 起)。全部 infra 规约的隔离模型(Redis key 前缀、Kafka/RocketMQ topic 前缀、Nacos Group、ES 索引前缀、MinIO bucket、Milvus collection、CH/SR 库名)都压在"服务名唯一"这一前提上——本表就是那个前提的守门人(架构评审 P0-4,2026-09-01)。

一、服务名规则(租户边界标识)

  1. 【强制】格式 ^[a-z][a-z0-9-]{1,31}$:小写字母数字短横线,字母开头,2~32 字符;禁下划线、大写、中文。
  2. 【强制】禁裸通用词:user、api、admin、gateway、common 等单词语不得单独成名,必须带项目/领域前缀或后缀消歧(如 ysaas-user)。
  3. 【强制】服务名一经登记并产生基础设施资源(key/topic/bucket…)即冻结:改名 = 资源迁移,走变更评审;本表保留改名记录。
  4. 【强制】一个服务名一个属主(业务仓),跨仓共用一个服务名视为边界击穿事故。

二、服务名登记表

服务名 属主(仓库/项目) 登记日期 启用的基础设施前缀 备注
ysaas ysaas(首个客户) 待登记 — 示例行:首个业务工程接入时正式登记
yagent yagent 待登记 — 示例行
ybookreading ybookreading 2026-09-14 — 本地 TXT 小说阅读器(Android 原生,纯本地无后端,不启用共享基础设施前缀)
ycomp ycomp(组件资产平台) 2026-09-18 PG 库 ycomp yarch 首个完整 dogfood 消费工程:前端组件资产平台(登记/预览/同步/追踪),独立仓与 yarch 同级;后端 rust(rust 栈触发工程);设计定稿见 yarch 仓 docs/superpowers/specs/2026-09-18-ycomp-component-platform-design.md

登记方式:PR 修改本表即登记;重名在 CI/评审阶段拒绝。

三、派生资源登记指引(前缀必须以本表服务名为首段)

各项目按需组合基础设施规约(无全家桶假设,组合关系见 README.md「规约组合与依赖模型」);本表只登记该项目实际启用的资源。

资源 登记处 规约出处
Redis key / Kafka·RocketMQ topic / ES 索引 / Milvus collection / CH·SR 库 各业务仓 docs/(属主维护) infra/redis.md 二-1、infra/kafka.md 二-6、infra/rocketmq.md 二-5
MinIO bucket、XXL-Job 任务、Nacos Group 各业务仓 docs/ infra/minio-s3.md 一-4、infra/xxl-job.md 一-3
wss 长连接域名(实时通道入口) 各业务仓 docs/(网关入口域名;微信小程序后台 socket 合法域名白名单须同值) api/realtime.md 一-4
埋点事件注册表(tracking plan:事件名/属性 schema/属主) 各业务仓 docs/ api/telemetry.md 一-1
错误码 3xxx+ 段位 各业务仓 docs/ api/error-codes.md 段位分配

派生资源的首段(服务名)必须能在本表查到属主;查不到 = 未登记资源,CI/巡检视为违规。

四、前端应用名登记(微前端)

条文出处:web/micro-frontend.md 二;约束对象:微前端基座与子应用。应用名一名三用:路由前缀 / storage key 前缀 / 自定义事件名前缀——同域名下这三者都是物理共享空间,本表即其隔离边界。

  1. 【强制】应用名格式同服务名(一-1),且由「服务名-用途/域」两段及以上构成,首段必须是本表一、二节已登记的服务名(如服务名 ysaas → 基座 ysaas-console、子应用 ysaas-billing);不得直接使用纯服务名。
  2. 【强制】同项目基座与全部子应用互不重名;跨项目不得重名(同域名 storage 与事件空间物理共享)。
  3. 【强制】应用名一经登记并产生路由前缀/storage key/事件名即冻结;改名走一-3 同款变更评审。
应用名 类型(基座/子应用) 属主服务名 路由前缀 登记日期 备注
ysaas-console 基座 ysaas / 2026-09-09 微前端首批示例(仓内 stacks/web/examples/ysaas-console)
ysaas-billing 子应用 ysaas /ysaas-billing 2026-09-09 微前端首批示例(仓内 stacks/web/examples/ysaas-billing)
ycomp-console 单应用(非微前端) ycomp / 2026-09-18 组件资产平台 console(npm create @yarch/admin --ui antd 产出;micro-frontend.md 一-4:单团队不为微前端而微前端)

五、移动 App 登记(clients)

条文出处:clients/client-shared.md 四;约束对象:android / ios 原生 App。App 名是服务名在终端空间的延伸;双端包标识(applicationId / bundle id)必须一致且互为派生——推送证书、深链 scheme、商店资源都以它为锚。

  1. 【强制】App 名格式同服务名(一-1),由「已登记服务名-用途」两段构成(如 ysaas-companion);首段必须能在本表一、二节查到属主,不得直接使用纯服务名。
  2. 【强制】同一 App 的 applicationId(android)与 bundle id(ios)由 App 名按各平台惯例派生(clients/android.md 三、clients/ios.md 三模板定式),双端不一致即登记缺陷。
  3. 【强制】App 名一经登记并上架(商店资源 / 推送证书 / 深链 scheme)即冻结;改名走一-3 同款变更评审。
App 名 属主服务名 applicationId / bundle id 平台(android/ios/双端) 登记日期 备注
ybookreading-reader ybookreading io.github.ydonghao.ybookreadingreader android 2026-09-14 首个移动 App 工程;v1 纯本地无后端,未上架前改名不涉变更评审

六、小程序与小游戏登记(clients)

条文出处:clients/miniprogram.md 四、clients/game.md 四;约束对象:微信小程序 / 微信小游戏(两种独立主体,一个 AppID 二选一)。名称是服务名在微信生态的延伸;共享基础设施隔离口径(storage key 前缀等)以它为锚。

  1. 【强制】名称格式同服务名(一-1),由「已登记服务名-用途」两段构成;首段必须能在本表一、二节查到属主,不得直接使用纯服务名。
  2. 【强制】主体类型(小程序 / 小游戏)与 AppID 属主同表登记;一经上架即冻结——改名走一-3 同款变更评审,改类型 = 换 AppID = 新登记(旧登记标记退役)。
  3. 【强制】跨形态复用只走共享层(契约内核 / 领域逻辑 / design token,clients/game.md 一-2),禁单工程双形态输出。
名称 主体类型(小程序/小游戏) 属主服务名 AppID 登记日期 备注
— — — — — 首个小程序 / 小游戏工程创建时正式登记

七、设备登记(domains/device)

条文出处:domains/device.md 一;约束对象:物理端设备(embedded 固件)与云端接入侧。设备标识 = {product}/{device} 两段——产品族是服务名在物理端的延伸(影子缓存、OTA 通道、证书吊销都以它为锚)。

  1. 【强制】产品族格式同服务名(一-1);设备名由「产品族-序号/用途」构成,首段必须是已登记产品族(正例 microduck-01)。
  2. 【强制】设备标识一经烧录/注册即冻结(证书/影子/遥测历史锚定其上);改名 = 新设备登记 + 旧登记退役。
  3. 【强制】设备凭证一设备一证书(device.md 六-2);吊销以证书黑名单/到期为准。
产品族 属主(项目) 登记日期 备注
microduck microduck(桌面机器人) 2026-09-14 device 契约首个双方言验证项目(云端 Go + esp32 Rust 固件)
设备名 产品族 登记日期 备注
— — — 首个设备出厂烧录时正式登记