maven多模块 统一版本管理 的正确姿势 (CI Friendly Versions) - ${revision}

最新推荐文章于 2024-08-18 05:15:00 发布
最新推荐文章于 2024-08-18 05:15:00 发布
阅读量1.8w 收藏 22
点赞数 3
分类专栏： 开发工具 文章标签： maven
本文为博主原创文章，未经博主允许不得转载。如果对你有帮助，请记得点赞支持，谢谢！
本文链接：https://blog.csdn.net/ZYC88888/article/details/112842029
版权

在使用Maven多模块结构工程时，配置版本是一个比较头疼的事。继承版本，依赖版本，自身版本，都需要单独定义，很是麻烦。

 

版本号变更使用mvn versions:set，有时候也可能导致版本号不一致、不便于统一管理：

mvn versions:set

但其实Maven已经提供了这种CI版本的管理方式，下面来介绍具体用法。

从Maven 3.5.0-beta-1版本开始，就可以使用${revision}, ${sha1} 和 ${changelist}作为占位符来替换pom文件了。

注意：Idea下使用${revision}定义Parent版本时会提示错误“Reports that usage of properties in modules parent definition is prohibited”，但并不影响使用，只是Idea不支持这种写法而已。

单模块项目

<project>
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.apache</groupId>
    <artifactId>apache</artifactId>
    <version>18</version>
  </parent>
  <groupId>org.apache.maven.ci</groupId>
  <artifactId>ci-parent</artifactId>
  <name>First CI Friendly</name>
  <version>${revision}</version>
  ...
</project>

这种情况比较简单，只使用了${revision}来替换版本。

每次版本号变更，只需要修改即可

<properties>
    <revision>1.0.0-SNAPSHOT</revision>
  </properties>

还可以用另一种动态添加参数的方式来指定版本

$ mvn -Drevision=1.0.0-SNAPSHOT clean package

-D代表设置环境变量

-D,--define <arg> Define a system property

或者在(父)项目的properties中定义版本：

<project>
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.apache</groupId>
    <artifactId>apache</artifactId>
    <version>18</version>
  </parent>
  <groupId>org.apache.maven.ci</groupId>
  <artifactId>ci-parent</artifactId>
  <name>First CI Friendly</name>
  <version>${revision}</version>
  ...
  <properties>
    <revision>1.0.0-SNAPSHOT</revision>
  </properties>
</project>

多模块项目

现在来看看多模块构建的情况。有一个父项目和一个或多子模块。父pom将如下所示：

<project>
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.apache</groupId>
    <artifactId>apache</artifactId>
    <version>18</version>
  </parent>
  <groupId>org.apache.maven.ci</groupId>
  <artifactId>ci-parent</artifactId>
  <name>First CI Friendly</name>
  <version>${revision}</version>
  ...
  <properties>
    <revision>1.0.0-SNAPSHOT</revision>
  </properties>
  <modules>
    <module>child1</module>
    ..
  </modules>
</project>

子模块配置：

<project>
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.apache.maven.ci</groupId>
    <artifactId>ci-parent</artifactId>
    <version>${revision}</version>
  </parent>
  <groupId>org.apache.maven.ci</groupId>
  <artifactId>ci-child</artifactId>
   ...
</project>

多模块项目中子模块的版本应该使用父工程的版本，单独设置版本的话会导致版本混乱。

依赖

多模块工程结构下，会有很多模块依赖的情况，应该使用${project.version}来定义依赖（同父工程下的依赖）的版本

<project>
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.apache</groupId>
    <artifactId>apache</artifactId>
    <version>18</version>
  </parent>
  <groupId>org.apache.maven.ci</groupId>
  <artifactId>ci-parent</artifactId>
  <name>First CI Friendly</name>
  <version>${revision}</version>
  ...
  <properties>
    <revision>1.0.0-SNAPSHOT</revision>
  </properties>
  <modules>
    <module>child1</module>
    ..
  </modules>
</project>

子工程配置：

<project>
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.apache.maven.ci</groupId>
    <artifactId>ci-parent</artifactId>
    <version>${revision}</version>
  </parent>
  <groupId>org.apache.maven.ci</groupId>
  <artifactId>ci-child</artifactId>
   ...
  <dependencies>
        <dependency>
      <groupId>org.apache.maven.ci</groupId>
      <artifactId>child2</artifactId>
      <version>${project.version}</version>
    </dependency>
  </dependencies>
</project>

定义依赖版本时，使用${revision}会导致构建失败，需要使用${project.version}。

install/deploy

如果使用以上设置来发布，必须使用flatten-maven-plugin

