Maven 简明教程

Maven - Plugins

What are Maven Plugins?

Maven 实际上是一个插件执行框架，其中的每一项任务都是由插件执行。Maven 插件通常用于：-

  1. create jar file

  2. create war file

  3. compile code files

  4. unit testing of code

  5. create project documentation

  6. create project reports

一个插件通常提供一组目标，这些目标可以使用以下语法执行：-

mvn [plugin-name]:[goal-name]

例如，可以通过运行以下命令，使用 maven-compiler-plugin 的 compile-goal 编译一个 Java 项目。

mvn compiler:compile

Plugin Types

Maven 提供了以下两种类型的插件：-

Sr.No.

Type & Description

1

Build plugins 它们在构建过程中执行，应该在 pom.xml 的 <build/> 元素中配置。

2

Reporting plugins 它们在网站生成过程中执行，应该在 pom.xml 的 <reporting/> 元素中配置。

以下是几个常见插件的列表：-

Sr.No.

Plugin & Description

1

clean 在构建后清理目标。删除目标目录。

2

compiler Compiles Java source files.

3

surefire 运行 JUnit 单元测试。创建测试报告。

4

jar 从当前项目构建一个 JAR 文件。

5

war 从当前项目构建一个 WAR 文件。

6

javadoc 为项目生成 Javadoc。

7

antrun 从构建的任何指定的 phase 中运行一组 ant 任务。

Example

我们在示例中大量使用 maven-antrun-plugin 在控制台上打印数据。参考构建配置文件章节。让我们进一步了解一下它，并在 C:\MVN\project 文件夹中创建一个 pom.xml。

<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.companyname.projectgroup</groupId>
   <artifactId>project</artifactId>
   <version>1.0</version>
   <build>
      <plugins>
         <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-antrun-plugin</artifactId>
            <version>1.1</version>
            <executions>
               <execution>
                  <id>id.clean</id>
                  <phase>clean</phase>
                  <goals>
                     <goal>run</goal>
                  </goals>
                  <configuration>
                     <tasks>
                        <echo>clean phase</echo>
                     </tasks>
                  </configuration>
               </execution>
            </executions>
         </plugin>
      </plugins>
   </build>
</project>

接下来，打开命令控制台并转到包含 pom.xml 的文件夹，然后执行以下 mvn 命令。

C:\MVN\project>mvn clean

Maven 将开始处理并显示 clean 生命周期中的 clean phase。

C:\MVN>mvn clean
[INFO] Scanning for projects...
[INFO]
[INFO] ----------------< com.companyname.projectgroup:project >----------------
[INFO] Building project 1.0
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ project ---
[INFO] Deleting C:\MVN\target
[INFO]
[INFO] --- maven-antrun-plugin:1.1:run (id.clean) @ project ---
[INFO] Executing tasks
     [echo] clean phase
[INFO] Executed tasks
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  1.266 s
[INFO] Finished at: 2021-12-13T13:58:10+05:30
[INFO] ------------------------------------------------------------------------

C:\MVN>

上述示例说明了以下几个关键概念：-

  1. 插件使用插件元素在 pom.xml 中指定。

  2. 每个插件都可以有多个目标。

  3. 您可以使用 phase 元素定义插件从哪里开始其处理的阶段。我们使用了 clean 阶段。

  4. 您可以通过将任务绑定到插件的目标来配置要执行的任务。我们已经将 echo 任务与 maven-antrun-plugin 的 run 目标进行绑定。

  5. 如果没有本地存储库中的插件，Maven 就会下载该插件并开始其处理。