Maven 插件详解

什么是 Maven 插件

Maven 插件是一组预打包的 Maven 扩展，提供了用于构建和管理项目的功能。每个插件由一个或多个目标组成，这些目标代表可执行的任务。

常见的 Maven 插件

maven-compiler-plugin

该插件用于编译 Java 源代码。它绑定的生命周期阶段包括 compile 编译主源代码和 testCompile 编译测试源代码。

示例配置

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.8.1</version>
            <configuration>
                <source>${java.version}</source>
                <target>${java.version}</target>
                <encoding>UTF-8</encoding>
            </configuration>
        </plugin>
    </plugins>
</build>

说明
在上述配置中，我使用 ${java.version} 属性来设置编译版本，这样可以统一管理 Java 版本。通过在 properties 中定义 java.version 属性，可以方便地更改整个项目的 Java 版本。此外，设置文件编码为 UTF-8 有助于避免编码相关的问题。

maven-surefire-plugin

用于执行单元测试。它绑定的生命周期阶段是 test，用于运行单元测试并生成报告。

示例配置

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>2.22.2</version>
            <configuration>
                <includes>
                    <include>**/*Test.java</include>
                </includes>
                <testFailureIgnore>false</testFailureIgnore>
                <skipTests>false</skipTests>
                <argLine>-Dfile.encoding=UTF-8</argLine>
            </configuration>
        </plugin>
    </plugins>
</build>

说明
此配置指定了单元测试的命名模式为 **/*Test.java，并设置在测试失败时不忽略失败。确保构建在测试失败时中断。此外，通过 argLine 设置文件编码为 UTF-8，避免编码问题影响测试执行。

maven-jar-plugin

用于构建 JAR 文件。它绑定的生命周期阶段是 package，将编译后的代码打包为 JAR 文件。

示例配置

<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.Main</mainClass>
                    </manifest>
                </archive>
            </configuration>
        </plugin>
    </plugins>
</build>

说明
在这个配置中，我指定了主类 com.example.Main，这样生成的 JAR 文件可以直接运行。同时，addClasspath 设置为 true 以在清单文件中添加类路径信息，确保依赖项能够正确加载。

maven-war-plugin

用于构建 WAR 文件，通常应用于 Java Web 应用程序。它绑定的生命周期阶段是 package，将项目打包为 WAR 文件。

示例配置

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-war-plugin</artifactId>
            <version>3.3.1</version>
            <configuration>
                <warName>my-webapp</warName>
                <failOnMissingWebXml>false</failOnMissingWebXml>
            </configuration>
        </plugin>
    </plugins>
</build>

说明
这里，我将生成的 WAR 文件命名为 my-webapp.war，并配置 failOnMissingWebXml 为 false，适用于使用 Servlet 3.0 及以上版本且无需 web.xml 的项目。这种配置简化了部署过程，减少了配置文件的依赖。

maven-install-plugin

将项目的构建输出如 JAR 或 WAR 文件安装到本地 Maven 仓库，以便其他项目使用。绑定的生命周期阶段是 install。

示例配置

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-install-plugin</artifactId>
            <version>2.5.2</version>
            <executions>
                <execution>
                    <id>install-artifacts</id>
                    <phase>install</phase>
                    <goals>
                        <goal>install</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

说明
此配置确保在 install 阶段执行 install 目标，将构建产物安装到本地仓库。通常不需要额外配置，除非需要自定义安装行为，例如指定不同的仓库位置或添加额外的构件。

maven-deploy-plugin

将构建输出部署到远程 Maven 仓库，通常用于与其他开发者共享或发布构建产物。绑定的生命周期阶段是 deploy。

示例配置

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-deploy-plugin</artifactId>
            <version>3.0.0-M1</version>
            <configuration>
                <repositoryId>release-repo</repositoryId>
                <url>https://repo.example.com/releases</url>
            </configuration>
        </plugin>
    </plugins>
</build>

说明
在此配置中，我指定了远程仓库的 repositoryId 和 url，确保构建产物被正确部署到指定的远程仓库。需要在 settings.xml 中配置相应的凭据以进行身份验证，确保部署过程的安全性和可靠性。

maven-clean-plugin

用于清理构建产物，如 target 目录。绑定的生命周期阶段是 clean。

