2分钟学会编写maven插件

什么是 Maven 插件

Maven 是 Java 项目中常用的构建工具，可以自动化构建、测试、打包和发布 Java 应用程序。Maven 插件是 Maven 的一项重要功能，它可以在 Maven 构建过程中扩展 Maven 的功能，实现自定义的构建逻辑。

Maven 插件可以提供很多不同的功能，例如：生成代码、打包文件、部署应用程序等。插件通常是在 Maven 构建生命周期中的某个阶段执行，例如：编译、测试、打包、安装和部署。Maven 的生命周期和插件机制让开发人员可以很方便地实现自定义构建逻辑，从而加快项目的开发和部署。

创建 Maven 插件

创建 Maven 项目
首先，我们需要创建一个 Maven 项目。可以使用 Maven 自带的 archetype 创建一个 Maven 项目。在命令行中执行以下命令：

mvn archetype:generate -DgroupId=com.example -DartifactId=my-maven-plugin -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

执行完毕后，会在当前目录下创建一个名为 my-maven-plugin 的 Maven 项目。

编写插件代码
在创建的 Maven 项目中，可以看到 src/main/java 目录下有一个名为 App.java 的类，这是 Maven 自动生成的一个示例类。我们将在这个类的基础上编写插件代码。

首先，我们需要定义一个类，实现 Maven 插件的核心逻辑：

@Mojo(name = "sum")
public class SumMojo extends AbstractMojo {

    /**
     * 第一个整数
     */
    @Parameter(property = "num1", defaultValue = "0")
    private int num1;

    /**
     * 第二个整数
     */
    @Parameter(property = "num2", defaultValue = "0")
    private int num2;

    @Override
    public void execute() throws MojoExecutionException, MojoFailureException {
        int sum = num1 + num2;
        getLog().info("The sum of " + num1 + " and " + num2 + " is " + sum);
    }
}

这个类使用 @Mojo 注解定义了一个 Maven 插件，名称为 sum。它继承了 AbstractMojo 类，实现了 Maven 插件的核心逻辑。在 execute() 方法中，我们实现了计算两个整数的和，并将结果输出到控制台。

在上面的代码中，我们使用了 @Parameter 注解定义了两个插件参数，分别为 num1 和 num2。这两个参数可以在 Maven 命令行中通过 -D 参数指定

打包插件
接下来，我们需要将插件打包成一个 JAR 文件，以便在其他项目中使用。可以使用 Maven 的 maven-jar-plugin 插件来实现打包。

在 Maven 项目的 pom.xml 文件中，添加以下配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <version>3.2.0</version>
            <executions>
                <execution>
                    <goals>
                        <goal>jar</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <archive>
                    <manifest>
                        <addClasspath>true</addClasspath>
                        <mainClass>com.example.App</mainClass>
                    </manifest>
                </archive>
            </configuration>
        </plugin>
    </plugins>
</build>

在这个配置中，我们使用了 maven-jar-plugin 插件，并配置了插件的 manifest，以便在执行插件时自动加载插件的类。mainClass 参数指定了插件的主类。

执行以下命令，将插件打包成 JAR 文件：

mvn package

执行完毕后，会在 Maven 项目的 target 目录下生成一个名为 my-maven-plugin-1.0-SNAPSHOT.jar 的 JAR 文件。

使用插件
在其他 Maven 项目中使用插件，需要在项目的 pom.xml 文件中添加插件的依赖，并配置插件的执行。

在 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>com.example</groupId>
    <artifactId>my-maven-plugin</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

然后，在 build/plugins 标签下添加以下配置：

<plugin>
    <groupId>com.example</groupId>
    <artifactId>my-maven-plugin</artifactId>
    <version>1.0-SNAPSHOT</version>
    <executions>
        <execution>
            <goals>
                <goal>sum</goal>
            </goals>
            <configuration>
                <num1>1</num1>
                <num2>2</num2>
            </configuration>
        </execution>
    </executions>
</plugin>

在这个配置中，我们添加了 my-maven-plugin 插件的依赖，并配置了插件的执行。在 executions 标签下，我们定义了一个 sum 目标，并在其中设置了两个整数参数 num1 和 num2。

现在，我们可以在命令行中执行以下命令，运行 Maven 项目并执行插件：

mvn clean install

执行完毕后，可以看到插件输出了计算结果：

[INFO] --- my-maven-plugin:1.0-SNAPSHOT:sum (default) @ my-project ---
[INFO] The sum of 1 and 2 is 3

总结

本文介绍了如何创建一个 Maven 插件，并在 Maven 项目中使用。我们首先创建了一个 Maven 项目，并在其中添加了插件的代码。然后，我们使用 maven-plugin-plugin 插件生成了插件的描述文件，并使用 maven-jar-plugin 打包了插件。

最后，我们在另一个 Maven 项目中使用插件，并在其中配置了插件的执行。通过这个例子，我们可以学习到 Maven 插件的基本结构和使用方法，以及如何在项目中使用自定义的 Maven 插件。

本文只是一个简单的 Maven 插件示例。实际开发中，可能需要使用更复杂的插件结构和逻辑。此外，开发 Maven 插件需要一定的 Java 和 Maven 技能，需要对 Maven 构建和插件开发有一定的了解。