文章目录二方库依赖二方库定义规范交易二方库使用规范二方库发版流程SAPISDK二方库依赖什么是二方库几方库的定义概念如下一方库本工程内部子项目模块依赖的库(jar 包)。二方库公司内部发布到中央仓库可供公司内部其它应用依赖的库(jar 包)。交易内二方库分成两部分sdk和sapi前者是以组件形式对外提供能力后者是业务服务对外提供接口和实体三方库公司之外的开源库(jar 包)所谓二方库依赖就是规范我们如何定义GAV(GroupId、ArtifactId、Version)也就是Maven坐标是用来唯一标识jar包依赖的使用规范二方库定义规范1 【强制】定义GAV遵从以下规则:(1)GroupID 格式:com.{公司/BU }.业务线 [.子业务线]最多 4 级。交易统一使用com.bosssoft.gpmscloud(2)ArtifactID 格式:产品线名-模块名。语义不重复不遗漏先到中央仓库去查证一下例如gpmscloud-platform-api / basic-platform-2nd-api / basic-platform-common(3)Verson格式:sapi的Verson初始版本保持和业务版本一致我们通过最后一位来区分主版本号.次版本号.修订号主版本号: 产品方向改变或者大规模 API 不兼容或者架构不兼容升级。次版本号: 保持相对兼容性增加主要功能特性影响范围极小的 API 不兼容修改。修订号: 保持完全兼容性修复 BUG、新增次要功能特性等。sdk的Verson版本等于对应业务版本的前3位pssapi版本6.3.500.100-1.0.1-RELEASE对应分支branch/testing/V6.3.500.100对应标签6.3.500.100-1.0.1-RELEASE 基础框架版本6.3.500-1.0.1-RELEASE对应分支branch/testing/V6.3.500对应标签6.3.500-1.0.1-RELEASE2 【强制】线上应用不要依赖SNAPSHOT版本(安全包除外)正式发布的类库必须先去中央仓 库进行查证使 RELEASE 版本号有延续性且版本号不允许覆盖升级。说明不依赖 SNAPSHOT 版本是保证应用发布的幂等性。另外也可以加快编译时的打包构建。交易在gpxtest、pretest、dev等环境可以使用下个版本的SNAPSHOT进行联调ps目前测试环境是6.3.300.100版本使用6.3.400.100-SNAPSHOT提测流程应当使用RELEASE仓库ps6.3.300.100-RELEASE3【强制】二方库除非主版本号调整不允许删除或者修改实体二方库的新增或升级保持除功能点之外的其它 jar 包仲裁结果不变。如果有改变必须明确评估和验证。说明在升级时进行 dependency:resolve 前后信息比对如果仲裁结果完全不一致那么通过 dependency:tree 命令找出差异点进行排除 jar 包。4 【强制】二方库里可以定义枚举类型参数可以使用枚举类型但是接口返回值不允许使用枚举类型或者包含枚举类型的 POJO 对象。why枚举适合“内部代码强约束”不适合“外部协议长期演进”。接口返回枚举会把“服务端可演进”变成“客户端必须同步升级”新增一个枚举值都可能导致线上反序列化故障所以被禁止。5【强制】二方库迭代业务方需要统一管理二方库的迭代让业务按需升级。如果涉及实体的修改或者删除SPI接口调整feign接口修改或者删除必须在主版本号迭代并且需要服务负责人通知所有依赖服务进行升级调整。任何代码调整必须迭代版本号不允许直接在旧版本修改代码交易二方库使用规范1 【强制】依赖于一个二方库群时必须定义一个统一的版本变量避免版本号不一致。说明例如依赖 gpmscloud-security-starter-oauth-clientgpmscloud-security-starter-data-permit它们都是同一个版本可以定义一个变量来保存版本:${gpmscloud.version}定义依赖的时候引用该版本。2, 【强制】禁止在子项目的pom依赖中出现相同的GroupId相同的ArtifactId但是不同的 Version。说明在本地调试时会使用各子项目指定的版本号但是合并成一个 war只能有一个版本号出现在最后的 lib 目录中。曾经出现过线下调试是正确的发布到线上却出故障的先例。二方库发版流程SAPI比如需要在V6.3.300.100版本开发basic-platform的SAPI我们会新建branch/testing/V6.3.300.100分支对应basic-api的Verson等于6.3.300.100-1.0.1-RELEASE。主版本号发版流程在提测阶段我们需要发布SAPI我们需要构建6.3.300.100-1.0.1-RELEASE标签通过jekins构建并推送私服仓库。引用该版本的服务比如bidcore服务引入的basic-api version修改为6.3.300.100-1.0.1-RELEASE次版本号发版流程在开发V6.3.300.100版本过程中需要往api临时合并新功能比如archive服务依赖该功能此时我们还是直接在branch/testing/V6.3.300.100分支修改代码。basic-api的Verson修改为6.3.300.100-1.1.0-RELEASE构建6.3.300.100-1.1.0-RELEASE标签通过jekins构建并推送私服bidcore服务不需要调整basic-api版本号archive服务引入的basic-api version修改为6.3.300.100-1.1.0-RELEASE修订号发版流程在开发V6.3.300.100版本过程中发现基础版本存在bug需要所有关联服务都修复调整在branch/testing/V6.3.300.100分支修改代码version调整为6.3.300.100-1.1.1-RELEASE通过jekins构建并推送私服bidcore服务和archive服务引入的basic-api version修改为6.3.300.100-1.1.1-RELEASESDK目前是V6.3.400.100版本预计下个版本V6.3.500.100发版功能那我们应该新建branch/testing/V6.3.500分支开发功能每次代码调整都应该构建标签ps6.3.500-1.0.1-RELEASE 团队二方库标准开发规约
文章目录二方库依赖二方库定义规范交易二方库使用规范二方库发版流程SAPISDK二方库依赖什么是二方库几方库的定义概念如下一方库本工程内部子项目模块依赖的库(jar 包)。二方库公司内部发布到中央仓库可供公司内部其它应用依赖的库(jar 包)。交易内二方库分成两部分sdk和sapi前者是以组件形式对外提供能力后者是业务服务对外提供接口和实体三方库公司之外的开源库(jar 包)所谓二方库依赖就是规范我们如何定义GAV(GroupId、ArtifactId、Version)也就是Maven坐标是用来唯一标识jar包依赖的使用规范二方库定义规范1 【强制】定义GAV遵从以下规则:(1)GroupID 格式:com.{公司/BU }.业务线 [.子业务线]最多 4 级。交易统一使用com.bosssoft.gpmscloud(2)ArtifactID 格式:产品线名-模块名。语义不重复不遗漏先到中央仓库去查证一下例如gpmscloud-platform-api / basic-platform-2nd-api / basic-platform-common(3)Verson格式:sapi的Verson初始版本保持和业务版本一致我们通过最后一位来区分主版本号.次版本号.修订号主版本号: 产品方向改变或者大规模 API 不兼容或者架构不兼容升级。次版本号: 保持相对兼容性增加主要功能特性影响范围极小的 API 不兼容修改。修订号: 保持完全兼容性修复 BUG、新增次要功能特性等。sdk的Verson版本等于对应业务版本的前3位pssapi版本6.3.500.100-1.0.1-RELEASE对应分支branch/testing/V6.3.500.100对应标签6.3.500.100-1.0.1-RELEASE 基础框架版本6.3.500-1.0.1-RELEASE对应分支branch/testing/V6.3.500对应标签6.3.500-1.0.1-RELEASE2 【强制】线上应用不要依赖SNAPSHOT版本(安全包除外)正式发布的类库必须先去中央仓 库进行查证使 RELEASE 版本号有延续性且版本号不允许覆盖升级。说明不依赖 SNAPSHOT 版本是保证应用发布的幂等性。另外也可以加快编译时的打包构建。交易在gpxtest、pretest、dev等环境可以使用下个版本的SNAPSHOT进行联调ps目前测试环境是6.3.300.100版本使用6.3.400.100-SNAPSHOT提测流程应当使用RELEASE仓库ps6.3.300.100-RELEASE3【强制】二方库除非主版本号调整不允许删除或者修改实体二方库的新增或升级保持除功能点之外的其它 jar 包仲裁结果不变。如果有改变必须明确评估和验证。说明在升级时进行 dependency:resolve 前后信息比对如果仲裁结果完全不一致那么通过 dependency:tree 命令找出差异点进行排除 jar 包。4 【强制】二方库里可以定义枚举类型参数可以使用枚举类型但是接口返回值不允许使用枚举类型或者包含枚举类型的 POJO 对象。why枚举适合“内部代码强约束”不适合“外部协议长期演进”。接口返回枚举会把“服务端可演进”变成“客户端必须同步升级”新增一个枚举值都可能导致线上反序列化故障所以被禁止。5【强制】二方库迭代业务方需要统一管理二方库的迭代让业务按需升级。如果涉及实体的修改或者删除SPI接口调整feign接口修改或者删除必须在主版本号迭代并且需要服务负责人通知所有依赖服务进行升级调整。任何代码调整必须迭代版本号不允许直接在旧版本修改代码交易二方库使用规范1 【强制】依赖于一个二方库群时必须定义一个统一的版本变量避免版本号不一致。说明例如依赖 gpmscloud-security-starter-oauth-clientgpmscloud-security-starter-data-permit它们都是同一个版本可以定义一个变量来保存版本:${gpmscloud.version}定义依赖的时候引用该版本。2, 【强制】禁止在子项目的pom依赖中出现相同的GroupId相同的ArtifactId但是不同的 Version。说明在本地调试时会使用各子项目指定的版本号但是合并成一个 war只能有一个版本号出现在最后的 lib 目录中。曾经出现过线下调试是正确的发布到线上却出故障的先例。二方库发版流程SAPI比如需要在V6.3.300.100版本开发basic-platform的SAPI我们会新建branch/testing/V6.3.300.100分支对应basic-api的Verson等于6.3.300.100-1.0.1-RELEASE。主版本号发版流程在提测阶段我们需要发布SAPI我们需要构建6.3.300.100-1.0.1-RELEASE标签通过jekins构建并推送私服仓库。引用该版本的服务比如bidcore服务引入的basic-api version修改为6.3.300.100-1.0.1-RELEASE次版本号发版流程在开发V6.3.300.100版本过程中需要往api临时合并新功能比如archive服务依赖该功能此时我们还是直接在branch/testing/V6.3.300.100分支修改代码。basic-api的Verson修改为6.3.300.100-1.1.0-RELEASE构建6.3.300.100-1.1.0-RELEASE标签通过jekins构建并推送私服bidcore服务不需要调整basic-api版本号archive服务引入的basic-api version修改为6.3.300.100-1.1.0-RELEASE修订号发版流程在开发V6.3.300.100版本过程中发现基础版本存在bug需要所有关联服务都修复调整在branch/testing/V6.3.300.100分支修改代码version调整为6.3.300.100-1.1.1-RELEASE通过jekins构建并推送私服bidcore服务和archive服务引入的basic-api version修改为6.3.300.100-1.1.1-RELEASESDK目前是V6.3.400.100版本预计下个版本V6.3.500.100发版功能那我们应该新建branch/testing/V6.3.500分支开发功能每次代码调整都应该构建标签ps6.3.500-1.0.1-RELEASE