Maven 插件的使用（一）

news/2025/3/1 22:29:11/

一、Maven 插件初相识

在 Java 项目的开发旅程中，Maven 作为一款强大的项目管理和构建工具，早已成为众多开发者的得力助手。而 Maven 插件，更是 Maven 生态系统中的璀璨明珠，它极大地拓展了 Maven 的功能边界，让项目构建变得更加高效、灵活和自动化。

想象一下，在一个大型 Java 项目中，包含了成百上千个 Java 类，还有各种资源文件、配置文件。如果没有 Maven 插件的帮助，我们可能需要手动去编译每一个 Java 文件，小心翼翼地将编译后的文件进行组织和打包，还要操心依赖库的管理，这无疑是一场繁琐且容易出错的工作。而有了 Maven 插件，我们只需要在项目的pom.xml文件中进行一些简单的配置，然后执行一条简短的命令，Maven 插件就能自动完成编译、测试、打包等一系列复杂的操作，就像一位训练有素的管家，有条不紊地处理着项目构建的各项事务。

Maven 插件的核心价值在于它能够自动化执行各种构建任务。例如，maven - compiler - plugin插件负责将 Java 源代码编译成字节码文件，确保代码能够在 Java 虚拟机上运行；maven - surefire - plugin插件专注于运行单元测试，帮助我们及时发现代码中的问题，保障代码质量；maven - jar - plugin插件则将编译后的类文件和相关资源打包成 JAR 文件，方便项目的分发和部署。这些插件相互协作，形成了一个完整的项目构建流水线，大大提高了开发效率，让开发者能够将更多的精力投入到业务逻辑的实现中。

二、Maven 插件的类型与作用

（一）构建插件

在 Maven 的插件体系中，构建插件是基石般的存在，承担着项目从源代码到可部署制品的关键转换任务。

maven-compiler-plugin：这是 Java 开发者再熟悉不过的插件，主要职责是将 Java 源代码编译成字节码文件。在项目构建过程中，它就像是一位严格的 “质检员”，仔细检查每一行代码是否符合语法规范，然后将合格的代码转化为能在 Java 虚拟机上运行的字节码。例如，在一个 Spring Boot 项目中，maven-compiler-plugin会读取src/main/java目录下的所有 Java 文件，按照指定的 Java 版本（通过source和target参数配置，如<source>1.8</source> <target>1.8</target>指定使用 Java 8 进行编译）进行编译，生成的字节码文件存放在target/classes目录中。通过合理配置maven-compiler-plugin，我们还可以开启一些高级特性，如指定编译时的编码格式（<encoding>UTF-8</encoding>确保代码中的中文字符等特殊字符能正确处理），或者添加自定义的编译参数，满足不同项目的编译需求。

