02 二方库规约

【强制】 定义 GAV 遵从以下规则：
- GroupId 格式：com.{公司/BU}.业务线.[子业务线]，最多 4 级。
  说明
  {公司/BU} 例如：alibaba / taobao / tmall / kaikeba 等 BU 一级；子业务线可选。
  正例
  com.taobao.jstorm 或 com.alibaba.dubbo.register
- ArtifactId 格式：产品线名-模块名。语义不重复不遗漏，先到中央仓库查证一下。
  正例
  dubbo-client / fastjson-api / jstorm-tool
- Version：详细规定参考下方。
【强制】 二方库版本号命名方式：主版本号.次版本号.修订号
- 主版本号：产品方向改变，或者大规模 API 不兼容，或者架构不兼容升级。
- 次版本号：保持相对兼容性，增加主要功能特性，影响范围极小的 API 不兼容修改。
- 修订号：保持完全兼容性，修复 BUG、新增次要功能特性等。
说明
注意起始版本号必须为：1.0.0，而不是 0.0.1。
反例
仓库内某二方库版本号从 1.0.0.0 开始，一直默默“升级”成 1.0.0.64，完全失去版本的语义信息。
【强制】 线上应用不要依赖 SNAPSHOT 版本（安全包除外）；正式发布的类库必须先去中央仓库查证，使 RELEASE 版本号有延续性，且版本号不允许覆盖升级。
说明
不依赖 SNAPSHOT 版本是为了保证应用发布的幂等性。另外，也可以加快编译时的打包构建。
【强制】 二方库的新增或升级，保持除功能点之外的其它 jar 包仲裁结果不变。如果有改变，必须明确评估和验证。
说明
在升级时，进行 dependency:resolve 前后信息比对，如果仲裁结果完全不一致，那么通过 dependency:tree 命令找出差异点，并使用 <exclude> 排除 jar 包。
【强制】 二方库里可以定义枚举类型，参数可以使用枚举类型，但接口返回值不允许使用枚举类型或包含枚举类型的 POJO 对象。
【强制】 二方库定制包的命名方式，在规定的版本号之后加 -英文说明[序号]，英文说明可以是部门简称、业务名称，序号直接紧跟在英文说明之后，表示此定制包的顺序号。
说明
例如，fastjson 给 SCM 定制的版本号：1.0.0-SCM1。
注意
请尽可能在应用端解决类冲突和加载问题，避免随意发布此类定制包。
【强制】 依赖于一个二方库群时，必须定义一个统一的版本变量，避免版本号不一致。
说明
例如，依赖 springframework-core、-context、-beans 时，可以定义一个变量来保存版本：${spring.version}，在定义依赖时引用该版本。
【强制】 禁止在子项目的 pom 依赖中出现相同的 GroupId，相同的 ArtifactId，但不同的 Version。
说明
在本地调试时，会使用各子项目指定的版本号，但合并成一个 war 文件后，只能有一个版本号出现在最终的 lib 目录中。曾经出现过线下调试正常，但发布到线上却出故障的先例。
【推荐】 底层基础技术框架、核心数据管理平台、或近硬件端系统谨慎引入第三方实现。
【推荐】 所有 pom 文件中的依赖声明放在 <dependencies> 语句块中，所有版本仲裁放在 <dependencyManagement> 语句块中。
说明
<dependencyManagement> 里只是声明版本，并不实现引入，因此子项目需要显式声明依赖，version 和 scope 均读取自父 pom。<dependencies> 中的所有声明会自动引入并默认被所有子项目继承。
【推荐】 二方库应尽量避免配置项，至少不再增加新的配置项。
【推荐】 不要使用不稳定的工具包或者 Utils 类。
说明
不稳定指的是提供方无法做到向下兼容，在编译阶段正常，但在运行时产生异常。因此，尽量使用业界公认稳定的二方工具包。
【参考】 为避免二方库的依赖冲突问题，二方库发布者应当遵循以下原则：
- 精简可控原则。移除一切不必要的 API 和依赖，只包含 Service API、必要的领域模型对象、Utils 类、常量、枚举等。如果依赖其它二方库，尽量使用 provided 引入，让二方库使用者自行依赖具体版本号；无 log 具体实现，只依赖日志框架。
- 稳定可追溯原则。每个版本的变化应被记录，二方库由谁维护，源码在哪里，都需要能方便查到。除非用户主动升级版本，否则公共二方库的行为不应发生变化。

02 二方库规约 ​

02 二方库规约