<project>
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.apache</groupId>
    <artifactId>apache</artifactId>
    <version>18</version>
  </parent>
  <groupId>org.apache.maven.ci</groupId>
  <artifactId>ci-parent</artifactId>
  <name>First CI Friendly</name>
  <version>${revision}</version>
  ...
  <properties>
    <revision>1.0.0-SNAPSHOT</revision>
  </properties>

 <build>
  <plugins>
    <plugin>
      <groupId>org.codehaus.mojo</groupId>
      <artifactId>flatten-maven-plugin</artifactId>
      <version>1.1.0</version>
      <configuration>
          是否更新pom文件，此处还有更高级的用法
        <updatePomFile>true</updatePomFile>
        <flattenMode>resolveCiFriendliesOnly</flattenMode>
      </configuration>
      <executions>
        <execution>
          <id>flatten</id>
          <phase>process-resources</phase>
          <goals>
            <goal>flatten</goal>
          </goals>
        </execution>
        <execution>
          <id>flatten.clean</id>
          <phase>clean</phase>
          <goals>
            <goal>clean</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
  </build>
  <modules>
    <module>child1</module>
    ..
  </modules>
</project>

最终执行install/deploy后，会将该模块的pom文件中的${revision}替换为实际的版本。

 

maven:读取程序版本号的三种方案

方案1
在应用项目中，如果应用程序需要获取当前程序的版本号，可以读取”/META-INF/maven/${groupId}/${artifactId}/pom.properties“,获取maven生成的版本信息。 
当然前提用应用程序在运行时得知道自己的groupId和artifactId，否则无法定位路径。

pom.properties内容示例

#Created by Apache Maven .5.0
version=1.0.4-SNAPSHOT
groupId=com.gitee.l0km
artifactId=facelog-service

这种方法很简单，但也有缺点： 
貌似这种方法只能获取maven默认定义${project.version}，无法加入自定义的信息。

方案2
还有一个方案就是直接将版本信息写入MANIFEST.MF。通过java.util.jar.Manifest来读取解析MANIFEST.MF来获取版本号。 
如下增加buildnumber-maven-plugin插件，并给maven-jar-plugin插件指定写入MANIFEST.MF的参数。

  
<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>buildnumber-maven-plugin</artifactId>
    <version>1.2</version>
    <executions>
        <execution>
            <goals>
                <goal>create</goal>
            </goals>
        </execution>
    </executions>
</plugin>
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <version>3.0.2</version>
    <configuration>
        <archive>
            <manifestEntries>
                <!-- 项目版本号 -->
                <Project-Version>${project.version}</Project-Version>
                <!-- buildnumber插件提供的 SCM(git/svn等)版本号 -->
                <Scm-Version>${buildNumber}</Scm-Version>
                <!-- 时间戳 -->
                <Timestamp>${maven.build.timestamp}</Timestamp>
            </manifestEntries>
        </archive>
    </configuration>
</plugin>
 

方案3
前面两种方案，都需要将应用程序打成jar包才能读取版本信息。 
那么程序在开发调试的时候，并没有生成pom.properties,和MANIFEST.MF,也就无法读取版本信息了。 
所以另一种思路就是用 template-maven-plugin插件让maven自动生成一个包含版本信息的代码如Version.java。这样任何时候，程序都能很方便的知道自己的版本号了。

模板
首先需要一个代码模板Version.java，示例如下：

  
package net.gdface.facelog.service;
public final class Version {
    /** project version */
    public static final String VERSION = "${project.version}";
    /** SCM(git) revision */
    public static final String SCM_REVISION= "${buildNumber}";
    /** SCM branch */
    public static final String SCM_BRANCH = "${scmBranch}";
    /** build timestamp */
    public static final String TIMESTAMP ="${buildtimestamp}";
}

模板放在/src/main/java/java-templates/${package_of_template}/下

原本在模板文件中用maven内置变量${maven.build.timestamp}做时间戳，实际运行并没有被正确替换，不知道原因。所以改为使用buildnumber-maven-plugin插件(goal create-timestamp)生成的时间戳${buildtimestamp}

插件
然后修改pom.xml增加 template-maven-plugin插件和buildnumber-maven-plugin插件

  
<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>buildnumber-maven-plugin</artifactId>
    <version>1.4</version>
    <executions>
        <execution>
            <id>bn1</id>
            <goals>
                <!-- 创建${buildNumber} -->
                <goal>create</goal>
            </goals>
        </execution>
        <execution>
            <id>bn2</id>
            <goals>
                <!-- 创建时间戳${buildtimestamp} -->
                <goal>create-timestamp</goal>
            </goals>
            <configuration>
                <!-- 指定时间戳变量名 -->
                <timestampPropertyName>buildtimestamp</timestampPropertyName>
                <!-- 指定日期格式 -->
                <timestampFormat>yyyy-MM-dd HH:mm:ss</timestampFormat>
            </configuration>
        </execution>
    </executions>
