ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

关于开发规范约束

2022-09-11 21:33:19  阅读:226  来源: 互联网

标签:API 依赖 pom 版本号 规范 约束 开发 版本 二方


MAVEN 规约

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

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

      正例:com.joymef.platform 或 com.joymef.social.blog

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

    正例:user-service / user-client / blog-service ) Version:详细规定参考下方。

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

    • 主版本号:当做了不兼容的 API 修改,或者底层依赖框架变更,或者增加了能改变产品方向的新功能。
    • 次版本号:当做了向下兼容的功能性新增(新增类、接口等)。
    • 修订号:修复 bug,没有修改方法签名的功能加强,保持 API 兼容性。

    说明:起始版本号必须为:1.0.0,而不是 0.0.1

  3. 【强制】开发阶段版本号定义为SNAPSHOT,发布后版本改为RELEASE。

  4. 【强制】线上应用不要依赖 SNAPSHOT 版本(安全包除外);正式发布的类库必须先去中央仓库进行查证,使 RELEASE 版本号有延续性,版本号不允许覆盖升级。

    说明:不依赖 SNAPSHOT 版本是保证应用发布的幂等性。另外,也可以加快编译时的打包构建。

    当前版本:1.3.3,那么下一个合理的版本号:1.3.4或1.4.0或2.0.0

  5. 【强制】依赖于一个第三方库群时,必须定义一个统一的版本变量,避免版本号不一致。

    说明:依赖 springframework-core,-context,-beans,它们都是同一个版本,可以定义一个变量来保存版本:${spring.version},定义依赖的时候,引用该版本。

  6. 【强制】禁止在子项目的 pom 依赖中出现相同的 GroupId,相同的 ArtifactId,但是不同的 Version。

  7. 【推荐】所有 pom 文件中的依赖声明放在 语句块中,所有版本仲裁放在 语句块中。

    说明: 里只是声明版本,并不实现引入,因此子项目需要显式的声明依赖,

    version 和 scope 都读取自父 pom。而在 中所有声明在主 pom 的 里的依赖都会自动引入,并默认被所有的子项目继承。

  8. 【参考】为避免应用二方库的依赖冲突问题,二方库发布者应当遵循以下原则:

    • 精简可控原则。移除一切不必要的 API 和依赖,只包含 Service API、必要的领域模型对象、Utils 类、常量、枚举等。

    如果依赖其它二方库,尽量是 provided 引入,让二方库使用者去依赖具体版本号;无 log 具体实现,只依赖日志框架。

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

更多内容:

标签:API,依赖,pom,版本号,规范,约束,开发,版本,二方
来源: https://www.cnblogs.com/duolaa/p/16684873.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有