maven常用插件介绍

在 Maven 项目的pom.xml文件中的<build>节点中，经常会包含需要配置的各种 Maven 插件。以下是一些常见的 Maven 插件，它们的名称、作用、适用场景以及配置时需要注意的事项：

插件名称	作用	适用场景	配置注意事项
maven-compiler-plugin	编译 Java 源代码	编译 Java 代码，设置 Java 版本	确保配置正确的source和target版本
maven-surefire-plugin	运行单元测试	运行 JUnit 或TestNG 单元测试	确保配置适当的测试目录和测试报表输出目录
maven-failsafe-plugin	运行集成测试	运行集成测试，通常在集成环境使用	确保与maven-surefire-plugin分开配置，集成测试通常在integration-test和verify阶段运行
maven-jar-plugin	打包项目为 JAR 文件	打包标准 Java 项目	可配置manifest来指定主类（main class）等信息
maven-war-plugin	打包项目为 WAR 文件	打包 Web 应用项目	确保 Web 应用的结构符合标准 WAR 目录结构
maven-ear-plugin	打包项目为 EAR 文件	打包企业级 Java 应用项目	确保应用的结构符合标准 EAR 目录结构
maven-assembly-plugin	创建自定义的项目打包	创建包括依赖库的自定义压缩包	注意描述符（descriptor）文件的配置，确保正确包括需要的资源和依赖
maven-dependency-plugin	管理项目依赖	检查、复制、解压依赖，清单依赖	确保配置正确的目标目录和依赖范围
maven-clean-plugin	清理项目产生的文件	删除target目录及生成的构建产物	确保正确配置清理的目标目录
maven-resources-plugin	处理资源文件	复制、过滤资源文件	确保资源目录和资源过滤的正确配置
maven-site-plugin	生成项目站点	生成 Maven 项目站点，包含文档、报表等	确保正确配置site.xml，并配置要生成的报表和文档
maven-checkstyle-plugin	进行代码风格检查	静态代码分析，确保代码符合指定风格	确保配置正确的 Checkstyle 规则文件
maven-pmd-plugin	进行代码质量检查	静态代码分析，检测潜在的代码问题	确保配置正确的 PMD 规则文件
jacoco-maven-plugin	收集和生成代码覆盖率报告	分析代码测试覆盖率	确保在测试后运行，配置正确的覆盖率报告输出目录
build-helper-maven-plugin	提供额外的构建功能（如附加源路径、生成版本）	当需要动态附加源码目录或生成版本号时	确保正确配置执行阶段和附加路径，避免影响正常构建流程
gmavenplus-plugin	支持 Groovy 代码和脚本	编写和编译 Groovy 代码、运行 Groovy 脚本	确保 Groovy 依赖已正确配置，使用合适的 Groovy 版本
maven-javadoc-plugin	生成 JavaDoc 文档	生成项目的 JavaDoc	确保正确配置 JavaDoc 的参数，尤其是源代码路径和文档输出路径
maven-antrun-plugin	集成 Ant 任务	当需要执行自定义 Ant 任务时使用	确保正确配置要执行的 Ant 任务和目标

示例插件配置

以下是一段pom.xml文件中的<build>节点配置示例，展示了如何配置常见的 Maven 插件：

<build>
    <plugins>
        <!-- 编译插件 -->
        <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>
            </configuration>
        </plugin>

        <!-- 单元测试插件 -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>2.22.2</version>
        </plugin>

        <!-- 集成测试插件 -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-failsafe-plugin</artifactId>
            <version>2.22.2</version>
        </plugin>

        <!-- JAR 打包插件 -->
        <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>

        <!-- 站点生成插件 -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-site-plugin</artifactId>
            <version>3.8.2</version>
        </plugin>

        <!-- 代码风格检查插件 -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-checkstyle-plugin</artifactId>
            <version>3.1.1</version>
            <configuration>
                <configLocation>checkstyle.xml</configLocation>
            </configuration>
        </plugin>
    </plugins>
</build>

 

<build>
    <plugins>
        <!-- gmavenplus 插件 -->
        <plugin>
            <groupId>org.codehaus.gmavenplus</groupId>
            <artifactId>gmavenplus-plugin</artifactId>
            <version>1.12.1</version>
            <executions>
                <execution>
                    <goals>
                        <goal>addSources</goal>
                        <goal>addTestSources</goal>
                        <goal>generateStubs</goal>
                        <goal>compile</goal>
                        <goal>generateTestStubs</goal>
                        <goal>compileTests</goal>
                        <goal>removeStubs</goal>
                        <goal>removeTestStubs</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

 

在上述配置中，我们添加了常见的几个 Maven 插件，分别用于编译、单元测试、集成测试、打包、生成站点以及代码风格检查。通过这样的配置，可以确保构建过程中的各个环节都能够顺利完成，并保证代码质量合格。