脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → Maven 版本管理与 flatten-maven-plugin 插件

Maven 版本管理与 flatten-maven-plugin 插件的使用解析

 更新时间：2023年07月13日 14:58:06   作者：没对象的指针  
这篇文章主要介绍了Maven 版本管理与 flatten-maven-plugin 插件的使用解析,本文通过示例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下

1. flatten-maven-plugin 介绍

1.1 环境

  • IntelliJ IDEA 2021.3
  • JDK 1.8.0_301
  • Apache Maven 3.8.1
  • org.codehaus.mojo：versions-maven-plugin 1.2.7
  • https://www.mojohaus.org/flatten-maven-plugin/

1.2 版本占位符

自 Maven 3.5.0-beta-1 开始，可以使用 ${revision}, ${sha1} and/or ${changelist} 这样的变量作为版本占位符。

像这样：

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

或者像这样：

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

可以使用这样的命令：

mvn -Drevision=2.7.8 -Dchangelist=-RELEASE -Dsha1=ssbd clean package

缺点：

Install / Deploy 时，版本占位符将不能被替换。这将导致 Install / Deploy 后， maven 不能识别。

使用 flatten-maven-plugin 解决这个问题。

flatten-maven-plugin：

<build>
    <plugins>
        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>flatten-maven-plugin</artifactId>
            <version>${flatten-maven-plugin.version}</version>
            <configuration>
                <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>

2. 实例分析

2.1 先看一下自己构建的项目

基于 COLA 4.X 构建一个项目，本人目前正在写支付中台，所以就以此为例构建 “pointer-pay” 项目：

mvn archetype:generate \
    -DgroupId=com.pointer.pay \
    -DartifactId=pointer-pay \
    -Dversion=1.0.0-SNAPSHOT \
    -Dpackage=com.pointer.pay \
    -DarchetypeArtifactId=cola-framework-archetype-web \
    -DarchetypeGroupId=com.alibaba.cola \
    -DarchetypeVersion=4.3.1

然后看一下其初始项目的版本管理方式：

parent：

module：

可以看到这里的父工程和modules都写死了版本。当然，像支付中台或者其他不会变更需求的项目，这个写也没什么毛病。

But，在大多数互联网公司中，几乎每个项目都处在版本快速迭代中，甚至一两周更新一个小版本，一个月更新一个大版本。如果还是这样直接写死版本的话，通常做法就是全局搜索替换版本号，这样就显得很捞，也不太科学。然后就有了revision 的占位符统一管理。

2.2 再看一下开源项目是怎么进行版本管理的

我们可以在 spring-boot 和 spring-cloud-alibaba 的开源项目中看到，其就是利用 revision 占位符来进行统一版本管理的。

https://github.com/spring-projects/spring-boot/blob/2.2.x/pom.xml

https://github.com/alibaba/spring-cloud-alibaba/blob/2021.x/pom.xml

2.3 改造 pointer-pay 先看一下原来的项目结构：

然后利用 revision 占位符来统一管理版本：

父工程pom：

子工程pom：

修改完以后编译运行都没问题。然后 install、deploy 的时候就出现问题了：打出来的jar包的pom文件里还是原来的revision变量，下面一起到maven仓库中查看一下：

可见这里识别不出版本号，也就会导致引用方不能识别你的 pom/jar 包。这时 flatten-maven-plugin 就该出场了，在你的父 pom 引入相关插件：

<build>
    <plugins>
        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>flatten-maven-plugin</artifactId>
            <version>1.2.7</version>
            <configuration>
                <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>

然后重新 clean、install 一下，你会发现每个模块根目录下多了一个 .flattened-pom.xml 文件，那么这个玩意是怎么生成的呢？下面一起看一下 updatePomFile 标签，官方文档是这个描述的：

The flag to indicate if the generated flattened POM shall be set as POM file to the current project. By default this is only done for projects with packaging other than pom. You may want to also do this for pom packages projects by setting this parameter to true or you can use false in order to only generate the flattened POM but never set it as POM file. If flattenMode is set to bom the default value will be true.

