Maven pom.xml文件中build,plugin标签的具体使用

goTsHgo

已于 2023-07-31 16:06:55 修改

阅读量7.1k

点赞数 2

文章标签： java maven xml

于 2023-07-31 16:05:35 首次发布

本文链接：https://blog.csdn.net/goTsHgo/article/details/132023996

版权

<build> 标签
`<build>` 标签是 `pom.xml` 文件中一个重要的标签，用于配置 Maven 项目的构建过程。在 `<build>` 标签下，可以配置构建相关的设置，包括源代码目录、输出目录、插件配置等。
以下是 `<build>` 标签的详细使用方法和适用场景：

<build>
  <!-- 配置项目的源代码目录，默认为 "src/main/java" -->
  <sourceDirectory>src/main/java</sourceDirectory>

  <!-- 配置项目的测试代码目录，默认为 "src/test/java" -->
  <testSourceDirectory>src/test/java</testSourceDirectory>

  <!-- 配置项目的资源文件目录，默认为 "src/main/resources" -->
  <resources>
    <resource>
      <directory>src/main/resources</directory>
    </resource>
  </resources>

  <!-- 配置项目的测试资源文件目录，默认为 "src/test/resources" -->
  <testResources>
    <testResource>
      <directory>src/test/resources</directory>
    </testResource>
  </testResources>

  <!-- 配置项目的输出目录，默认为 "target/classes" -->
  <outputDirectory>target/classes</outputDirectory>

  <!-- 配置项目的测试输出目录，默认为 "target/test-classes" -->
  <testOutputDirectory>target/test-classes</testOutputDirectory>

  <!-- 配置项目的插件列表，用于自定义项目构建过程 -->
  <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>
    <!-- 可以声明其他插件 -->
  </plugins>

  <!-- 其他构建相关的配置 -->
</build>

适用场景：

1. 指定源代码和测试代码目录：
使用 `<sourceDirectory>` 和 `<testSourceDirectory>` 标签可以自定义项目的源代码和测试代码目录。如果项目结构不同于默认的目录结构（如多模块项目等），则可以使用这些配置指定实际的代码目录。

2. 配置资源文件目录：
通过 `<resources>` 和 `<testResources>` 标签，可以指定项目的资源文件目录和测试资源文件目录。资源文件通常包含配置文件、属性文件、模板等，可以根据需要调整资源文件的位置。

3. 配置输出目录：
使用 `<outputDirectory>` 和 `<testOutputDirectory>` 标签可以配置项目的输出目录和测试输出目录。编译后的类文件和测试类文件会被输出到这些目录中。

4. 自定义构建过程：
`<plugins>` 标签用于配置项目使用的 Maven 插件，通过自定义插件的目标和参数，可以实现更复杂的构建过程，例如代码生成、压缩、静态分析等。

5. 使用其他构建相关的配置：
在 `<build>` 标签内还可以使用其他构建相关的配置，例如使用 `<extensions>` 标签声明项目构建时要使用的 Maven 扩展，或使用 `<defaultGoal>` 标签指定默认的构建目标等。

总结：`<build>` 标签用于配置 Maven 项目的构建过程，包括源代码目录、输出目录、资源文件目录、插件列表等。通过在此标签下进行配置，可以根据项目的需求自定义构建过程，从而实现更灵活、高效的项目构建。

Maven 插件（Plugins）是用于扩展和定制 Maven 构建过程的工具。Maven 插件可以帮助执行各种任务，如编译代码、运行测试、打包项目、部署应用程序等。在 `pom.xml` 文件中，通过 `<plugins>` 和 `<plugin>` 标签来配置 Maven 插件。

以下是 Maven 插件的详细使用方法：

1. 声明插件依赖：
在 `<build>` 标签内，通常有一个 `<plugins>` 标签，用于声明要使用的插件。在 `<plugins>` 标签下，每个插件都由一个 `<plugin>` 子标签来定义，可以包含以下信息：