maven-jar-plugin：当项目的源代码成功编译后，maven-jar-plugin便登场了，它负责将编译后的类文件和相关资源文件打包成 JAR 文件。JAR 文件是 Java 项目分发和部署的常见形式，就像一个 “包裹”，将项目运行所需的一切都封装在其中。在一个普通的 Java 类库项目中，maven-jar-plugin会将target/classes目录下的所有类文件以及src/main/resources目录下的资源文件（如配置文件、图片等）收集起来，按照 JAR 文件的规范进行打包。我们可以通过配置来定制 JAR 文件的内容和结构，比如设置<archive>标签下的<manifest>子标签，指定 JAR 文件的主类（<mainClass>com.example.MainClass</mainClass>），这样就可以直接通过java -jar命令来运行这个 JAR 文件；还可以通过<excludes>标签排除一些不需要打包的文件（<exclude>**/*.txt</exclude>表示排除所有的 txt 文件），使 JAR 文件更加精简。

maven-war-plugin：对于 Web 项目而言，maven-war-plugin是不可或缺的。它将 Web 项目的各种资源，包括 Servlet 类、JSP 页面、JavaScript 文件、CSS 文件以及相关的依赖库，打包成 WAR 文件，这个 WAR 文件可以直接部署到 Web 服务器上，如 Tomcat、Jetty 等。在一个典型的 Spring MVC 项目中，maven-war-plugin会把src/main/webapp目录下的所有 Web 资源文件（如index.jsp、web.xml等）和target/classes目录下的编译后的类文件整合在一起，生成一个 WAR 文件。我们可以通过配置<failOnMissingWebXml>参数来决定当缺少web.xml文件时是否报错（<failOnMissingWebXml>false</failOnMissingWebXml>表示不报错，适用于使用 Servlet 3.0 + 的注解方式配置 Web 应用的场景）；还可以通过<warSourceDirectory>参数指定 Web 资源文件的源目录（<warSourceDirectory>src/main/resources/web</warSourceDirectory>将 Web 资源文件的源目录指定为src/main/resources/web），以满足项目的特殊结构需求。

（二）报告插件

报告插件在项目开发中扮演着 “质量分析师” 的角色，为项目的质量评估提供关键的数据支持和可视化展示。

maven-surefire-plugin：虽然它主要用于执行单元测试，但生成的测试报告对项目质量评估意义重大。在项目的开发过程中，单元测试是保证代码质量的第一道防线，而maven-surefire-plugin就是这条防线的 “守护者”。它会自动扫描项目中的测试类（默认扫描src/test/java目录下符合命名模式的类，如**/Test*.java、**/*Test.java等），并执行这些测试类中的测试方法。当测试执行完成后，它会生成详细的测试报告，报告中包含了测试用例的执行情况，如运行的测试用例总数、通过的测试用例数、失败的测试用例数以及错误信息等。例如，在一个电商项目中，有大量的业务逻辑需要通过单元测试来验证，maven-surefire-plugin执行完测试后，生成的报告可以帮助开发人员快速定位到代码中的问题，是业务逻辑错误、依赖注入问题还是其他方面的问题，从而及时进行修复，提高代码的质量和稳定性。而且，通过持续集成工具（如 Jenkins、GitLab CI/CD 等）与maven-surefire-plugin的集成，每次代码提交或合并时都能自动执行测试并生成报告，让项目团队能够实时了解项目的质量状况，及时发现潜在的风险。

三、Maven 插件配置与使用示例

（一）在 pom.xml 中配置插件

在 Maven 项目中，pom.xml文件就像是项目的 “指挥中心”，所有关于项目的依赖、插件配置等信息都在这里进行管理。以maven - compiler - plugin为例，让我们来看看如何在pom.xml中进行插件配置。

 

<build>
 

<plugins>
 

<plugin>
 

<groupId>org.apache.maven.plugins</groupId>
 

<artifactId>maven-compiler-plugin</artifactId>
 

<version>3.8.1</version>
 

<configuration>
 

<source>1.8</source>
 

<target>1.8</target>
 

<encoding>UTF-8</encoding>
 

</configuration>
 

</plugin>
 

</plugins>
 

</build>
 

在上述配置中：
 

  • groupId指定了插件所属的组，org.apache.maven.plugins表示这是 Apache Maven 官方提供的插件组。
 

  • artifactId是插件的唯一标识符，maven-compiler-plugin明确表示这是 Maven 的编译插件。
 

  • version用于指定插件的版本号，这里使用的是3.8.1版本。选择合适的插件版本很重要，不同版本可能会修复一些已知问题、增加新功能或对性能进行优化。
 

  • configuration标签用于配置插件的具体参数。source和target分别指定了编译时使用的 Java 版本，这里都设置为1.8，确保项目代码按照 Java 8 的语法和特性进行编译；encoding设置为UTF-8，保证在编译过程中对中文字符等特殊字符的正确处理，避免出现乱码问题。
 

（二）常用插件的使用示例
 

  1. 编译插件：前面提到的maven - compiler - plugin就是 Maven 的核心编译插件。在实际项目中，除了设置编译版本外，还可以进行更多的配置。比如，当项目中使用了一些 Java 8 的新特性，如 Lambda 表达式、方法引用等，而默认的编译版本可能不支持这些特性时，就需要显式地设置source和target为1.8。如果项目中存在一些自定义的编译参数，也可以在configuration标签中进行添加。例如：
 

 

<build>
 

<plugins>
 

<plugin>
 

<groupId>org.apache.maven.plugins</groupId>
 

<artifactId>maven-compiler-plugin</artifactId>
 

<version>3.8.1</version>
 

<configuration>
 

<source>1.8</source>
 

<target>1.8</target>
 

<encoding>UTF-8</encoding>
 

<compilerArgs>
 

<arg>-Xlint:unchecked</arg>
 

<arg>-Xlint:deprecation</arg>
 

</compilerArgs>
 

</configuration>
 

</plugin>
 

</plugins>
 

</build>
 

这里的compilerArgs标签中添加了两个编译参数，-Xlint:unchecked用于检查未检查的类型转换警告，-Xlint:deprecation用于检查使用了过时方法的警告。通过这些配置，可以让编译过程更加严格，及时发现代码中的潜在问题。
 

当我们在命令行中执行mvn compile命令时，Maven 就会根据pom.xml中的配置，使用maven - compiler - plugin插件对项目源代码进行编译。编译后的字节码文件会存放在target/classes目录下，这个目录下的文件就是项目运行时需要的类文件和相关资源文件。
 

  1. 打包插件：对于普通的 Java 项目，我们通常使用maven - jar - plugin来打包生成 JAR 文件。在pom.xml中的配置示例如下：
 

 

<build>
 

<plugins>
 

<plugin>
 

<groupId>org.apache.maven.plugins</groupId>
 

<artifactId>maven-jar-plugin</artifactId>
 

<version>3.2.0</version>
 

<configuration>
 

<archive>
 

<manifest>
 

<addClasspath>true</addClasspath>
 

<mainClass>com.example.MainClass</mainClass>
 

</manifest>
 

</archive>
 

</configuration>
 

</plugin>
 

</plugins>
 

</build>
 

在这个配置中：
 

  • archive标签用于配置 JAR 文件的归档信息。
 

  • manifest标签用于配置 JAR 文件的清单文件。addClasspath设置为true，表示在清单文件中添加类路径，这样在运行 JAR 文件时，Maven 会自动将依赖的类库路径添加到类路径中；mainClass指定了 JAR 文件的主类，即程序的入口点，当我们使用java -jar命令运行 JAR 文件时，会从这个主类的main方法开始执行。
 

执行mvn package命令后，Maven 会在target目录下生成一个以项目名称和版本号命名的 JAR 文件，例如my - project - 1.0 - SNAPSHOT.jar。
 

对于 Spring Boot 项目，为了生成可执行的 JAR 包，我们需要使用spring - boot - maven - plugin插件。配置如下：
 

 

<build>
 

<plugins>
 

<plugin>
 

<groupId>org.springframework.boot</groupId>
 

<artifactId>spring-boot-maven-plugin</artifactId>
 

<version>2.6.3</version>
 

<configuration>
 

<mainClass>com.example.SpringBootApplication</mainClass>
 

</configuration>
 

<executions>
 

<execution>
 

<goals>
 

<goal>repackage</goal>
 

</goals>
 

</execution>
 

</executions>
 

</plugin>
 

</plugins>
 

</build>
 

这里的mainClass指定了 Spring Boot 应用的主类。executions标签中的execution和goals配置表示在执行mvn package命令时，会执行repackage目标，这个目标会将 Spring Boot 项目打包成一个可执行的 JAR 文件，该 JAR 文件包含了项目的所有依赖以及 Spring Boot 的运行时环境，我们可以直接使用java -jar命令来运行这个 JAR 文件，启动 Spring Boot 应用。
 

  1. 测试插件：maven - surefire - plugin是 Maven 用于运行测试用例的插件。在pom.xml中，通常不需要显式配置就可以使用其默认配置来运行测试。但如果我们需要自定义一些配置，比如指定测试报告的生成目录、设置测试失败时是否继续执行等，可以进行如下配置：
 

 

<build>
 

<plugins>
 

<plugin>
 

<groupId>org.apache.maven.plugins</groupId>
 

<artifactId>maven-surefire-plugin</artifactId>
 

<version>3.0.0 - M5</version>
 

<configuration>
 

<reportsDirectory>${project.build.directory}/surefire-reports</reportsDirectory>
 

<testFailureIgnore>false</testFailureIgnore>
 

</configuration>
 

</plugin>
 

</plugins>
 

</build>
 

在这个配置中：
 

  • reportsDirectory指定了测试报告的生成目录，这里设置为${project.build.directory}/surefire - reports，即target/surefire - reports目录，测试报告将生成在这个目录下。
 

  • testFailureIgnore设置为false，表示当测试用例失败时，Maven 构建会失败，停止后续的构建步骤；如果设置为true，则即使有测试用例失败，Maven 构建也会继续执行。
 

当我们执行mvn test命令时，maven - surefire - plugin会自动扫描src/test/java目录下符合命名模式（如**/Test*.java、**/*Test.java等）的测试类，并执行这些测试类中的测试方法。测试执行完成后，会在指定的reportsDirectory目录下生成测试报告，包括 XML 格式的详细报告（TEST - *.xml）和文本格式的简单报告（*.txt） 。如果我们希望生成 HTML 格式的测试报告，以便更直观地查看测试结果，可以结合maven - surefire - report - plugin插件来实现。配置如下：
 

 

<build>
 

<plugins>
 

<plugin>
 

<groupId>org.apache.maven.plugins</groupId>
 

<artifactId>maven-surefire-report-plugin</artifactId>
 

<version>3.0.0 - M2</version>
 

<executions>
 

<execution>
 

<phase>verify</phase>
 

<goals>
 

<goal>report</goal>
 

</goals>
 

</execution>
 

</executions>
 

</plugin>
 

</plugins>
 

</build>
 

执行mvn clean verify命令后，会在target/site/surefire - report.html生成 HTML 格式的测试报告，通过浏览器打开这个文件，我们可以清晰地看到测试的统计信息、成功和失败的测试用例列表以及详细的错误信息等，方便对测试结果进行分析和问题排查。











http://www.ppmy.cn/news/1575881.html












相关文章










el-table fixed滚动条被遮挡导致滚动条无法拖动









el-table fixed滚动条被遮挡导致滚动条无法拖动




/* 设置默认高度-滚动条高度 */   .el-table__fixed {     height: calc(100% - 16px) !important; } .el-table__fixed:before {     height: 0px; }




