maven 以及插件重写的一些思考

2024-09-01 00:20
文章标签 maven 思考 重写 插件

本文主要是介绍maven 以及插件重写的一些思考,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

先简单了解一下maven:
https://maven.org.cn/maven-features.html
下面是maven的各个阶段的一些信息,由于已经存在,直接查看GPT的解释:

maven的主要阶段包含 installtestdeploypackage 等。这些阶段属于 Maven 的
default(或 build)生命周期。下面是对这些关键阶段的详细介绍:

1. validate

  • 作用:验证项目是否正确且所有必要的信息是否可用。
  • 用途:确保 POM 文件中的配置正确、必要的参数已经设置等。

2. compile

  • 作用:编译项目的主源代码。
  • 用途:将 src/main/java 目录下的 Java 源文件编译成 .class 文件,并放在 target/classes 目录中。

3. test-compile

  • 作用:编译测试源代码。
  • 用途:将 src/test/java 目录下的测试源文件编译成 .class 文件。

4. test

  • 作用:运行测试代码。
  • 用途:使用测试框架(如 JUnit)运行编译后的测试代码。测试结果会生成在 target/surefire-reports 目录中。
  • 注意:测试阶段只会运行那些标记为测试的代码,并确保代码逻辑符合预期。

5. package

  • 作用:将编译后的代码打包成可分发的格式。
  • 用途:生成如 JAR、WAR 或其他可分发格式的文件。打包后的文件通常位于 target 目录中。

6. verify

  • 作用:运行任何检查,验证包是否有效且符合质量标准。
  • 用途:在 testpackage 之后执行的额外检查,确保生成的包满足要求。

7. install

  • 作用:将生成的包安装到本地 Maven 仓库。
  • 用途:将包(如 JAR 或 WAR)复制到本地仓库,以便其他本地 Maven 项目可以使用该包作为依赖。默认情况下,本地仓库位于用户主目录下的 .m2/repository 目录。

8. deploy

  • 作用:将最终的包复制到远程仓库。
  • 用途:将包发布到远程 Maven 仓库(如 Maven Central 或企业内部的私有仓库),以便其他开发者或项目可以使用这个包。通常在 CI/CD 流程中使用这个阶段来自动化发布过程。

生命周期阶段的顺序和依赖关系

  • 依赖顺序:当你运行 mvn install 时,Maven 会自动执行从 validateinstall 之间的所有阶段。
  • 组合调用:例如,mvn deploy 会执行 validatecompiletestpackageverifyinstalldeploy
    这些阶段。

实际使用示例 假设你在命令行中运行 mvn install,Maven 会按顺序执行以下阶段:

  1. validate:检查项目是否配置正确。
  2. compile:编译主代码。
  3. test-compile:编译测试代码。
  4. test:运行测试。
  5. package:将项目打包成 JAR 或 WAR 文件。
  6. install:将打包文件安装到本地 Maven 仓库。

运行 mvn deploy 会在执行上述阶段后,将包部署到远程仓库。

通过这种方式,Maven 提供了一个统一的构建和发布流程,帮助开发者有效地管理项目的整个生命周期。

我们最近基于自己的项目需要重构maven的打包逻辑,即服用之前的编译等逻辑但是手动修改maven的package插件,使用@Mojo注解将complie好的类进行

Maven plugins can be written in Java or any of a number of scripting
languages. Plugins consists of one or more Mojos, each one being the
implementation for one of the plugin’s goals.
https://maven.apache.org/developers/mojo-api-specification.html

关于@Mojo的一些参数之类的不过多赘述,在互联网上可以找到很多的资料,想记录一些之前没有思考过的知识点:
1.maven在deploy的时候会对子maven也进行deploy然后会对自己进行deploy,在我们之前的实践中,存在这样一种情况,正常情况下,假如存在这样一个maven项目:
parent-project
│ pom.xml

├── module-a
│ └── pom.xml

├── module-b
│ └── pom.xml

└── module-c
└── pom.xml

如果我们正常的执行maven的deploy逻辑,实际上会先对module abc分别进行deploy然后会对parent- project进行一个整体的deploy逻辑,得到四个jar包,但是我们因为一些业务逻辑想要对abc本身打包成一个a.jar 然后对module abc的依赖进行一个整体的打包得到一个dependency.jar,然后对于这两个jar
那怎么实现这个呢?先了解一下assembly.xml
https://maven.apache.org/guides/mini/guide-assemblies.html

assembly.xml 是 Maven Assembly 插件的配置文件,用于定义如何将项目的构件(如 JAR、WAR 文件)和依赖项、资源文件等打包成一个分发包(如 ZIP、TAR.gz 等)。这个文件允许我们自定义打包的内容和结构,以便将整个项目及其依赖项一起分发。
举个例子