- `groupId`：插件的 Group ID，通常是 `org.apache.maven.plugins`。
- `artifactId`：插件的 Artifact ID，标识特定的插件。
- `version`：插件的版本号。

示例：

   <build>
     <plugins>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-compiler-plugin</artifactId>
         <version>3.8.1</version>
       </plugin>
       <!-- 可以声明其他插件 -->
     </plugins>
   </build>

2. 配置插件目标（Goal）：
Maven 插件的功能通过目标（Goal）来实现，一个插件可以有多个目标。目标是插件的执行单元，通过在插件配置中指定目标，可以按需执行插件的不同功能。

示例：

   <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>

在上面的示例中，`maven-compiler-plugin` 插件的目标是编译 Java 代码。`<configuration>` 子标签用于配置插件的目标，指定 Java 编译的源代码版本和目标版本。

3. 自定义插件配置：
大多数 Maven 插件支持自定义配置，可以通过在 `<configuration>` 子标签内指定参数来实现。插件的具体配置取决于插件本身的功能和支持的配置选项。

示例：

   <plugin>
     <groupId>org.apache.maven.plugins</groupId>
     <artifactId>maven-jar-plugin</artifactId>
     <version>3.2.0</version>
     <configuration>
       <archive>
         <manifest>
           <addClasspath>true</addClasspath>
           <classpathPrefix>lib/</classpathPrefix>
         </manifest>
       </archive>
     </configuration>
   </plugin>

在上面的示例中，`maven-jar-plugin` 插件用于创建 JAR 文件，并通过自定义配置将依赖库打包到 JAR 中。

4. 执行插件目标：
通过在命令行中输入 `mvn` 命令，加上插件的目标名称，来执行插件功能。例如，要执行 `maven-compiler-plugin` 的 `compile` 目标（编译代码），可以使用以下命令：

mvn compile

这将触发 Maven 编译插件，编译项目的源代码。

5. 生命周期绑定：
Maven 插件通常与构建的生命周期绑定，这意味着某些插件目标会在特定的构建阶段自动执行。例如，`maven-compiler-plugin` 插件的 `compile` 目标与 Maven 构建的 `compile` 阶段绑定，因此在执行 `mvn compile` 命令时，编译代码的目标会自动执行。

总结：Maven 插件通过在 `pom.xml` 文件中声明和配置插件，然后使用命令行执行插件目标来实现项目的构建和其他定制化操作。插件是 Maven 构建的关键组成部分，它们为开发人员提供了丰富的功能，帮助自动化构建过程和其他开发任务。

Maven 中有很多插件可以用于不同的构建任务和工作流程。在此，我列举一些常见的 Maven 插件以及它们的使用场景，并提供简单的使用案例和注释。

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>
       </configuration>
     </plugin>

注释：上面的配置指定使用 Java 8 编译源代码，并将生成的字节码与目标版本设置为 Java 8。