阅读更多...

















大模型最新面试题系列：训练篇之分布式训练









大模型最新面试题系列：训练篇之分布式训练




1. 对比数据并行、模型并行、流水线并行的显存占用模型 
核心思想&#xff1a;不同并行策略对显存的优化方向不同。 
数据并行&#xff1a; 显存占用&#xff1a;每个GPU保存完整的模型副本&#xff0c;显存占用模型参数梯度优化器状态。问题&#xff1a;显存占用与GPU数量无关…




阅读更多...

















灵犀互娱游戏测试开发一面面经









灵犀互娱游戏测试开发一面面经




阿里的子公司, 做的是游戏业务, 所以投递的时候把简历上加上了自己的游戏经历.  
面试官大哥也围绕着游戏问了一些问题, 面试体验很好~~ 
1. 介绍一下自己  (巴拉巴拉一顿说) 
2. 看你的简历上有写关于用友的实习, 可以介绍一下那边的业务吗? 还有为什么那边用的c#来写自动化脚…




阅读更多...

















深度学习-11.用于自然语言处理的循环神经网络









深度学习-11.用于自然语言处理的循环神经网络




Deep Learning - Lecture 11 Recurrent Networks for Natural Language Processing 介绍文本表示用数字表示单词词嵌入(word embedding) 机械翻译编码器 - 解码器循环模型&#xff08;Encoder-decoder recurrent models&#xff09;双向循环网络 注意力机制&#xff08;方法&am…




