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

1、综述

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

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


2、版本命名和发布规范

  需要发布出的构件,是以GAV<groupId, artifactId, version>来唯一标识的,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。
jar包演变流程

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. 关于版本号的一些信息
### 回答1: Maven是一种基于项目对象模型的构建工具,它可以管理项目的构建、依赖和文档。在Maven中,我们可以使用Maven插件将本地包打入jar包。打包时需要在pom.xml文件中配置插件管理。 首先,我们需要将本地的jar包安装到本地Maven仓库中。在命令行中使用Maven的install命令完成安装,例如: ``` mvn install:install-file -Dfile=path/to/local.jar -DgroupId=com.example -DartifactId=my-local-jar -Dversion=1.0 -Dpackaging=jar ``` 参数解释: - -Dfile: 需要安装的本地jar文件 - -DgroupId: 组织ID,通常是公司名称或组织名称,用来唯一标识一个项目组 - -DartifactId: 项目ID,用来标识具体的项目,例如my-local-jar - -Dversion: 版本号,用来标识不同版本的相同项目 - -Dpackaging: 打包方式,这里是以jar包的形式打包 安装完成后,我们可以在本地Maven仓库中找到刚刚安装的jar包。 接下来,在pom.xml文件中配置打包插件。常用的插件有maven-jar-plugin和maven-assembly-plugin。其中,maven-jar-plugin适用于简单的jar包打包,而maven-assembly-plugin可以将依赖的jar包一起打包。 在pom.xml文件的build节点下添加插件管理: ```xml <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jar-plugin</artifactId> <version>3.2.2</version> <configuration> <archive> <manifest> <mainClass>com.example.Main</mainClass> </manifest> </archive> </configuration> </plugin> </plugins> ``` 配置说明: - groupId、artifactId和version定义打包插件的依赖,这里选择了maven-jar-plugin插件的版本3.2.2 - configuration节点下的archive节点定义了打包的配置,这里添加了一个manifest节点,用于设置可执行的Main类 完成配置后,我们可以使用Maven的package命令进行打包,例如: ``` mvn package ``` 打包完成后,我们可以在target目录下找到生成的jar包。该jar包中包含了本地打入的jar包以及其他依赖的jar包。使用java -jar命令即可运行该jar包。 总结起来,本地包打入jar包的过程包括安装本地jar包Maven仓库、配置打包插件和执行打包命令。通过Maven统一管理依赖和打包,可以简化开发过程,方便维护项目。 ### 回答2: Maven是一套管理Java项目的工具,通常用于自动化构建、依赖管理、测试和部署等方面。在某些情况下,我们需要将Maven本地的jar包打入到新的jar包中,以便于在其他项目中使用。 首先,我们需要在本地的Maven仓库中找到需要打入jar包中的依赖,可以通过Maven的命令来查看本地仓库的依赖: ```bash mvn dependency:tree -DoutputFile=dependencies.txt ``` 该命令会输出当前项目的依赖树,并将依赖信息保存到一个名为dependencies.txt的文件中。在文件中,可以找到需要打入jar包中的依赖的坐标信息。 接下来,在项目的pom.xml中添加以下插件配置: ```xml <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jar-plugin</artifactId> <executions> <execution> <id>jar-with-dependencies</id> <phase>package</phase> <goals> <goal>jar</goal> </goals> <configuration> <finalName>new-jar</finalName> <archive> <manifest> <addClasspath>true</addClasspath> <mainClass>com.xxx.App</mainClass> <classpathPrefix>lib/</classpathPrefix> </manifest> </archive> <includes> <include>com/xxx/**</include> </includes> <outputDirectory>${basedir}</outputDirectory> </configuration> </execution> </executions> </plugin> </plugins> </build> ``` 该插件将在打包时将依赖也打入到生成的jar包中,并将依赖包放在lib目录下。其中,finalName属性指定了生成的jar包的名称,mainClass属性指定了主类,includes属性指定了需要打包的类所在的包名。 最后,在命令行中执行以下命令进行打包: ```bash mvn package ``` 该命令将会生成一个包含依赖的新的jar包,可以在target目录下找到。打包完成后,可以将该jar包拷贝到其他项目中使用。 总结来说,Maven本地包打入jar包需要通过查找本地仓库中的依赖,配置maven-jar-plugin插件并执行打包命令来完成。该方法适用于一些特殊需求,如需要将多个依赖打入一个jar包中,或者需要将一些不能通过Maven仓库来获取的依赖打入jar包中等等。 ### 回答3: Maven本地包打入jar包是让我们在使用Maven构建Java项目时将本地的Java工程打包成jar包的过程。本地包是指我们自己编写的Java代码或者将别人提供的Java代码放到本地仓库中的包,以便在自己的项目中引用。 对于Maven来说,打包成jar包是为了便于管理和使用,可以方便的加入到依赖库中进行使用,从而避免了重复的代码,提高了代码的复用性。 下面是Maven本地包打入jar包的步骤: 1. 编写Java代码,将其打包方式设置为jar。 2. 在pom.xml文件中添加本地引用: ``` <dependency> <groupId>com.example</groupId> <artifactId>example</artifactId> <version>1.0-SNAPSHOT</version> <scope>system</scope> <systemPath>${basedir}/lib/example.jar</systemPath> </dependency> ``` 其中,groupId,artifactId和version都是自己定义的,本地jar包的路径需要根据实际情况来进行设置。 3. 运行Maven命令,将本地库中的jar包打入到项目中: ``` mvn install:install-file -DgroupId=com.example -DartifactId=example -Dversion=1.0-SNAPSHOT -Dfile=lib/example.jar -Dpackaging=jar ``` 其中,groupId,artifactId,version和本地jar包的路径需要根据实际情况来进行设置。 4. 运行Maven命令,生成项目的jar包: ``` mvn clean package ``` 执行该命令后,生成的jar包将包含本地的Java代码和引用的本地jar包。 总的来说,Maven本地包打入jar包是一个比较简单的过程,只需要按照上述步骤进行操作即可。对于使用Maven的Java项目而言,引入本地包可以让代码更加简单、方便,也可以提高代码的复用性和可维护性。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值