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

相关文章

Java 中的 equals 和 hashCode 方法关系与正确重写实践案例

《Java中的equals和hashCode方法关系与正确重写实践案例》在Java中,equals和hashCode方法是Object类的核心方法,广泛用于对象比较和哈希集合(如HashMa... 目录一、背景与需求分析1.1 equals 和 hashCode 的背景1.2 需求分析1.3 技术挑战1.4

RabbitMQ 延时队列插件安装与使用示例详解(基于 Delayed Message Plugin)

《RabbitMQ延时队列插件安装与使用示例详解(基于DelayedMessagePlugin)》本文详解RabbitMQ通过安装rabbitmq_delayed_message_exchan... 目录 一、什么是 RabbitMQ 延时队列? 二、安装前准备✅ RabbitMQ 环境要求 三、安装延时队

Maven中生命周期深度解析与实战指南

《Maven中生命周期深度解析与实战指南》这篇文章主要为大家详细介绍了Maven生命周期实战指南,包含核心概念、阶段详解、SpringBoot特化场景及企业级实践建议,希望对大家有一定的帮助... 目录一、Maven 生命周期哲学二、default生命周期核心阶段详解(高频使用)三、clean生命周期核心阶

Spring Security重写AuthenticationManager实现账号密码登录或者手机号码登录

《SpringSecurity重写AuthenticationManager实现账号密码登录或者手机号码登录》本文主要介绍了SpringSecurity重写AuthenticationManage... 目录一、创建自定义认证提供者CustomAuthenticationProvider二、创建认证业务Us

idea Maven Springboot多模块项目打包时90%的问题及解决方案

《ideaMavenSpringboot多模块项目打包时90%的问题及解决方案》:本文主要介绍ideaMavenSpringboot多模块项目打包时90%的问题及解决方案,具有很好的参考价值,... 目录1. 前言2. 问题3. 解决办法4. jar 包冲突总结1. 前言之所以写这篇文章是因为在使用Mav

Win10安装Maven与环境变量配置过程

《Win10安装Maven与环境变量配置过程》本文介绍Maven的安装与配置方法,涵盖下载、环境变量设置、本地仓库及镜像配置,指导如何在IDEA中正确配置Maven,适用于Java及其他语言项目的构建... 目录Maven 是什么?一、下载二、安装三、配置环境四、验证测试五、配置本地仓库六、配置国内镜像地址

Spring Boot Maven 插件如何构建可执行 JAR 的核心配置

《SpringBootMaven插件如何构建可执行JAR的核心配置》SpringBoot核心Maven插件,用于生成可执行JAR/WAR,内置服务器简化部署,支持热部署、多环境配置及依赖管理... 目录前言一、插件的核心功能与目标1.1 插件的定位1.2 插件的 Goals(目标)1.3 插件定位1.4 核

JAVA覆盖和重写的区别及说明

《JAVA覆盖和重写的区别及说明》非静态方法的覆盖即重写,具有多态性;静态方法无法被覆盖,但可被重写(仅通过类名调用),二者区别在于绑定时机与引用类型关联性... 目录Java覆盖和重写的区别经常听到两种话认真读完上面两份代码JAVA覆盖和重写的区别经常听到两种话1.覆盖=重写。2.静态方法可andro

Spring Boot spring-boot-maven-plugin 参数配置详解(最新推荐)

《SpringBootspring-boot-maven-plugin参数配置详解(最新推荐)》文章介绍了SpringBootMaven插件的5个核心目标(repackage、run、start... 目录一 spring-boot-maven-plugin 插件的5个Goals二 应用场景1 重新打包应用

java使用protobuf-maven-plugin的插件编译proto文件详解

《java使用protobuf-maven-plugin的插件编译proto文件详解》:本文主要介绍java使用protobuf-maven-plugin的插件编译proto文件,具有很好的参考价... 目录protobuf文件作为数据传输和存储的协议主要介绍在Java使用maven编译proto文件的插件