flatten-maven-plugin使用

这篇文章主要介绍了flatten-maven-plugin使用,本文通过示例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

目录

一、简介

1.1 作用

将pom工程父子pom的版本,提出作为变量定义在properties。

这样仅修改变量的值(如在运行mvn命令时指定) 即可实现版本整体切换。

1.2 goal介绍

  • flatten:clean

删除flatten插件生成的 .flattened-pom.xml

配置参数有:

flattenedPomFilename: 插件生成的pom的名字,默认为 .flattened-pom.xml

outputDirectory:插件生成pom的目录,默认为 ${project.basedir}

  • flatten:flatten

resources-process生成 .flattened-pom.xml,并在install/deploy时替换原始pom.xml

主要配置参数有:

flattenedPomFilename: 插件生成的pom的名字,默认为 .flattened-pom.xml

outputDirectory:插件生成pom的目录,默认为 ${project.basedir}

updatePomFile: packing=pom的module也进行reversion变量替换,默认为false

flattenMode:用来定义生成 .flattened-pom.xml所包含的元素,常用值有:

oss:开源软件常用,除了repositories/pluginRepositories外其他所有FlattenDescriptor定义的元素都生成

ossrh:所有FlattenDescriptor定义的元素都生成

bom:在ossrh基础上增加dependencyManagement和properties

defaults:除了repositories其他所有FlattenDescriptor定义的元素都不生成

clean:所有FlattenDescriptor定义的元素都不生成

fatjar:所有FlattenDescriptor定义的元素和dependencies都不生成

resolveCiFriendliesOnly:只替换原始pom中的revision, sha1 and changelist,其他否保持原样

常用oss/ossrh/resolveCiFriendliesOnly

  • FlattenDescriptor定义的pom.xml元素有:

modelVersion

groupId

artifactId

version

packaging

licenses

dependencies

profiles

name

description

url

inceptionYear

organization

scm

developers

contributors

mailingLists

pluginRepositories

issueManagement

ciManagement

distributionManagement

prerequisites

repositories

parent

build

dependencyManagement

properties

modules

reporting

二、使用总结

  • 不用flatten-maven-plugin

1.父pom定义版本为变量reversion并作为version,子pom复引用变量reversion作为version

2.结果能正常运行compile/test, 但install或deploy时父子pom中的version还是reversion变量未被替换

3.没有version别人无法引用你的包

父pom.xml

|-------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | <``project xmlns``=``"http://maven.apache.org/POM/4.0.0" ``xmlns:xsi``=``"http://www.w3.org/2001/XMLSchema-instance" ``xsi:schemaLocation``=``"http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"``> ``<``modelVersion``>4.0.0</``modelVersion``> ``<``packaging``>pom</``packaging``> ``<``version``>${reversion1}</``version``> ``<``modules``> ``<``module``>no-flatten-child</``module``> ``</``modules``> ``<``groupId``>com.wsl.my.maven</``groupId``> ``<``artifactId``>no-flatten-plugin</``artifactId``> ``<``properties``> ``<``maven.compiler.source``>8</``maven.compiler.source``> ``<``maven.compiler.target``>8</``maven.compiler.target``> ``<``reversion1``>1.1.0-SNAPSHOT</``reversion1``> ``</``properties``> </``project``> |

子pom.xml

|-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 1 2 3 4 5 6 7 8 9 10 11 12 13 | <?``xml version``=``"1.0" encoding``=``"UTF-8"``?> <``project xmlns``=``"http://maven.apache.org/POM/4.0.0" ``xmlns:xsi``=``"http://www.w3.org/2001/XMLSchema-instance" ``xsi:schemaLocation``=``"http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"``> ``<``parent``> ``<``artifactId``>no-flatten-plugin</``artifactId``> ``<``groupId``>com.wsl.my.maven</``groupId``> ``<``version``>${reversion1}</``version``> ``<``relativePath``>../pom.xml</``relativePath``> ``</``parent``> ``<``modelVersion``>4.0.0</``modelVersion``> ``<``artifactId``>no-flatten-child</``artifactId``> </``project``> |

install/deploy后父子pom.xml中的${reversion1}没有被替换

  • 使用了flatten-maven-plugin

1.父pom定义版本为变量reversion并作为version,子pom复引用变量reversion作为version

2.使用flatten-maven-plugin并设置updatePomFile=true,并绑定goal到maven周期

3.在process-resources阶段时会在父子project目录下生成.flattened-pom.xml(version已替换为具体值)

4.运行install或deploy时会将.flattened-pom.xml替换原来的pom.xml

原始父pom

|----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 | <``project xmlns``=``"http://maven.apache.org/POM/4.0.0" ``xmlns:xsi``=``"http://www.w3.org/2001/XMLSchema-instance" ``xsi:schemaLocation``=``"http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"``> ``<``modelVersion``>4.0.0</``modelVersion``> ``<``version``>${reversion2}</``version``> ``<``packaging``>pom</``packaging``> ``<``artifactId``>use-flatten-parent</``artifactId``> ``<``groupId``>com.wsl.my.maven</``groupId``> ``<``modules``> ``<``module``>use-flatten-child</``module``> ``</``modules``> ``<``properties``> ``<``maven.compiler.source``>8</``maven.compiler.source``> ``<``maven.compiler.target``>8</``maven.compiler.target``> ``<``reversion2``>1.2.0-SNAPSHOT</``reversion2``> ``</``properties``> ``<``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``> </``project``> |

相关推荐
用户298698530142 小时前
Word 文档字符级格式化:Java 实现方案详解
java·后端
笨鸟飞不快3 小时前
从单个服务到集群:一次完整的性能排查复盘
java·前端
荣码3 小时前
用Streamlit给AI应用套个界面,10行代码出Web页面
java·python
SamDeepThinking3 小时前
Java微服务练习方式
java·后端·微服务
朦胧之13 小时前
AI 编程-老项目改造篇
java·前端·后端
程序猿大帅18 小时前
别再只当调包侠了:用 Spring AI 落地 Function Calling,我被大模型硬生生砸出了三个大坑
java
程序员晓琪19 小时前
约定大于配置:基于 Java 包名自动生成 API 版本路由的最佳实践
java·spring boot·后端
Flittly19 小时前
【AgentScope Java新手村系列】(11)中断与恢复
java·spring boot·spring
众少成多积小致巨19 小时前
JNI (Java Native Interface) 技术手册中文参考指南
android·java·c++
东坡白菜20 小时前
破局全栈:前端开发的Java入门实战记录—JPA(2)
java·后端