微服务开发规范

微服务开发规范

环境约定

• debug: 无依赖（mock），本地联调（前端），单元测试
• dev: 有依赖，服务端联调，集成测试
• sit: 功能测试
• pre：上线前测试，演练，模拟上线
• prd：生产环境

版本号

• 通用约定

版本号的格式为 A.B.C (又称 Major.Minor.Patch)，递增的规则为：

A 表示主版本号，当 API 的兼容性变化时，A 需递增。
B 表示次版本号，当增加功能时(不影响 API 的兼容性)，B 需递增。
C 表示修订号，当做 Bug 修复时(不影响 API 的兼容性)，C 需递增。

详细的规则如下：
A, B, C 必须为非负整数，且不得包含前导零，必须按数值递增，如 1.9.0 -> 1.10.0 -> 1.11.0
0.B.C 的版本号表明软件处于初始开发阶段，意味着 API 可能不稳定；1.0.0 表明版本已有稳定的 API。
当 API 的兼容性变化时，A 必须递增，B 和 C 同时设置为 0；当新增功能(不影响 API 的兼容性)或者 API 被标记为 Deprecated 时，B 必须递增，同时 C 设置为 0；当进行 bug fix 时，C 必须递增。

* 注意：版本一经发布，不得修改其内容，任何修改必须在新版本发布！

• 开发版本号（编译版本号）

开发版本号常用于 CI-CD，格式为 A.B.C.build-[HHmmss]，如 1.0.1.build-073012。

• 一些修饰的词

alpha：内部版本
beta：测试版
demo：演示版
enhance：增强版
free：自由版
full version：完整版，即正式版
lts：长期维护版本
release：发行版
rc：即将作为正式版发布
standard：标准版
ultimate：旗舰版
upgrade：升级版

• jar sdk：测试通过前，采用 X.Y.Z-SNAPSHOT 命名规则
• docker 镜像：上线前，版本号采用开发版本号

数据库

索引约定：

• 唯一索引：uk_
• 一般索引：idx_
• 主键索引：pk_