快捷導(dǎo)航

Maven插件詳細(xì)步驟

更新時(shí)間：2025年05月17日 10:00:41 作者：曠野說

在學(xué)習(xí)和了解 Nexus-public 過程中,發(fā)現(xiàn) Java 項(xiàng)目中有一大部分是以 Maven 插件的形式進(jìn)行深度融合不同功能的,下面給大家介紹Maven插件詳細(xì)步驟,感興趣的朋友一起看看吧

在學(xué)習(xí)和了解 Nexus-public 過程中，發(fā)現(xiàn) Java 項(xiàng)目中有一大部分是以 Maven 插件的形式進(jìn)行深度融合不同功能的。好處是原本需要拆分為多個(gè)項(xiàng)目的功能，可以集中處理，使項(xiàng)目更加輕量化，前后端一體化融合更加便捷。為此編寫一個(gè) Maveen 插件開發(fā)過程，以備不時(shí)不需。

開發(fā)一個(gè)Maven插件涉及多個(gè)步驟，以下是詳細(xì)的指南：

1. 創(chuàng)建Maven插件項(xiàng)目

使用maven-plugin-archetype快速生成項(xiàng)目骨架：

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） 是插件的執(zhí)行單元，每個(gè)Goal對(duì)應(yīng)一個(gè)Mojo類。
繼承AbstractMojo并實(shí)現(xiàn)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調(diào)用
public class GreetingMojo extends AbstractMojo {
    @Parameter(property = "name", defaultValue = "World") // 從配置或命令行讀取參數(shù)
    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 + "!");
    }
}

關(guān)鍵注解

@Mojo：標(biāo)記類為Mojo，name指定Goal名稱。
@Parameter：聲明可配置參數(shù)，property支持命令行傳參（如-Dname=Alice），defaultValue設(shè)置默認(rèn)值。
getLog()：提供插件的日志輸出能力。

3. 配置插件元數(shù)據(jù)

在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. 構(gòu)建和安裝插件

mvn clean install

將插件安裝到本地Maven倉(cāng)庫(kù)，供其他項(xiàng)目使用。

5. 使用插件

在項(xiàng)目的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>

命令行直接調(diào)用

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

6. 高級(jí)功能

參數(shù)類型支持

復(fù)雜類型：支持List、Map等。

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

依賴注入

通過@Component注入Maven上下文對(duì)象：

@Component
private MavenProject project; // 獲取項(xiàng)目信息
public void execute() {
    getLog().info("Project Artifact: " + project.getArtifactId());
}

生命周期綁定

在execution中指定phase（如compile、package），插件Goal將在對(duì)應(yīng)階段自動(dòng)執(zhí)行。