示例配置

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-clean-plugin</artifactId>
            <version>3.1.0</version>
            <configuration>
                <filesets>
                    <fileset>
                        <directory>${project.basedir}/custom-directory</directory>
                        <includes>
                            <include>**/*</include>
                        </includes>
                    </fileset>
                </filesets>
            </configuration>
        </plugin>
    </plugins>
</build>

说明
此配置不仅清理默认的 target 目录，还包括自定义目录 custom-directory 中的所有文件，确保构建环境的全面清理。全面的清理有助于避免旧文件对新构建的影响，提高构建的稳定性。

maven-site-plugin

生成项目文档和报告，如 Javadoc、代码覆盖率等。绑定的生命周期阶段包括 site 生成站点文档和 site:deploy 部署站点文档到服务器。

示例配置

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-site-plugin</artifactId>
            <version>3.9.1</version>
            <configuration>
                <outputDirectory>${project.build.directory}/site</outputDirectory>
            </configuration>
        </plugin>
    </plugins>
</build>

说明
在此配置中，我指定了生成的站点文档输出目录为 target/site。通过运行 mvn site 命令，可以生成项目的详细文档和报告，帮助团队成员和利益相关者更好地理解项目的状态和结构。

maven-failsafe-plugin

执行集成测试。绑定的生命周期阶段包括 integration-test 和 verify。

示例配置

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-failsafe-plugin</artifactId>
            <version>2.22.2</version>
            <executions>
                <execution>
                    <goals>
                        <goal>integration-test</goal>
                        <goal>verify</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <includes>
                    <include>**/*IT.java</include>
                </includes>
            </configuration>
        </plugin>
    </plugins>
</build>

说明
此配置指定了集成测试的命名模式为 **/*IT.java，并在 integration-test 和 verify 阶段执行相应目标，确保集成测试的正确执行和结果验证。集成测试有助于验证系统各部分的协作，提升应用的整体质量。

插件的工作方式

插件通常绑定到生命周期的某个阶段。当该阶段被执行时，绑定的插件目标也会被执行。例如，maven-compiler-plugin 的 compile 目标默认绑定到 compile 阶段，这意味着当 compile 阶段执行时，它也会执行。

案例说明

假设我运行以下 Maven 命令：

mvn clean install

此命令将依次执行 clean 和 install 生命周期。在 clean 生命周期中，maven-clean-plugin 将删除 target 目录。在 install 生命周期中，多个插件将按绑定的阶段执行，如 maven-compiler-plugin 在 compile 阶段编译代码，maven-surefire-plugin 在 test 阶段运行单元测试，maven-jar-plugin 在 package 阶段打包 JAR 文件，最后 maven-install-plugin 将 JAR 文件安装到本地仓库。整个过程确保了项目的清理、编译、测试和部署的有序进行。

自定义插件配置

在 pom.xml 文件中，我可以为插件提供自定义配置。这允许我改变插件的默认行为。例如，我可以更改 Java 的编译版本或为单元测试指定特定参数。

示例：定义编译插件

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.8.1</version>
            <configuration>
                <source>17</source>
                <target>17</target>
                <encoding>UTF-8</encoding>
                <compilerArgs>
                    <arg>-Xlint:all</arg>
                </compilerArgs>
            </configuration>
        </plugin>
    </plugins>
</build>

说明
在这个配置中，我将 Java 编译版本升级到 17，设置文件编码为 UTF-8，并启用了所有编译警告。通过启用编译警告，可以在编译阶段捕获潜在的问题，提升代码质量。此外，使用统一的 Java 版本有助于保持项目的一致性，减少跨环境的兼容性问题。

创建自定义插件

如果现有插件不能满足我的需求，我可以创建自己的 Maven 插件。这需要更深入的 Maven 和 Java 知识，但它为我提供了强大的自定义和扩展能力。

步骤概述

设置 Maven 插件项目
创建一个新的 Maven 项目，并在 pom.xml 中指定 maven-plugin 的包装类型。

<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example.plugins</groupId>
    <artifactId>my-custom-plugin</artifactId>
    <version>1.0.0</version>
    <packaging>maven-plugin</packaging>
    <dependencies>
        <dependency>
            <groupId>org.apache.maven</groupId>
            <artifactId>maven-plugin-api</artifactId>
            <version>3.6.3</version>
        </dependency>
        <dependency>
            <groupId>org.apache.maven.plugin-tools</groupId>
            <artifactId>maven-plugin-annotations</artifactId>
            <version>3.6.0</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>
</project>

编写插件代码
创建一个 Java 类并使用注解定义插件的目标。

package com.example.plugins;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;

@Mojo(name = "greet", defaultPhase = LifecyclePhase.NONE)
public class GreetingMojo extends AbstractMojo {

    @Parameter(property = "greeting", defaultValue = "Hello, World!")
    private String greeting;

    public void execute() throws MojoExecutionException {
        getLog().info(greeting);
    }
}

构建并安装插件
运行 mvn install 将插件安装到本地 Maven 仓库。

在项目中使用自定义插件

<build>
    <plugins>
        <plugin>
            <groupId>com.example.plugins</groupId>
            <artifactId>my-custom-plugin</artifactId>
            <version>1.0.0</version>
            <executions>
                <execution>
                    <goals>
                        <goal>greet</goal>
                    </goals>
                    <configuration>
                        <greeting>Welcome to my custom plugin!</greeting>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

说明
通过上述步骤，我创建了一个简单的自定义插件 my-custom-plugin，它包含一个 greet 目标，可以在构建过程中输出自定义的问候语。这种插件扩展了 Maven 的功能，使其能够执行特定于项目的任务，提升构建过程的灵活性和自动化水平。

参考链接

• Maven 官方文档
• Maven 插件列表