<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd"><!-- 定义这个 assembly 的唯一标识符,用于生成的文件名的一部分 --><id>distribution</id><!-- 定义输出的打包格式,这里指定为 ZIP 格式 --><formats><format>zip</format></formats><!-- 是否在生成的包中包含一个顶级目录 --><includeBaseDirectory>true</includeBaseDirectory><!-- 定义文件集,指定要包含在包中的目录和目标路径 --><fileSets><fileSet><!-- 要打包的源文件目录 --><directory>src/main/resources</directory><!-- 在生成的包中的输出路径 --><outputDirectory>/resources</outputDirectory></fileSet></fileSets><!-- 定义依赖项集,指定要包含的依赖项及其在包中的目标路径 --><dependencySets><dependencySet><!-- 依赖项在生成的包中的输出路径 --><outputDirectory>/lib</outputDirectory><!-- 是否解压依赖项 --><unpack>false</unpack><!-- 包含的依赖项的范围,例如 runtime、compile、test 等 --><scope>runtime</scope></dependencySet></dependencySets><!-- 定义单个文件,指定要包含的文件和目标路径 --><files><file><!-- 要打包的单个文件 --><source>README.md</source><!-- 在生成的包中的输出路径 --><outputDirectory>/</outputDirectory></file></files>
</assembly>

根据上面的逻辑,我们可以得到哪些文件会被打包,另外由于我们重写了repackage插件,我们就可以自由的控制打包的jar包的内容

这篇关于maven 以及插件重写的一些思考的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1125416

相关文章

idea maven编译报错Java heap space的解决方法

《ideamaven编译报错Javaheapspace的解决方法》这篇文章主要为大家详细介绍了ideamaven编译报错Javaheapspace的相关解决方法,文中的示例代码讲解详细,感兴趣的... 目录1.增加 Maven 编译的堆内存2. 增加 IntelliJ IDEA 的堆内存3. 优化 Mave

一文教你如何将maven项目转成web项目

《一文教你如何将maven项目转成web项目》在软件开发过程中,有时我们需要将一个普通的Maven项目转换为Web项目,以便能够部署到Web容器中运行,本文将详细介绍如何通过简单的步骤完成这一转换过程... 目录准备工作步骤一:修改​​pom.XML​​1.1 添加​​packaging​​标签1.2 添加

Maven pom.xml文件中build,plugin标签的使用小结

《Mavenpom.xml文件中build,plugin标签的使用小结》本文主要介绍了Mavenpom.xml文件中build,plugin标签的使用小结,文中通过示例代码介绍的非常详细,对大家的学... 目录<build> 标签Plugins插件<build> 标签<build> 标签是 pom.XML

IDEA与JDK、Maven安装配置完整步骤解析

《IDEA与JDK、Maven安装配置完整步骤解析》:本文主要介绍如何安装和配置IDE(IntelliJIDEA),包括IDE的安装步骤、JDK的下载与配置、Maven的安装与配置,以及如何在I... 目录1. IDE安装步骤2.配置操作步骤3. JDK配置下载JDK配置JDK环境变量4. Maven配置下

CentOS系统Maven安装教程分享

《CentOS系统Maven安装教程分享》本文介绍了如何在CentOS系统中安装Maven,并提供了一个简单的实际应用案例,安装Maven需要先安装Java和设置环境变量,Maven可以自动管理项目的... 目录准备工作下载并安装Maven常见问题及解决方法实际应用案例总结Maven是一个流行的项目管理工具

使用maven依赖详解

《使用maven依赖详解》本文主要介绍了Maven的基础知识,包括Maven的简介、仓库类型、常用命令、场景举例、指令总结、依赖范围、settings.xml说明等,同时,还详细讲解了Maven依赖的... 目录1. maven基础1.1 简介1.2 仓库类型1.3 常用命令1.4 场景举例1.5 指令总结

关于rpc长连接与短连接的思考记录

《关于rpc长连接与短连接的思考记录》文章总结了RPC项目中长连接和短连接的处理方式,包括RPC和HTTP的长连接与短连接的区别、TCP的保活机制、客户端与服务器的连接模式及其利弊分析,文章强调了在实... 目录rpc项目中的长连接与短连接的思考什么是rpc项目中的长连接和短连接与tcp和http的长连接短

SpringBoot项目中Maven剔除无用Jar引用的最佳实践

《SpringBoot项目中Maven剔除无用Jar引用的最佳实践》在SpringBoot项目开发中,Maven是最常用的构建工具之一,通过Maven,我们可以轻松地管理项目所需的依赖,而,... 目录1、引言2、Maven 依赖管理的基础概念2.1 什么是 Maven 依赖2.2 Maven 的依赖传递机

关于Maven生命周期相关命令演示

《关于Maven生命周期相关命令演示》Maven的生命周期分为Clean、Default和Site三个主要阶段,每个阶段包含多个关键步骤,如清理、编译、测试、打包等,通过执行相应的Maven命令,可以... 目录1. Maven 生命周期概述1.1 Clean Lifecycle1.2 Default Li

关于Maven中pom.xml文件配置详解

《关于Maven中pom.xml文件配置详解》pom.xml是Maven项目的核心配置文件,它描述了项目的结构、依赖关系、构建配置等信息,通过合理配置pom.xml,可以提高项目的可维护性和构建效率... 目录1. POM文件的基本结构1.1 项目基本信息2. 项目属性2.1 引用属性3. 项目依赖4. 构