六、(二)二方库依赖

| 来源:阿里技术 微信公众号(id:ali_tech)。仅供于交流、学习、研究,勿用于商业用途!


1. 【强制】定义 GAV 遵从以下规则:
1 ) G GroupID 格式: com .{公司/ BU }.业务线. [ 子业务线 ] ,最多 4 级。
    说明:{公司/ BU } 例如: alibaba / taobao / tmall / aliexpress 等 BU 一级 ; 子业务线可选。
    正例: com . taobao . jstorm 或  com.alibaba.dubbo.register 
2 ) A ArtifactID 格式:产品线名-模块名。语义不重复不遗漏,先到中央仓库去查证一下。
    正例: dubbo - client /  fastjson - api /  jstorm - tool
3 ) V Version :详细规定参考下方。


2. 【强制】二方库版本号命名方式:主版本号.次版本号.修订号
1 ) 主版本号 主版本号:产品方向改变,或者大规模 API 不兼容,或者架构不兼容升级。
2 ) 次版本号 次版本号:保持相对兼容性,增加主要功能特性,影响范围极小的 API 不兼容修改。
3 ) 修订号 修订号:保持完全兼容性,修复 BUG 、新增次要功能特性等。
说明:注意起始版本号必须为: 1.0.0 ,而不是 0.0.1 正式发布的类库必须先去中央仓库进
行查证,使版本号有延续性,正式版本号不允许覆盖升级。如当前版本:1.3.3,那么下一个
合理的版本号:1.3.4 或 1.4.0 或 2.0.0


3. 【强制】线上应用不要依赖 SNAPSHOT 版本 ( 安全包除外 )。
说明:不依赖 SNAPSHOT 版本是保证应用发布的幂等性。另外,也可以加快编译时的打包构建。


4. 【强制】二方库的新增或升级,保持除功能点之外的其它 jar 包仲裁结果不变。如果有改变,
必须明确评估和验证,建议进行 dependency : resolve 前后信息比对,如果仲裁结果完全不一
致,那么通过 dependency : tree 命令,找出差异点,进行< excludes >排除 jar 包。


5. 【强制】二方库里可以定义枚举类型,参数可以使用枚举类型,但是接口返回值不允许使用枚
举类型或者包含枚举类型的 POJO 对象。


6. 【强制】依赖于一个二方库群时,必须定义一个统一的版本变量,避免版本号不一致。
说明:依赖 springframework - core ,- context ,- beans ,它们都是同一个版本,可以定义一
个变量来保存版本:${ spring . version },定义依赖的时候,引用该版本。


7. 【强制】禁止在子项目的 pom 依赖中出现相同的 GroupId ,相同的 ArtifactId ,但是不同的
Version 。
说明:在本地调试时会使用各子项目指定的版本号,但是合并成一个 war ,只能有一个版本号
出现在最后的 lib 目录中。可能出现线下调试是正确的,发布到线上却出故障的问题。


8. 【推荐】所有 pom 文件中的依赖声明放在< dependencies >语句块中,所有版本仲裁放在
< dependencyManagement >语句块中。
说明:< dependencyManagement >里只是声明版本,并不实现引入,因此子项目需要显式的声
明依赖, version 和 scope 都读取自父 pom 。而< dependencies >所有声明在主 pom 的
< dependencies >里的依赖都会自动引入,并默认被所有的子项目继承。


9. 【推荐】二方库不要有配置项,最低限度不要再增加配置项。


10. 【参考】为避免应用二方库的依赖冲突问题,二方库发布者应当遵循以下原则:
1 ) 精简可控原则。移除一切不必要的 API 和依赖,只包含  Service API 、必要的领域模型对
象、 Utils 类、常量、枚举等。如果依赖其它二方库,尽量是 provided 引入,让二方库使用
者去依赖具体版本号 ; 无 log 具体实现,只依赖日志框架。
2 ) 稳定可追溯原则。每个版本的变化应该被记录,二方库由谁维护,源码在哪里,都需要能
方便查到。除非用户主动升级版本,否则公共二方库的行为不应该发生变化。







  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值