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