3-Maven-plugins配置

时间：2024-06-11 07:16:41

3-Maven-plugins配置

plugins的作用是定义 Maven 插件， plugins 主要用于扩展 Maven 的功能，帮助开发人员更方便地构建、打包、发布项目。插件可以通过 Maven 的插件中心或者自己构建的私有仓库来使用，能在构建过程中执行特定的任务，比如编译、打包、测试等。插件的配置可以分为两种方式：全局配置和项目配置。全局配置是在 Maven 安装目录下的 conf/settings.xml 文件中进行配置，可以被所有的项目使用。项目配置则是在项目的 pom.xml 文件中进行配置，只对当前项目生效。

插件的使用主要分为以下几个步骤：

  1. 在 pom.xml 中声明插件依赖
  2. 配置插件的参数
  3. 运行插件命令

接下来我们对常用插件做详细解释：

maven-compiler-plugin：编译插件

<plugins>
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <!--<version>3.5.1</version>-->
        <configuration>
            <source>21</source>
            <target>21</target>
            <encoding>${file_encoding}</encoding>
            <skip>true</skip>
        </configuration>
    </plugin>
</plugins>
  • <source>：指定Java源代码的版本，例如21表示Java 21。
  • <target>：指定编译后的字节码版本，例如21表示Java 21。
  • <encoding>：指定源代码的编码格式。
  • <showWarnings>：是否显示编译警告信息，true表示显示，false表示不显示。
  • <compilerArgs>：可选参数，可以添加多个编译器参数，例如-Xlint选项用来启用编译器警告检查。

如果我们按示例中配置，我们就指定了编译器的源和目标版本为21，当我们使用 mvn compile 命令的时候，这个插件将会编译我们的 Java 代码，并将编译后的 class 文件放置在 target 目录下

maven-surefire-plugin：测试

maven-surefire-plugin插件是Maven中的一个测试框架，用于执行Java单元测试和集成测试。它的主要作用是在构建过程中运行测试，并生成测试报告，在pom.xml中的配置如下：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>3.0.0-M4</version>
            <configuration>
                <skipTests>true</skipTests>
                <forkCount>2</forkCount>
                <useSystemClassLoader>false</useSystemClassLoader>
                <reuseForks>true</reuseForks>
                <includes>
                    <include>**/*Test.java</include>
                    <include>**/*Tests.java</include>
                </includes>
                <systemProperties>
                    <property>
                        <name>testProp1</name>
                        <value>value1</value>
                    </property>
                    <property>
                        <name>testProp2</name>
                        <value>value2</value>
                    </property>
                </systemProperties>
            </configuration>
        </plugin>
    </plugins>
</build>

其中几个子标签的作用分别如下:

：设置是否跳过测试，默认值为false。
：设置并行运行测试的JVM进程数。
：设置是否使用系统类加载器加载测试类。
：设置是否重用已经启动的JVM进程。
：设置测试文件的过滤规则，支持通配符。
：设置传递给测试环境的系统属性，可以在测试代码中通过System.getProperty()方法获取

maven-clean-plugin

maven-install-plugin

当执行mvn instal命令时，maven-install-plugin 用于将一个特定的文件安装到本地Maven仓库中，以便其他项目可以使用它，例如在pom.xml中的配置如下：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-install-plugin</artifactId>
    <version>3.0.0-M1</version>
    <configuration>
        <file>${project.build.directory}/example.jar</file>
        <groupId>com.example</groupId>
        <artifactId>example</artifactId>
        <version>1.0.0</version>
        <packaging>jar</packaging>
    </configuration>
</plugin>

：用来指定要安装到本地Maven仓库中的文件的路径。该标签的值应该是一个文件的绝对或相对路径。
：通过该标签设置所安装文件的groupId，通常表示项目的组织或组织部门的标识符。
：同样是通过该标签设置所安装文件的artifactId，通常是指该文件的名称。
：通过该标签设置所安装文件的版本号，通常采用三级版本号的格式，例如"1.0.0"。
：通过该标签来指定所安装文件的打包类型，通常是jar或war。
需要注意的是，标签必须与、和标签一起使用，才能正确将该文件安装到本地Maven仓库中，并在其他项目中使用，除了以上的配置，还有一些可选的配置项：

：通过该标签指定所安装文件的分类器，例如"sources"或"javadoc"等，默认为null。
：通过该标签指定本地仓库的路径，默认为Maven默认的本地仓库路径。
：是否在安装文件时创建SHA-1校验和，默认为true。
：是否跳过该插件的运行，默认为false，即不跳过。

maven-release-plugin

maven-deploy-plugin

<!-- maven-deploy-plugin 一般用于将项目发布到远程仓库 配合<distributionManagement>标签设置一起使用 -->
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-deploy-plugin</artifactId>
    <version>2.8.2</version>
    <configuration>
        <updateReleaseInfo>true</updateReleaseInfo>
    </configuration>
</plugin>

maven-dependency-plugin

maven-dependency-plugin是处理与依赖相关的插件。它有很多可用的goal，大部分是和依赖构建、分析和解决相关的goal，这部分goal可以直接用maven的命令操作，例如：mvn dependency:tree、mvn dependency:analyze 但是我们最常用到的是 dependency:copy、dependency:copy-dependencies、dependency:unpack、dependency:unpack-dependencies 这四个。

<plugins>
    <!-- 设置依赖的jar包下载路径 -->
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-dependency-plugin</artifactId>
        <version>3.6.1</version>
        <executions>
            <execution>
                <goals>
                    <!-- copy-dependencies 是用来拷当前工程的依赖包。  -->
                    <goal>copy-dependencies</goal>
                </goals>
                <configuration>
                    <type>jar</type>
                    <includeTypes>jar</includeTypes>
                    <includeScope>runtime</includeScope>
                    <!-- 把所依赖的jar包copy到指定目录 -->
                    <outputDirectory>${project.build.directory}/libs</outputDirectory>
                </configuration>
            </execution>
        </executions>
    </plugin>
</plugins>

指路：

https://zhuanlan.zhihu.com/p/70596302

https://blog.****.net/u011709538/article/details/132815440

相关文章