首页 > 技术文章 > Maven插件

feng-de-wei-xiao 2015-04-27 16:06 原文

什么是Maven的插件?

Maven是一个实际执行的插件框架,每一个任务实际上是由插件完成的。Maven的插件通常用于:

  • 创建 jar 文件

  • 创建 war 文件 

  • 编译代码文件

  • 代码进行单元测试

  • 创建项目文档

  • 创建项目报告

一个插件通常提供了一组目标,可使用以下语法来执行:

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

例如,一个Java项目可以与Maven的编译器插件的编译目标,通过运行以下命令编译

mvn compiler:compile

插件类型

Maven提供以下两种类型的插件:

类型描述
构建插件 他们在生成过程中执行,并应在pom.xml中的<build/>元素进行配置
报告插件 他们的网站生成期间执行的,他们应该在pom.xml中的<reporting/>元素进行配置

以下是一些常见的插件列表:

插件描述
clean Clean up target after the build. Deletes the target directory.
compiler Compiles Java source files.
surefile Run the JUnit unit tests. Creates test reports.
jar Builds a JAR file from the current project.
war Builds a WAR file from the current project.
javadoc Generates Javadoc for the project.
antrun Runs a set of ant tasks from any phase mentioned of the build.

例子

我们使用maven-antrun-plugin插件在我们的例子打印在控制台上的数据。让我们来了解它在一个更好的方式,让我们创建一个pom.xml 在 C:\MVN\project 文件夹。 

<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将开始处理和显示的清洁周期清洁阶段

[INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------
[INFO] Building Unnamed - com.companyname.projectgroup:project:jar:1.0
[INFO]    task-segment: [post-clean]
[INFO] ------------------------------------------------------------------
[INFO] [clean:clean {execution: default-clean}]
[INFO] [antrun:run {execution: id.clean}]
[INFO] Executing tasks
     [echo] clean phase
[INFO] Executed tasks
[INFO] ------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------
[INFO] Total time: < 1 second
[INFO] Finished at: Sat Jul 07 13:38:59 IST 2012
[INFO] Final Memory: 4M/44M
[INFO] ------------------------------------------------------------------

上面的例子说明了以下关键概念:

  • 插件使用的插件元素中指定的pom.xml。

  • 每个插件可以有多个目标。

  • 你可以从那里插件应该使用它的相位元素开始它的处理定义阶段。我们已经使用clean 阶段。

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

  • 就这样,Maven将处理其余部分。它会下载这个插件,如果没有可用的本地存储库并开始处理。

推荐阅读