2. `maven-jar-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>
             <classpathPrefix>lib/</classpathPrefix>
           </manifest>
         </archive>
       </configuration>
     </plugin>

注释：上面的配置在 JAR 的 MANIFEST.MF 文件中添加类路径信息，并将依赖库放置在 JAR 内的 "lib/" 目录下。

3. `maven-surefire-plugin` 插件
- 使用场景：运行项目的单元测试。
- 使用案例：

     <plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-surefire-plugin</artifactId>
       <version>3.0.0-M5</version>
       <configuration>
         <includes>
           <include>**/*Test.java</include>
         </includes>
       </configuration>
     </plugin>

注释：上面的配置指定运行所有以 "Test.java" 结尾的单元测试类。

4. `maven-assembly-plugin` 插件
- 使用场景：创建自定义的分发包，如包含所有依赖的可执行 JAR 文件。
- 使用案例：

     <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>

注释：上面的配置创建一个包含所有依赖的可执行 JAR 文件。

5. `maven-clean-plugin` 插件
- 使用场景：清理项目构建产生的临时文件和目录。
- 使用案例：

     <plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-clean-plugin</artifactId>
       <version>3.1.0</version>
     </plugin>

注释：上面的配置可以使用 `mvn clean` 命令清理项目构建产生的临时文件和目录。

6. `maven-install-plugin` 插件
- 使用场景：将项目安装到本地 Maven 仓库。
- 使用案例：

     <plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-install-plugin</artifactId>
       <version>3.0.0-M1</version>
     </plugin>

注释：上面的配置可以使用 `mvn install` 命令将项目安装到本地 Maven 仓库。

7. `maven-deploy-plugin` 插件
- 使用场景：将项目构建结果部署到远程 Maven 仓库，通常是私有或公共的远程仓库。
- 使用案例：

     <plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-deploy-plugin</artifactId>
       <version>3.0.0-M1</version>
     </plugin>

注释：上面的配置用于部署构建结果到远程 Maven 仓库，通常与 `mvn deploy` 命令一起使用。

8. `maven-shade-plugin` 插件
- 使用场景：创建一个包含所有依赖的可执行 JAR 文件，并且可以排除冲突的依赖。
- 使用案例：

     <plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-shade-plugin</artifactId>
       <version>3.2.4</version>
       <configuration>
         <!-- 配置排除依赖 -->
         <filters>
           <filter>
             <artifact>*:*</artifact>
             <excludes>
               <exclude>META-INF/*.SF</exclude>
               <exclude>META-INF/*.DSA</exclude>
               <exclude>META-INF/*.RSA</exclude>
             </excludes>
           </filter>
         </filters>
       </configuration>
     </plugin>

注释：上面的配置创建一个包含所有依赖的可执行 JAR 文件，并且排除了一些冲突的依赖。

9. `maven-site-plugin` 插件
- 使用场景：生成项目站点文档，包括项目信息、依赖、测试报告等。
- 使用案例：

     <plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-site-plugin</artifactId>
       <version>3.12.1</version>
     </plugin>

注释：上面的配置用于生成项目站点文档，可以使用 `mvn site` 命令来执行。

10. `maven-checkstyle-plugin` 插件
- 使用场景：对项目代码进行静态代码分析，以检查是否符合编码规范。
- 使用案例：

      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-checkstyle-plugin</artifactId>
        <version>3.1.2</version>
        <configuration>
          <!-- 配置 Checkstyle 的规则 -->
          <configLocation>checkstyle.xml</configLocation>
        </configuration>
        <executions>
          <!-- 在验证阶段执行 Checkstyle 检查 -->
          <execution>
            <id>validate</id>
            <phase>validate</phase>
            <goals>
              <goal>check</goal>
            </goals>
          </execution>
        </executions>
      </plugin>

注释：上面的配置用于在验证阶段执行 Checkstyle 检查，可以自定义 Checkstyle 的规则文件。

11. `maven-release-plugin` 插件
- 使用场景：发布项目的正式版本，包括打标签、升级版本号等。
- 使用案例：

      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-release-plugin</artifactId>
        <version>3.0.0-M1</version>
        <configuration>
          <!-- 配置发布版本的相关信息 -->
        </configuration>
      </plugin>

注释：上面的配置用于配置发布版本的相关信息，可以使用 `mvn release:prepare` 和 `mvn release:perform` 命令来执行版本发布流程。

12. `maven-assembly-plugin` 插件
- 使用场景：创建自定义的分发包，可以包含项目的可执行 JAR 文件和其他资源文件。
- 使用案例：

      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-assembly-plugin</artifactId>
        <version>3.3.0</version>
        <configuration>
          <!-- 配置分发包的描述 -->
          <descriptor>assembly.xml</descriptor>
        </configuration>
        <executions>
          <execution>
            <!-- 在打包阶段执行创建分发包 -->
            <id>make-assembly</id>
            <phase>package</phase>
            <goals>
              <goal>single</goal>
            </goals>
          </execution>
        </executions>
      </plugin>

注释：上面的配置用于在打包阶段执行创建自定义的分发包，可以通过 `assembly.xml` 文件来定义分发包的内容和结构。

13. `maven-javadoc-plugin` 插件
- 使用场景：生成项目的 Javadoc 文档，用于描述代码的接口和注释。
- 使用案例：

     <plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-javadoc-plugin</artifactId>
       <version>3.3.0</version>
       <configuration>
         <!-- 配置生成 Javadoc 的相关设置 -->
       </configuration>
     </plugin>

注释：上面的配置用于配置生成 Javadoc 的相关设置，可以使用 `mvn javadoc:javadoc` 命令来执行生成 Javadoc 文档。

14. `maven-antrun-plugin` 插件
- 使用场景：在 Maven 构建过程中执行 Ant 任务，可以用于执行自定义的构建任务。
- 使用案例：

     <plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-antrun-plugin</artifactId>
       <version>3.0.0</version>
       <executions>
         <execution>
           <id>custom-task</id>
           <phase>compile</phase>
           <configuration>
             <!-- 配置执行的 Ant 任务 -->
             <target>
               <echo message="Executing custom task..."/>
             </target>
           </configuration>
           <goals>
             <goal>run</goal>
           </goals>
         </execution>
       </executions>
     </plugin>

注释：上面的配置用于在编译阶段执行自定义的 Ant 任务，这里简单地输出一条消息。

15. `maven-resources-plugin` 插件
- 使用场景：处理项目的资源文件，例如复制、过滤、替换等操作。
- 使用案例：

     <plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-resources-plugin</artifactId>
       <version>3.2.0</version>
       <configuration>
         <!-- 配置资源文件的处理规则 -->
         <resources>
           <resource>
             <directory>src/main/resources</directory>
             <filtering>true</filtering>
           </resource>
         </resources>
       </configuration>
     </plugin>

注释：上面的配置用于将 `src/main/resources` 目录下的资源文件进行过滤，替换其中的属性占位符等。

16. `maven-enforcer-plugin` 插件
- 使用场景：强制执行特定的构建规则，例如强制使用特定的 Java 版本。
- 使用案例：

     <plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-enforcer-plugin</artifactId>
       <version>3.0.0-M3</version>
       <executions>
         <execution>
           <id>enforce-java-version</id>
           <goals>
             <goal>enforce</goal>
           </goals>
           <configuration>
             <!-- 配置强制的规则 -->
             <rules>
               <requireJavaVersion>
                 <version>1.8</version>
               </requireJavaVersion>
             </rules>
           </configuration>
         </execution>
       </executions>
     </plugin>

注释：上面的配置用于强制要求使用 Java 8 版本。

17. `maven-war-plugin` 插件
- 使用场景：将项目打包为 WAR 文件，用于部署到 Servlet 容器（如 Tomcat、Jetty 等）。
- 使用案例：

     <plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-war-plugin</artifactId>
       <version>3.3.1</version>
       <configuration>
         <!-- 配置 WAR 文件的属性 -->
       </configuration>
     </plugin>

注释：上面的配置用于配置 WAR 文件的属性，例如 Web 资源目录、Web 应用清单文件等。

这些是更多常见的 Maven 插件及其使用场景、使用案例和注释。Maven 提供了众多功能强大的插件，可以满足各种构建和项目管理需求。开发人员可以根据项目的特点和要求，选择合适的插件，并灵活配置以提高项目开发和构建的效率。

goTsHgo

关注

2
点赞
踩
24

收藏

觉得还不错? 一键收藏
0
评论
Maven pom.xml文件中build,plugin标签的具体使用

例如，`maven-compiler-plugin` 插件的 `compile` 目标与 Maven 构建的 `compile` 阶段绑定，因此在执行 `mvn compile` 命令时，编译代码的目标会自动执行。在 `` 标签内还可以使用其他构建相关的配置，例如使用 `` 标签声明项目构建时要使用的 Maven 扩展，或使用 `` 标签指定默认的构建目标等。目标是插件的执行单元，通过在插件配置中指定目标，可以按需执行插件的不同功能。
复制链接

扫一扫