大概意思是：updatePomFile 属性表示是否将生成的 .flattened-pom.xml 作为当前项目的 pom 文件。默认只有打包的时候（package、install、deploy）会将 .flattened-pom.xml 做为当前项目的 pom 文件，但是打包类型 pom 的 pom.xml 中的占位符是不会被替换的。如果想要都被替换，那就将 updatePomFile 的属性设置为 true 吧。如果 flattenMode 被设置为 bom，updatePomFile 默认属性值为 true。

再一起看一下引入 flatten-maven-plugin 之后编译过的 pom 文件：

到此这篇关于Maven 版本管理与 flatten-maven-plugin 插件的使用及分析的文章就介绍到这了,更多相关Maven 版本管理与 flatten-maven-plugin 插件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • Java反射机制的精髓讲解

    Java反射机制的精髓讲解

    今天小编就为大家分享一篇关于Java反射机制的讲解，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
    2019-01-01
  • Maven 集成 groovy 脚本插件gmavenplus-plugin详解

    Maven 集成 groovy 脚本插件gmavenplus-plugin详解

    文章介绍了在Maven构建过程中使用Groovy脚本进行动态配置的示例,重点解析了如何在`<build>`配置片段中绑定脚本到`initialize`生命周期阶段,并详细说明了脚本执行流程、常见使用场景以及潜在问题和优化建议,感兴趣的朋友跟随小编一起看看吧
    2025-12-12
  • 解决idea中javaweb的mysql8.0.15配置问题

    解决idea中javaweb的mysql8.0.15配置问题

    这篇文章主要介绍了idea中javaweb的mysql8.0.15配置问题 ，本文通过实例代码给大家介绍的非常详细，具有一定的参考借鉴价值,需要的朋友可以参考下
    2019-05-05
  • Java指纹匹配功能的完整实现代码

    Java指纹匹配功能的完整实现代码

    Java作为一种跨平台的编程语言,也提供了实现指纹识别的可能性,这篇文章主要介绍了Java指纹匹配功能实现的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2025-12-12
  • SpringMVC拦截器快速掌握上篇

    SpringMVC拦截器快速掌握上篇

    拦截器（Interceptor）是一种动态拦截方法调用的机制，在SpringMVC中动态拦截控制器方法的执行。本文将详细讲讲SpringMVC中拦截器的概念及入门案例，感兴趣的可以尝试一下
    2022-08-08
  • Java实现顺序栈原理解析

    Java实现顺序栈原理解析

    这篇文章主要介绍了Java实现顺序栈原理解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-11-11
  • java调用webservice的.asmx接口的使用步骤

    java调用webservice的.asmx接口的使用步骤

    这篇文章主要介绍了java调用webservice的.asmx接口的使用步骤，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-09-09
  • Springboot中使用Redisson+AOP+自定义注解实现访问限流与黑名单拦截

    Springboot中使用Redisson+AOP+自定义注解实现访问限流与黑名单拦截

    本文主要介绍了Springboot中使用Redisson+AOP+自定义注解实现访问限流与黑名单拦截,包含针对用户IP限流,整个接口的访问限流,以及对某个参数字段的限流,并且支持请求限流后处理回调,感兴趣的可以了解一下
    2024-02-02
  • Caffeine中本地缓存的最佳实践与性能优化指南

    Caffeine中本地缓存的最佳实践与性能优化指南

    作为 Java 生态中性能优异的本地缓存实现,Caffeine 提供了更高的吞吐量和更低的延迟,本文将深入剖析 Caffeine 的核心原理、源码实现和实际应用,希望对大家有所帮助
    2025-09-09
  • java 工作流引擎设计实现解析流程定义文件

    java 工作流引擎设计实现解析流程定义文件

    这篇文章主要为大家介绍了java 工作流引擎设计与实现及流程定义文件解析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
    2023-05-05

最新评论