Maven 是一个强大的项目管理和构建工具,广泛应用于 Java 项目中。作为一款优秀的构建管理工具,Maven 不仅提供了标准化的项目结构和依赖管理,还通过其丰富的插件系统,极大地扩展了其功能和灵活性。无论是代码编译、测试、打包,还是部署、报告生成,Maven 插件都扮演着不可或缺的角色。
本文将深入探讨 Maven 的插件体系,详细介绍各类插件的用途、主要目标和适用的生命周期阶段。内容涵盖了 Maven 官方插件、被淘汰的插件、社区驱动的 MojoHaus 插件、国内外企业开发的非官方插件以及如何自定义插件。希望通过这篇文章,读者能更全面地了解 Maven 插件的使用和选择,为项目构建和管理提供更强有力的支持。
1、Maven 框架本质
Maven 本质上是一个插件框架,其核心并不直接执行具体的构建任务,而是将这些任务交由插件完成。比如,编译源代码的任务由 maven-compiler-plugin
插件完成。具体而言,每个任务对应一个插件目标(goal),每个插件可能包含一个或多个目标。例如,maven-compiler-plugin
插件的 compile
目标用于编译位于 src/main/java/
目录下的主源码,而 testCompile
目标用于编译位于 src/test/java/
目录下的测试源码。
用户可以通过两种方式调用 Maven 插件目标。第一种方式是将插件目标与生命周期阶段(lifecycle phase)绑定,这样用户只需在命令行中输入生命周期阶段即可。例如,Maven 默认将 maven-compiler-plugin
的 compile
目标与 compile
生命周期阶段绑定,因此,执行命令 mvn compile
实际上是先定位到 compile
生命周期阶段,然后根据绑定关系调用 maven-compiler-plugin
的 compile
目标。第二种方式是直接在命令行中指定要执行的插件目标,例如 mvn archetype:generate
,表示调用 maven-archetype-plugin
的 generate
目标,这种带冒号的调用方式与生命周期无关。
了解 Maven 插件的基本概念有助于理解 Maven 的工作机制,但要更高效地使用 Maven,掌握一些常用的插件也非常重要。这不仅能帮助你避免重复发明轮子,还能大大提升构建效率。多年来,Maven 社区积累了大量经验,形成了一个成熟的插件生态圈。Maven 官方提供了两个插件列表。
- 第一个列表的 GroupId 为
org.apache.maven.plugins
,这些插件最为成熟,其地址为 Maven 官方插件列表。 - 第二个列表的 GroupId 为
org.codehaus.mojo
,这些插件虽然没有那么核心,但也非常实用,其地址为 Codehaus Mojo 插件列表。
下面将介绍一些常用的 Maven 插件,这些插件在不同环境下都表现出色,熟练使用它们可以让你的日常构建工作事半功倍。
2、Maven 官方插件
2.1、核心插件
Maven Core plugins(核心插件)是 Maven 自带的一些插件,它们在大多数 Maven 构建中都会被使用,并且不需要在 pom.xml
中显式导入就可以使用。核心插件包括一系列用于编译、测试、打包、安装、部署等构建任务的插件
Maven 官方的核心插件共有 9 种:
maven-clean-plugin
:用于清除项目目录中的垃圾文件和临时文件。主要插件目标clean:clean
适用于clean
生命周期阶段;maven-resources-plugin
:用于处理项目中的资源文件(复制和过滤资源文件)。主要插件目标resources:resources
和resources:testResources
适用于process-resources
和process-test-resources
生命周期阶段;maven-compiler-plugin
:用于编译项目中的源代码。主要插件目标compiler:compile
和compiler:testCompile
适用于compile
和test-compile
生命周期阶段;maven-surefire-plugin
:用于运行项目中的单元测试。主要插件目标surefire:test
适用于test
生命周期阶段;maven-failsafe-plugin
:用于运行集成测试。主要插件目标failsafe:integration-test
和failsafe:verify
适用于integration-test
和verify
生命周期阶段;maven-install-plugin
:用于将项目的包安装到本地仓库。主要插件目标install:install
适用于install
生命周期阶段;maven-deploy-plugin
:用于将项目的包部署到远程仓库。主要插件目标deploy:deploy
适用于deploy
生命周期阶段;maven-site-plugin
:用于生成项目的站点文档。主要插件目标site:site
和site:site-deploy
适用于site
和site-deploy
生命周期阶段;maven-verifier-plugin
:用于运行验证任务。主要插件目标verifier:verify
适用于verify
生命周期阶段。
2.2、打包类型(工具)
Maven 提供了多种打包插件,用于不同类型的项目和构建需求。
以下是常见的 10 种打包类型插件:
maven-ear-plugin
:用于创建企业级应用存档(EAR)文件。主要插件目标ear:ear
适用于package
生命周期阶段;maven-ejb-plugin
:用于创建企业 JavaBeans(EJB)模块。主要插件目标ejb:ejb
适用于package
生命周期阶段;maven-jar-plugin
:用于创建 Java ARchive(JAR)文件。主要插件目标jar:jar
适用于package
生命周期阶段;maven-rar-plugin
:用于创建资源适配器存档(RAR)文件。主要插件目标rar:rar
适用于package
生命周期阶段;maven-war-plugin
:用于创建 Web 应用程序存档(WAR)文件。主要插件目标war:war
适用于package
生命周期阶段;maven-app-client-plugin
:用于创建应用客户端模块(app-client/acr)。主要插件目标app-client:app-client
适用于package
生命周期阶段;maven-shade-plugin
:用于打包项目及其所有依赖项到一个可执行的 JAR 文件中。主要插件目标shade:shade
适用于package
生命周期阶段;maven-source-plugin
:用于打包项目的源代码到一个 JAR 文件中。主要插件目标source:jar
适用于package
生命周期阶段;maven-jlink-plugin
:用于创建定制的 Java 运行时映像(JRE)。主要插件目标jlink:jlink
适用于package
生命周期阶段;maven-jmod-plugin
:用于创建 Java 模块文件(JMOD)。主要插件目标jmod:jmod
适用于package
生命周期阶段。
2.3、报告插件
Maven 提供了多种报告插件,用于生成项目的各种报告。
以下是常见的 12 种报告插件:
maven-changelog-plugin
:用于生成项目的变更日志报告。主要插件目标changelog:changelog
适用于site
生命周期阶段;maven-changes-plugin
:用于生成项目的变更报告和发行说明。主要插件目标changes:changes
和changes:announcement-generate
适用于site
生命周期阶段;maven-checkstyle-plugin
:用于检查 Java 代码是否符合编码规范,并生成报告。主要插件目标checkstyle:checkstyle
适用于verify
生命周期阶段;maven-doap-plugin
:用于生成 DOAP(Description of a Project)报告。主要插件目标doap:generate
适用于site
生命周期阶段;maven-javadoc-plugin
:用于生成 JavaDoc 文档。主要插件目标javadoc:javadoc
和javadoc:test-javadoc
适用于site
生命周期阶段;maven-jepts-plugin
:用于生成项目的 JEPTS(Java Enterprise Project Testing System)报告。主要插件目标jepts:generate
适用于site
生命周期阶段;maven-jxr-plugin
:用于生成源代码交叉引用报告。主要插件目标jxr:jxr
适用于site
生命周期阶段;maven-linkcheck-plugin
:用于检查站点链接是否有效,并生成报告。主要插件目标linkcheck:linkcheck
适用于site
生命周期阶段;maven-pmd-plugin
:用于执行代码质量检查,并生成 PMD 报告。主要插件目标pmd:pmd
和pmd:cpd
适用于verify
生命周期阶段;maven-plugin-report-plugin
:用于生成 Maven 插件的报告。主要插件目标plugin-report:report
适用于site
生命周期阶段;maven-project-info-reports-plugin
:用于生成项目的各种信息报告。主要插件目标project-info-reports:project-info
适用于site
生命周期阶段;maven-surefire-report-plugin
:用于生成单元测试报告。主要插件目标surefire-report:report
和surefire-report:report-only
适用于site
生命周期阶段。
2.4、工具插件
Maven 提供了多种工具插件,用于不同的构建和管理任务。
以下是常见的工具插件:
-
maven-antrun-plugin
:用于在 Maven 构建中执行 Ant 任务。主要插件目标antrun:run
适用于compile
生命周期阶段; -
maven-artifact-plugin
:用于管理和操作构建工件。主要插件目标artifact:resolve
和artifact:resolve-transitively
适用于compile
生命周期阶段; -
maven-archetype-plugin
:用于创建 Maven 项目模板(archetypes)。主要插件目标archetype:generate
适用于generate-sources
生命周期阶段; -
maven-assembly-plugin
:用于创建包含项目及其依赖项的组装包。主要插件目标assembly:single
适用于package
生命周期阶段; -
maven-dependency-plugin
:用于处理项目依赖,包括解析、分析和报告依赖信息。主要插件目标dependency:copy
和dependency:resolve
适用于compile
生命周期阶段; -
maven-enforcer-plugin
:用于执行构建时的规则和策略。主要插件目标enforcer:enforce
适用于validate
生命周期阶段; -
maven-gpg-plugin
:用于对工件进行签名和验证