Maven Plug-In

最新推荐文章于 2024-10-21 22:52:40 发布

原创最新推荐文章于 2024-10-21 22:52:40 发布 · 282 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#maven #junit #Apache #Hibernate #Ant

Maven-Sonar-Hudson 专栏收录该内容

5 篇文章

订阅专栏

本文介绍了如何使用Maven创建自定义插件的过程，包括创建插件项目、MoJo类的编写、构建和运行自定义插件的方法。还介绍了如何定义插件的目标前缀，并将特定目标绑定到构建生命周期的不同阶段。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Maven的一个很明显有别与Ant的优势就是在于明确了工程中所用资源包的版本信息，目前我们在工程开发过程中都不免需要用到大量的免费开源的第三方插件，而这些插件在升级过程中的向前兼容做的有时候确实不太理想，就想Hibernate在升级到3.0后包结构的变化一样，让很多开发人员在刚开始使用时都是一头雾水，但是由于Maven2可以明确指明所使用的资源包版本信息，这样就避免了工程中由于资源包版本混乱导致程序崩溃的问题。

一、创建Plug-In项目

mvn archetype:create -DgroupId=org.sonatype.mavenbook.plugins 
                                    -DartifactId=first-maven-plugin 
                                    -DarchetypeGroupId=org.apache.maven.archetypes 
                                    -DarchetypeArtifactId=maven-archetype-mojo

Maven会自动到远程库去下载maven-archetype-mojo的插件；
创建成功会生成一个first-maven-plugin的文件夹，里有一个pom.xml文件，内容：

	<groupId>org.sonatype.mavenbook.plugins</groupId>
	<artifactId>first-maven-plugin</artifactId>
	<packaging>maven-plugin</packaging>
	<version>1.0-SNAPSHOT</version>
	<name>first-maven-plugin Maven Mojo</name>
	<url>http://maven.apache.org</url>
	
	<dependencies>
		<dependency>
			<groupId>org.apache.maven</groupId>
			<artifactId>maven-plugin-api</artifactId>
			<version>2.0</version>
		</dependency>
		<dependency>
			<groupId>junit</groupId>
			<artifactId>junit</artifactId>
			<version>3.8.1</version>
			<scope>test</scope>
		</dependency>
	</dependencies>

二、创建一个MoJo类

MOJO就是一个供插件调用处理的普通类

/**
 * Echos an object string to the output screen.
 * @goal echo
 */
public class MyMojo extends AbstractMojo {
	/**
	 * Any Object to print out.
	 * @parameter expression="${echo.message}" default-value="Hello Maven World..."
	 */
	private Object message;

	public void execute() throws MojoExecutionException {
		getLog().info(message.toString());
	}

创建了一个MyMojo类，必须继承AbstractMojo类，实现execute方法，这个方法就是插件调用的入口；

三、Build和Run自定义插件

mvn clean install

插件运行遵循groupId:artifactId:version:goal格式；

mvn org.sonatype.mavenbook.plugins:first-maven-plugin:1.0-SNAPSHOT:echo 
                                    -Decho.message="My first Maven plugin"

四、定义前缀

在setting.xml文件加：

  <pluginGroups>
    <pluginGroup>org.sonatype.mavenbook.plugins</pluginGroup>
  </pluginGroups>

然后：

mvn first:echo -Decho.message="My first Maven plugin"

非常简单。
如果插件的artifactId遵循maven-first-plugin，或者first-maven-plugin模式。Maven就会自动为你的插件赋予前缀first。 ${prefix}-maven-plugin, OR maven-${prefix}-plugin

也可自定义前缀，在pom.xml加：

  <build>
    <plugins>
      <plugin>
        <artifactId>first-maven-plugin</artifactId>
        <version>2.3</version>
        <configuration>
          <goalPrefix>first</goalPrefix>
        </configuration>
      </plugin>
    </plugins>
  </build>

You can also configure your plugin to attach specific goals to a particular phase of the build lifecycle. Here is an example:

<build>
    <plugins>
      <plugin>
        <groupId>sample.plugin</groupId>
        <artifactId>hello-maven-plugin</artifactId>
        <version>1.0-SNAPSHOT</version>
        <executions>
          <execution>
            <phase>compile</phase>
            <goals>
              <goal>sayhi</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>

This causes the simple mojo to be executed whenever Java code is compiled. For more information on binding a mojo to phases in the lifecycle, please refer to the Build Lifecycle document.