以下规约根据实际开发经验及参考阿里巴巴java开发手册而成,总体的设计方向如下,具体可根据实际情况做灵活变化。
groupId
GroupID 格式:com.{公司/BU }.业务线 [.子业务线],最多 4 级。
说明: {公司/BU} 例如:alibaba/taobao/tmall/aliexpress 等 BU 一级;子业务线可选。
正例:com.taobao.jstorm 或 com.alibaba.dubbo.register
artifactId
ArtifactID 格式:产品线名-模块名。语义不重复不遗漏,先到中央仓库去查证一下。
正例:dubbo-client / fastjson-api / jstorm-tool
version
这里需要先了解一下版本命名规则:一个典型的版本,一般包含如下 4 个信息:主版本号.次版本号.修订号.版本限定符。
1) 主版本号:产品方向改变,或者大规模 API 不兼容,或者架构不兼容升级。
2) 次版本号:保持相对兼容性,增加主要功能特性,影响范围极小的 API 不兼容修改。
3) 修订号:保持完全兼容性,修复 BUG、新增次要功能特性等。
说明:注意起始版本号必须为:1.0.0,而不是 0.0.1 正式发布的类库必须先去中央仓库进 行查证,使版本号有延续性,正式版本号不允许覆盖升级。如当前版本:1.3.3,那么下一个 合理的版本号:1.3.4 或 1.4.0 或 2.0.0 。版本范围有一个上界和下界,可以方括号 [] 或者圆括号 () 表示。方括号代表上下界的闭区间,圆括号代表上下界的开区间。
例如:“[1.1.6.RELEASE,1.3.0.M1)”代表所有从 1.1.6.RELEASE 到 1.3.0.M1 之间所有的版本(包含 1.1.6.RELEASE ,但不包含 1.3.0.M1 )。
同时,可以使用单一版本号作为版本范围,例如“1.2.0.RELEASE”。单一版本号的版本范围代表“从这个版本以及之后的所有版本”。
如果需要使用“最新的 Release 版本”的概念,可以使用一个字母x代表具体的版本号。
例如: 1.4.x.BUILD-SNAPSHOT 代表 1.4.x 的最新快照版本。
再比如:如果需要表达,从 1.1.0.RELEASE 到 1.3.x 之间的所有版本,可以用[1.1.0.RELEASE,1.3.x.RELEASE]来表达。
4) 版本限定符
另外,版本限定符也是有顺序的(命名不是非得如此,团队内部协调好照此意思即可):
-
BUILD-SNAPSHOT:开发版 开发团队内部使用,不是很稳定为开发构建的快照版本
-
Alpha :内部测试版
-
Beta :测试版
-
GA :稳定版 相比于开发版,基本上可以使用了
-
M(1,2.....) :里程碑版 主要是修复了一些BUG的版本,一个GA后通常有多个里程碑版
-
RC :候选发布版 该阶段的软件类似于最终版的一个发行观察期,基本只修复比较严重的BUG
-
SR :正式发布版
-
RELEASE :最终版本
版本限定符
BUILD-SNAPSHOT:
为开发构建的快照版本
Alpha:
Alpha是内部测试版,一般不向外部发布,会有很多Bug.除非你也是测试人员,否则不建议使用.是希腊字母的第一位,表示最初级的版本,alpha 就是α,beta 就是β ,alpha 版就是比
beta还早的测试版,一般都是内部测试的版本。
Beta:
该版本相对于α版已有了很大的改进,消除了严重的错误,但还是存在着一缺陷,需要经过多次测试来进一步消除。这个阶段的版本会一直加入新的功能。
M:
里程碑版本
RC:(Release Candidate)
Candidate是候选人的意思,用在软件上就是候选版本。Release.Candidate.就是发行候选版本。和Beta版最大的差别在于Beta阶段会一直加入新的功能,但是到了RC版本,几乎
就不会加入新的功能了,而主要着重于除错! RC版本是最终发放给用户的最接近正式版的版本,发行后改正bug就是正式版了,就是正式版之前的最后一个测试版。
GA:(general availability)
比如:Apache Struts 2 GA这是Apache Struts 2首次发行稳定的版本,GA意味着General Availability,也就是官方开始推荐广泛使用了。
RS:
正式发布版
Release:
该版本意味“最终版本”,在前面版本的一系列测试版之后,终归会有一个正式版本,是最终交付用户使用的一个版本。该版本有时也称为标准版。一般情况下,Release不会以单词形式出现在软件封面上,取而代之的是符号(R)。
安全规约
1. 【强制】线上应用不要依赖 SNAPSHOT 版本(安全包除外)。 说明:不依赖 SNAPSHOT 版本是保证应用发布的幂等性。另外,也可以加快编译时的打包构建。
2. 【强制】二方库的新增或升级,保持除功能点之外的其它 jar 包仲裁结果不变。如果有改变, 必须明确评估和验证,建议进行 dependency:resolve 前后信息比对,如果仲裁结果完全不一 致,那么通过 dependency:tree 命令,找出差异点,进行<excludes>排除 jar 包。
3. 【强制】二方库里可以定义枚举类型,参数可以使用枚举类型,但是接口返回值不允许使用枚 举类型或者包含枚举类型的 POJO 对象。
4. 【强制】依赖于一个二方库群时,必须定义一个统一的版本变量,避免版本号不一致。 说明:依赖 springframework-core,-context,-beans,它们都是同一个版本,可以定义一 个变量来保存版本:${spring.version},定义依赖的时候,引用该版本。
5. 【强制】禁止在子项目的 pom 依赖中出现相同的 GroupId,相同的 ArtifactId,但是不同的 Version。 说明:在本地调试时会使用各子项目指定的版本号,但是合并成一个 war,只能有一个版本号 出现在最后的 lib 目录中。可能出现线下调试是正确的,发布到线上却出故障的问题。
6. 【推荐】所有 pom 文件中的依赖声明放在<dependencies>语句块中,所有版本仲裁放在 <dependencyManagement>语句块中。 说明:<dependencyManagement>里只是声明版本,并不实现引入,因此子项目需要显式的声 明依赖,version 和 scope 都读取自父 pom。而<dependencies>所有声明在主 pom 的 <dependencies>里的依赖都会自动引入,并默认被所有的子项目继承。
7. 【推荐】二方库不要有配置项,最低限度不要再增加配置项。
8. 【参考】为避免应用二方库的依赖冲突问题,二方库发布者应当遵循以下原则: 1)精简可控原则。移除一切不必要的 API 和依赖,只包含 Service API、必要的领域模型对 象、Utils 类、常量、枚举等。如果依赖其它二方库,尽量是 provided 引入,让二方库使用 者去依赖具体版本号;无 log 具体实现,只依赖日志框架。 2)稳定可追溯原则。每个版本的变化应该被记录,二方库由谁维护,源码在哪里,都需要能 方便查到。除非用户主动升级版本,否则公共二方库的行为不应该发生变化
- 一方库: 本工程内部子项目模块依赖的库(jar 包)
- 二方库: 公司内部发布到中央仓库,可供公司内部其它应用依赖的库(jar 包)
- 三方库: 公司之外的开源库(jar 包)