【maven-9】Maven插件：深入理解与高效使用

Maven 是一个强大的项目管理工具，广泛用于 Java 项目的构建、依赖管理和文档生成。Maven 的核心功能之一是其插件系统，通过插件，Maven 可以扩展其功能，满足各种复杂的构建需求。下面将深入探讨 Maven 插件的工作原理、常用插件以及如何编写自定义插件。

1. Maven 插件基础

1.1 什么是 Maven 插件？

Maven 插件是 Maven 的核心扩展机制。每个插件包含一组目标（goals），每个目标代表一个特定的任务。例如，maven-compiler-plugin 插件包含编译源代码的目标，maven-surefire-plugin 插件包含运行测试的目标。

1.2 maven插件下载

1.2.1 访问网址下载，找到maven插件，然后点击编译compiler

1.2.2 点击用量信息页

1.2.3 复制插件

1.2.4 将上述复制的内容放到build标签里面

<!--插件管理-->
<build>
    <plugins>
    	<!--编译插件：jdk1.8-->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.8.1</version>
            <configuration>
            	<!-- put your configurations here -->
            	<!--源码-->
                <source>1.8</source>
                <target>1.8</target>
                <encoding>UTF-8</encoding>
            </configuration>
        </plugin>
    </plugins>
</build>

1.2.5 清除target编译和运行

• 使用的编译插件是我们自己配置的版本。

• 直接运行java代码就不会出现警告信息了。jdk的编译和运行版本统一了。

1.3 插件的结构

一个 Maven 插件通常包含以下几个部分：

• 插件描述符（pom.xml）：定义插件的基本信息、依赖项和目标。
• 目标（Goals）：每个目标代表一个特定的任务，可以在构建生命周期的不同阶段执行。
• Mojo（Maven Old Java Object）：每个目标对应一个 Mojo 类，Mojo 类是插件的核心逻辑实现。

2. 常用 Maven 插件

2.1 maven-compiler-plugin

用于编译 Java 源代码。

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.8.1</version>
    <configuration>
        <source>1.8</source>
        <target>1.8</target>
        <encoding>UTF-8</encoding>
    </configuration>
</plugin>

2.2 maven-surefire-plugin

用于运行单元测试。

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <version>2.22.2</version>
</plugin>

2.3 maven-jar-plugin

用于打包 JAR 文件。

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <version>3.2.0</version>
</plugin>

2.4 maven-assembly-plugin

用于创建自定义的归档文件（如 ZIP、TAR 等）。

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-assembly-plugin</artifactId>
    <version>3.3.0</version>
    <configuration>
        <descriptorRefs>
            <descriptorRef>jar-with-dependencies</descriptorRef>
        </descriptorRefs>
    </configuration>
</plugin>

3. 编写自定义 Maven 插件

3.1 创建插件项目

首先，创建一个新的 Maven 项目，并添加插件的基本信息：

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    
    <groupId>com.allen</groupId>
    <artifactId>Maven-Plugin-Project</artifactId>
    <version>1.0-SNAPSHOT</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>

3.2 编写 Mojo 类

创建一个 Java 类，继承 AbstractMojo，并使用 @Mojo 注解定义目标：

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

@Mojo(name = "greet")
public class GreetingMojo extends AbstractMojo {
    public void execute() throws MojoExecutionException, MojoFailureException {
        getLog().info("Hello, Maven Plugin!");
    }
}

3.3 构建和使用插件

构建插件并安装到本地仓库：

mvn clean install

在其他项目中使用该插件：

<build>
    <plugins>
        <plugin>
            <groupId>com.allen</groupId>
            <artifactId>Maven-Plugin-Project</artifactId>
            <version>1.0-SNAPSHOT</version>
        </plugin>
    </plugins>
</build>

运行插件目标：

mvn com.allen:Maven-Plugin-Project:1.0-SNAPSHOT:greet

4. 总结

Maven 插件是 Maven 构建工具的核心扩展机制，通过插件，你可以轻松地扩展 Maven 的功能，满足各种复杂的构建需求。本文介绍了 Maven 插件的基础知识、常用插件以及如何编写自定义插件。