阅读更多...

















在 Spring Boot 中使用异步线程时的 HttpServletRequest 复用问题









在 Spring Boot 中使用异步线程时的 HttpServletRequest 复用问题




在 Spring Boot 中使用异步线程时的 HttpServletRequest 复用问题 一、问题描述&#xff1a;异步线程操作导致请求复用时 Cookie 解析失败1. 场景背景2. 问题根源 二、问题详细分析1. 场景重现2. 问题分析 三、解决方案四、总结 一、问题描述&#xff1a;异步线程操作导致请求复…




阅读更多...

















5分钟学习-什么事前端HTML文件









5分钟学习-什么事前端HTML文件




以下从 HTML 文件的基本概念、结构、常用标签等方面&#xff0c;以新手容易理解的方式进行介绍&#xff0c;并给出示例帮助新手看懂 HTML 文件。 
1. 什么是 HTML 文件 
HTML 即超文本标记语言&#xff08;HyperText Markup Language&#xff09;&#xff0c;它是用于创建网页的…




阅读更多...

















八股打卡（三）









八股打卡（三）




八股打卡三 保证数据库和缓存一致性&#xff08;回顾复习&#xff09;String, StringBuilder, StringBuffer区别接口和抽象类的区别Java常见的异常类Java三大特性继承封装多态 Java多态重写和重载的区别final关键字的作用 和 equals区别Java中的集合类线程不安全的集合类线程安…




阅读更多...

















AI 时代下，操作系统如何进化与重构？









AI 时代下，操作系统如何进化与重构？




AI 时代下&#xff0c;操作系统如何进化与重构&#xff1f; AI时代服务器操作系统技术挑战2024 龙蜥操作系统大会最关注的是哪些议题分享与讨论&#xff1f;对于操作系统未来的发展趋势&#xff0c;有哪些观察和建议 2024 龙蜥操作系统大会&#xff08;OpenAnolis Conference&a…




阅读更多...















 
 
 
 










最新文章







 





















Copyright @ 2022~2023