Maven插件步骤

在学习和了解 Nexus-public 过程中，发现 Java 项目中有一大部分是以 Maven 插件的形式进行深度融合不同功能的。好处是原本需要拆分为多个项目的功能，可以集中处理，使项目更加轻量化，前后端一体化融合更加便捷。为此编写一个 Maveen 插件开发过程，以备不时不需。

开发一个Maven插件涉及多个步骤，以下是详细的指南：

---

1. 创建Maven插件项目

使用maven-plugin-archetype快速生成项目骨架：

mvn archetype:generate \
  -DgroupId=com.example.plugins \
  -DartifactId=custom-maven-plugin \
  -DarchetypeGroupId=org.apache.maven.archetypes \
  -DarchetypeArtifactId=maven-plugin-archetype \
  -DinteractiveMode=false

---

2. 插件核心：Mojo类

• Mojo（Maven Old Java Object） 是插件的执行单元，每个Goal对应一个Mojo类。
• 继承AbstractMojo并实现execute()方法，逻辑在此编写。

示例Mojo类

package com.example.plugins;

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

@Mojo(name = "greet") // 定义Goal名称，通过mvn custom:greet调用
public class GreetingMojo extends AbstractMojo {

    @Parameter(property = "name", defaultValue = "World") // 从配置或命令行读取参数
    private String name;

    @Parameter(property = "verbose", defaultValue = "false")
    private boolean verbose;

    public void execute() throws MojoExecutionException {
        if (verbose) {
            getLog().info("Verbose mode enabled.");
        }
        getLog().info("Hello, " + name + "!");
    }
}

关键注解

• @Mojo：标记类为Mojo，name指定Goal名称。
• @Parameter：声明可配置参数，property支持命令行传参（如-Dname=Alice），defaultValue设置默认值。
• getLog()：提供插件的日志输出能力。

---

3. 配置插件元数据

在pom.xml中配置插件的基本信息和依赖：

<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example.plugins</groupId>
    <artifactId>custom-maven-plugin</artifactId>
    <version>1.0.0</version>
    <packaging>maven-plugin</packaging>

    <dependencies>
        <!-- Maven插件API依赖 -->
        <dependency>
            <groupId>org.apache.maven</groupId>
            <artifactId>maven-plugin-api</artifactId>
            <version>3.8.6</version>
        </dependency>
        <!-- 注解处理 -->
        <dependency>
            <groupId>org.apache.maven.plugin-tools</groupId>
            <artifactId>maven-plugin-annotations</artifactId>
            <version>3.6.4</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <!-- 生成插件描述符 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-plugin-plugin</artifactId>
                <version>3.6.4</version>
                <configuration>
                    <goalPrefix>custom</goalPrefix> <!-- 插件前缀 -->
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

---

4. 构建和安装插件

mvn clean install

将插件安装到本地Maven仓库，供其他项目使用。

---

5. 使用插件

在项目的pom.xml中配置：

<build>
    <plugins>
        <plugin>
            <groupId>com.example.plugins</groupId>
            <artifactId>custom-maven-plugin</artifactId>
            <version>1.0.0</version>
            <configuration>
                <name>Alice</name>
                <verbose>true</verbose>
            </configuration>
            <executions>
                <execution>
                    <phase>compile</phase> <!-- 绑定到compile阶段 -->
                    <goals>
                        <goal>greet</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

命令行直接调用

mvn com.example.plugins:custom-maven-plugin:1.0.0:greet -Dname=Alice
# 或使用前缀（需goalPrefix配置正确）
mvn custom:greet -Dname=Alice

---

6. 高级功能

参数类型支持

• 复杂类型：支持List、Map等。

  @Parameter
  private List<String> messages;
  
  @Parameter
  private Map<String, String> properties;
  

依赖注入

通过@Component注入Maven上下文对象：

@Component
private MavenProject project; // 获取项目信息

public void execute() {
    getLog().info("Project Artifact: " + project.getArtifactId());
}

生命周期绑定

在execution中指定phase（如compile、package），插件Goal将在对应阶段自动执行。

---

7. 调试与测试

• 日志输出：使用getLog().debug()或-X参数开启Maven调试日志。
• 单元测试：使用maven-plugin-testing-harness进行Mojo测试。
• 集成测试：在src/it目录下编写集成测试用例，使用maven-invoker-plugin执行。

---

8. 生成文档

使用maven-plugin-plugin生成插件文档：

mvn plugin:report

生成的目标文档位于target/site/plugin-info.html，描述插件的Goals和参数。

---

常见问题解决

• Goal未找到：检查goalPrefix配置和插件是否正确安装。
• 参数未注入：确认@Parameter注解正确，且字段非final。
• 依赖冲突：使用mvn dependency:tree排查依赖。

---

通过以上步骤，可以开发出功能完善的Maven插件，灵活扩展构建流程，适应项目特定需求。