您的位置 首页 java

JAVA编程规范之二方库依赖

一方库:本工程中的各模块的相互依赖

二方库:公司内部的依赖库,一般指公司内部的其他项目发布的jar包

三方库:公司之外的开源库, 比如apache、google、alibaba等发布的依赖

JAVA编程规范之二方库依赖

二方库依赖规范

1、【强制】定义 GAV 遵从以下规则:

1)GroupID 格式: com.{公司/BU }.业务线.[子业务线],最多 4 级。

2)ArtifactID 格式: 产品线名-模块名。语义不重复不遗漏,先到中央仓库去查证一下。

2、【强制】二方库版本号命名方式: 主版本号.次版本号.修订号。

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)稳定可追溯原则。每个版本的变化应该被记录,二方库由谁维护,源码在哪里,都需要能方便查到。除非用户主动升级版本,否则公共二方库的行为不应该发生变化。

文章来源:智云一二三科技

文章标题:JAVA编程规范之二方库依赖

文章地址:https://www.zhihuclub.com/177090.shtml

关于作者: 智云科技

热门文章

网站地图