</plugin>
<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>templating-maven-plugin</artifactId>
    <version>1.0.0</version>
    <executions>
        <execution>
            <id>filter-src</id>
            <goals>
                <goal>filter-sources</goal>
            </goals>
        </execution>
    </executions>
</plugin>

template-maven-plugin插件会将/src/main/java/java-templates/文件夹下的所有模板中的${xxx}占位符都用maven中同名的变量替换一遍， 
生成的Version.java在${project.build.directory}/generated-sources/${package_of_template}下，并且该文件夹会自动成为源码文件夹加入编译过程。

参考

https://maven.apache.org/maven-ci-friendly.html
https://github.com/spring-projects/spring-boot
https://www.mojohaus.org/flatten-maven-plugin/

ZhaoYingChao88
关注
专栏目录
使用versions-maven-plugin优雅的管理maven项目版本号
hanxue6898的博客
02-04 5298
versions-maven-plugin 使用 一. 修改本工程的版本号 更新本工程的版本号： 相关命令: mvn versions:set 用法: mvn versions:set -DnewVersion=xxx -DprocessAllModules -DgenerateBackupPoms=true -DprocessAllModules参数代表要同时修改所有模块的版本号 generateBackupPoms=true表示生成备份pom,如果不需要可以设置false,默认为true
【工具篇】Maven使用${revision}实现多模块版本统一管理
光阴迷客的知识库
06-13 1万+
Maven多模块结构下实现版本统一管理的正确姿势
Maven版本管理：掌控项目进化的艺术
最新发布
xycxycooo的博客
08-18 696
Maven版本管理是指在项目开发过程中，对项目版本进行有序、规范的管理。版本号不仅代表了项目的不同阶段，还反映了项目的稳定性和功能特性。通过版本管理，开发者可以清晰地了解每个版本的变更内容，从而更好地进行项目维护和升级。Maven版本管理是项目进化的关键，它不仅确保了项目的稳定性和可维护性，还让团队成员清晰地了解项目的演进历程。通过合理利用Maven版本管理，你可以构建出结构清晰、易于维护的项目。掌握Maven版本管理的原理和使用方法，将使你在面对复杂项目时更加从容不迫。
Mac 版maven
10-23
直接解压就好了 在全局配置一下就能用 直接解压就好了 在全局配置一下就能用
maven:读取程序版本号的三种方案
10km的专栏
01-09 2万+
方案1 在应用项目中，如果应用程序需要获取当前程序的版本号，可以读取”/META-INF/maven/${groupId}/${artifactId}/pom.properties“,获取maven生成的版本信息。 当然前提用应用程序在运行时得知道自己的groupId和artifactId，否则无法定位路径。 pom.properties内容示例 #Created by Apache
安装maven及查看maven版本号
m0_54849806的博客
08-28 1万+
在conf文件夹下的settings.xml是maven默认的配置，一般会修改maven的默认配置文件。此电脑–>属性–>环境变量–>Path，然后新建，把maven的安装目录配置进去即可。2.2、把maven中央库的地址改为国内阿里云的，下载jar包时会比较快。2.1、修改本地仓库的存放位置。...
查看自己maven安装版本，
weixin_69218754的博客
02-13 4808
查看自己maven安装版本，
查看 maven 版本号
这里是菠萝味菠萝啤的博客
09-07 790
查看maven的是否安装成功以及版本号 mvn -v
Maven多模块及version修改的实现方法
08-25
但是，在使用Maven进行多模块项目开发时，如何正确地管理模块之间的依赖关系和版本号更新变得非常重要。在这篇文章中，我们将介绍Maven多模块及version修改的实现方法。 一、Maven多模块项目的结构 在Maven项目中...
maven多模块项目（简单实例）
09-26
本实例将详细介绍如何创建和管理一个简单的Maven多模块项目。 首先，我们要理解Maven的模块关系。在Maven中，多模块项目是由一个父模块（Parent Module）和若干子模块（Child Modules）组成。父模块主要负责定义...
IDEA如何配置Maven及版本统一管理
星晚的博客
01-11 2万+
1.Maven安装 前往官网下载:https://maven.apache.org/download.cgi 将文件解压自行存放,并在刚刚下载的maven存放目录下新建文件夹: maven-repository ,用来存放本地jar包 2.Maven配置 在maven的安装目录下 :找到conf/settings.xml文件(没有打开软件,可用记事本打开)找到 <localRepository>/path/to/local/repo</localRepository> local
maven多模块踩坑-公共模块找不到等问题
weixin_44079262的博客
07-07 3838
记得刚入职时，作为初入职场的小白，git导入项目后，发现这些东西，以为是微服务，然后我在公用模块加入自己的实体类后，启动我的service，居然显示没有这个实体类，同事告诉我，要去clean install一下，当时就一点不懂，后来看书系统性地学习了下maven，才知道这叫多模块，而且，还并不多复杂。 很多新人打眼一看，这么多工程包(module)，就说这是微服务，其实不是的，他只是maven多模块。第一步: 新建parent工程，在里面加多个module子工程。 第二步: 修改父子的pom， 子pom中
Maven 版本查看
热门推荐
丛林雪狼code的博客
03-19 8万+
工作中，我们经常要操作maven 以及 配置maven ，有时还需要向maven 中手动添加jar 包；那么如何查看maven 的版本呢？第一种方法：就是从你安装maven 插件的目录文件夹中可以看出；第二种方法：直接使用黑窗口命令查看：但是前提是 maven home 环境变量必须配置好否则无法查看；输入命令  mvn -version 那，如何配置 maven 的环境变量呢？计算机 -- 右键...
Maven 查看版本号
程序员写的技术 FAQ 和杂文
11-20 4554
eclipse => Windows => Preferences =》 Maven => Installations 就可以看到了。
maven使用${revision}
qi_liufan的博客
03-26 921
3. 在 Maven 的 settings.xml 文件中定义：可以在 Maven 的全局设置文件 `settings.xml` 中定义属性，这样所有的 Maven 项目都可以使用这个属性。2. 在父 `pom.xml` 文件中定义：如果需要在多个子模块中共享，可以定义在父 `pom.xml` 文件中的 `` 元素中。1. 在单个模块的 `pom.xml` 文件中定义：如果 ${revision}只会在特定模块中使用，可以定义在该模块的 `pom.xml` 文件中。
查看maven版本_[Maven]-Maven基础-02-Maven入门程序
weixin_39752215的博客
11-21 320
Maven基础Maven入门程序第一个Maven项目Hello<1>新建Maven项目a.新建Maven项目b.选择Maven骨架c.查看建立完成的目录结构和指定库文件的变化第一次加载Maven项目需要等待一段时间，等待相关内容加载完成再进行操作（如果长时间无反应，右键工程properties选择maven-->update project更新maven工程，等待完成即可）Mav...
Maven使用${revision}实现多模块版本统一管理及注意事项
艾利克斯冰的博客
06-07 1639
在 Maven 中，确实可以利用来实现多模块项目的版本统一管理，尤其是在使用一些高级特性如 Maven Release Plugin 或者是在 CI/CD 流程中动态设置版本时。是一个特殊的变量，它允许你在构建时动态地使用或设定项目的版本号，这对于自动化的版本管理和持续集成特别有用。
如何查看电脑上面的maven版本?
qq_2105837402的博客
12-05 1万+
cmd查看maven版本小技巧 ① 键盘按下 windows + Q ② 输入 cmd ③ 右击 cmd 以管理员身份运行 ④ 输入 mvn -v 或者 mvn -version
maven使用${revision}管理多模块版本
weixin_37672801的博客
05-17 5098
在maven多模块项目中，可配合插件flatten-maven-plugin及${revision}属性进行全局版本号管理。 pom.xml配置 配置flatten-maven-plugin插件 <build> <plugins> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>flatte
java 项目多版本管理,Maven 多模块项目的版本管理
06-02
Java项目的版本管理对于大型项目开发是非常重要的，Maven多模块项目的版本管理可以通过以下几个方面来实现： 1. 为每个模块定义版本号：在每个模块的pom.xml文件中定义版本号，可以通过${project.version}来引用该版本号。 2. 确定主版本号和次版本号：主版本号和次版本号可以用于确定项目的不同版本，主版本号一般表示项目的大规模更新，次版本号则表示小规模更新。 3. 使用SNAPSHOT版本：当项目处于开发阶段时，可以使用SNAPSHOT版本，这种版本号表示该版本是不稳定的，可能存在错误或者未完成的功能。 4. 使用发布版本：当项目稳定后，可以使用发布版本，这种版本号表示该版本是稳定的，可以供用户使用。 5. 使用版本控制工具：使用版本控制工具来管理项目的版本，例如Git或者SVN，可以方便地管理不同版本的代码。 总之，Java项目的版本管理需要仔细考虑，同时也需要根据实际情况进行灵活调整。Maven多模块项目的版本管理可以通过以上几个方面来实现。
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

ZhaoYingChao88

整理不易，还请多多支持，谢谢

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值