『Maven』『最佳实践』——jar包管理

『Maven』『最佳实践』——jar包管理

  • 1、综述
  • 2、版本命名和发布规范
    • 2.1 groupId命名规范
    • 2.2 artifactId命名规范
    • 2.3 version命名规范
      • 2.3.1 主版本
      • 2.3.2 次版本
      • 2.3.3 增量版本
    • 2.4 发布规范
  • 3、项目配置
  • 4、参考文章:

1、综述

  Maven是当下最为主流的项目构建和依赖管理工具,也是JAVA开发人员从业初期必须掌握的工具。在Maven的世界中,任何一个依赖、插件或者项目构建的输出,都可以称为一个构件。构件在Maven世界中的位置通过GAV(groupdId、artifactId、version)来表示。

  在实际的项目开发过程中,程序员经常需要对项目的GAV配置进行变更,使用不当会影响研发的效率和线上服务的稳定性。一般而言各大互联网企业都会制定GAV的使用规范,即最佳实践。这也是本篇要重点归纳整理的内容。


2、版本命名和发布规范

  需要发布出的构件,是以GAV来唯一标识的,GAV的命名要符合规范。

2.1 groupId命名规范

  1. 含义解读:groupId定义了项目所在的组,组通常和该项目所在的公司和组织有关。
  2. 格式规范:
    格式一:域名.项目隶属的组织名(公司名)
    格式二:域名.项目隶属的组织名(公司名).项目名称(部门名)

解释说明:
  groupId一般分为多个段,每个段使用小写字母表示(不要有小写字母之外的其它字符),以.分割。

  • 第一段为域。域又分为org、com、cn等等,其中org为非营利组织,com为商业组织。
  • 第二段为公司名称。
  • 第三段为部门名称。如果一个公司有很多部门或事业部时,可以把groupId写成三段式。
  1. 命名示例:tomcat项目的groupId的值是org.apache。因为tomcat是非营利项目且归属于apache公司。再如com.google.guava 、com.alibaba等都是值得学习的规范命名。

2.2 artifactId命名规范

  1. 含义解读:artifactId用来标识项目的名称,不要带version等无关信息。
  2. 格式规范:使用小写字母准确描述,单词之间可以-进行分割。
  3. 命名示例:apache公司的tomcat项目中,artifactId是tomcat;再如常用构件spring-beans。

2.3 version命名规范

  1. 含义解读:项目当前的版本。
  2. 格式规范:建议jar包版本采用三位数字来标识,即主版本号.次版本号.修订号——major.minor.revison

注意事项:

  • 每位从0依次到 99,尽量不要跳跃,数字不可超过 99。
  • 项目初始版本可以为 0.1.0,也可以为1.0.0,开发人员可灵活处理。比如“1.0.0-SNAPSHOT”,其中SNAPSHOT的意思是”快照”,说明该项目处于开发中,是不稳定的版本。

2.3.1 主版本

  重大版本可以理解为项目设计重构,当做了不兼容的API修改,或者增加了能改变产品方向的新功能。

  • 从0依次到n
  • 当有重大版本更新时,可从n直接调整到n+1
  • 增量版本从n.0.0开始。如Spring版本由 3.2.17 变更为 4.0.0

2.3.2 次版本

  次版本升级主要体现在功能增加或者变化,当做了向下兼容的功能性新增(新增类、接口等)。示例:Spring版本由 4.1.11 变更为 4.2.0。

2.3.3 增量版本

  涉及到bugfix等小变动,没有修改方法签名的功能加强,保持 API 兼容性在此版本递增。示例:Spring版本由 3.1.2 变更为 3.1.3。
『Maven』『最佳实践』——jar包管理_第1张图片

2.4 发布规范

  1. 线下环境发布jar包要使用SNAPSHOT版本(便于修改),线上必须用release版本。 若正式环境中允许依赖snapshot版本。今天依赖某个snapshot版本的第三方库成功构建了,明天再构建时可能就会失败,因为第三方可能已经更新了它的snapshot库。再次构建时,Maven会去远程repository下载snapshot的最新版本,构建的成功性就很难保证了。
  2. SNAPSHOT版本可以由开发分支发布,release版本必须由指定的分支发布(比如master分支)。
  3. release版本不允许覆盖升级。如当前版本:1.1.3,必须升级到下一个合理的版本号:1.1.4 或 1.2.0 或 2.0.0才能发布成功。
  4. 本地仅可install jar包到本地仓库,禁止deploy jar包到远程仓库;远程仓库必须通过公司指定的平台才可以发布。这样的规定能带来很多益处。首先,可避免没有提交的代码被打包到远程仓库;其次,通过平台可以在发布jar包的过程中对代码进行扫描、发布成功后发布通知等,这些功能在本地环境是无法实现的。
  5. 环境隔离。线上私服和线下私服隔离;线下不同的环境对应的私服也要隔离;环境隔离可避免不同环境之间的jar包互相影响,有利于并行开发和并行测试;通常私服之间可能存在代理关系,当对应的私服拉取不到相关依赖时会从代理出进行拉取;代理关系可提升依赖查找的成功率,但也会使开发环境变的复杂;
  6. 发布后维护版本更新历史(ChangeLog或release notes),维护的主要内容有:版本说明、概要,版本的主要Changes,修复的Issues/Bugs,发布时间等。

3、项目配置

略。后续补充
  Maven管理的真实的项目都应该是分模块的,每个模块都对应着一个pom.xml,它们之间通过继承和聚合(也称作多模块,multi-module)相互关联。本篇以多模块的项目结构进行讲解。

使用Maven构建的项目,首先需要在pom.xml文件中写明基本信息,如:

<groupId>com.alibaba.project</groupId>        //组织ID
<artifactId>shopping-cart-center</artifactId> //工程名称
<packaging>pom</packaging>                    //打包方式,如:jar、war、pom等
<version>1.0.0-SNAPSHOT</version>             //版本号

4、参考文章:

  1. maven snapshot和release版本的区别
  2. 关于Maven的使用,这些你都了解了么?
  3. 关于版本号的一些信息

你可能感兴趣的:(Maven笔记,maven,最佳实践,jar包,管理)