Maven是一個一個優秀的項目管理開源框架，其插件機制為其功能擴展提供了非常大的便捷性。大多數情況下，我們不需要自己開發Maven插件，因為Maven本身提供了很多便捷的官方插件。但是對於某些特殊場景和特殊需求，開發一個自定義的Maven插件能大大提高開發效率。本文以一個簡單的例子，展示如何創建一個自定義的Maven插件。
Maven插件開發
本文會以一個自制的Maven插件為例，展示如何使用Idea從0開始構建自制的Maven插件。
Maven插件目標
Maven本質是一個插件執行框架，所有的工作都是通過插件完成的。包括常見的命令如install/clean/deploy/compiler這些命令，其實底層都是一個一個的Maven插件的執行結果。
插件目標：開發一個自制的Maven插件，插件名稱叫demo-test-maven-plugin，該插件包含兩個Goal：
- goal1：執行命令
mvn demo-test:goal1，控制台輸出This is goal1.； - goal2：執行命令
mvn demo-test:goal2，向控制台輸出This is goal2.；
插件項目命名
在開發Maven插件之前，第一件事是確定插件項目名稱。Maven插件有特定的命名規范，命名規范分為兩種類型：
- 官方插件項目命名規范：
maven-xxx-plugin，其中插件名為xxx，在Maven中可以使用命令mvn xxx調用插件； - 自定義插件項目命名規范：
xxx-maven-plugin，其中插件名為xxx，在Maven中可以使用命令mvn xxx調用插件；
我們的插件是自定義插件，插件名為demo-test，所以插件的項目名稱為demo-test-maven-plugin。
建立插件項目
確定好建立的項目名稱為demo-test-maven-plug之后，我們就可以去實際創建一個項目。本節以Idea作為工具，介紹如何建立一個Maven插件項目。
-
Idea中新建Maven項目，並選擇
org.apache.maven.archetypes:maven-archetype-mojo作為項目模板；
-
Idea中輸入項目名稱，點擊確認；
-
最后一步，點擊
Finish按鈕，完成項目的創建；
通過以上步驟，我們創建了一個空的Maven插件項目，這個項目目前沒有任何代碼。
插件項目分析
通過上述步驟，我們創建好了一個空的Maven項目，項目的目錄如下所示：
![創建項目4]
自動生成的項目POM文件內容如下所示，其中有以下幾點比較關鍵：
packaging：普通Java項目的packaging是jar/war/pom，但是Maven插件項目的packaging是maven-plugin；maven-plugin-api：Maven插件項目依賴了maven-plugin-api包，這是Maven插件項目必須依賴的核心包；
<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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.demo.test</groupId>
<artifactId>demo-test-maven-plug</artifactId>
<packaging>maven-plugin</packaging>
<version>1.0-SNAPSHOT</version>
<name>demo-test-maven-plug 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>
</project>
自動生成的項目中還包含一個Java文件，內容如下所示，這個Java文件有幾個特點：
- 生成的類繼承了
AbstractMojo，這里是Maven插件的規范要求，Maven插件必須要繼承AbstractMojo並抽象的execute方法； - 類與方法上有一些
Tag，如@goal。Tag和注解不同，Tag會出現在相關文檔中； Tag@goal的作用是指定插件的命名，如命令mvn clean中，clean就是@goal；Tag@phase的作用是綁定插件執行的生成周期，如clean周期，那么在執行mvn clean時會自動觸發插件；Tag@parameter用來指定插件的參數。
Tag機制有很多問題，如沒有語法報錯等，Maven為什么會使用Tag而不是注解呢呢？這是因為Java早期不支持注解，JDK1.5才開始添加注解功能。Maven開發之初沒有注解，所以只能使用Tag來代替，新版本的Maven中已經可以使用注解來代替Tag。
package org.demo.test;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
/**
* Goal which touches a timestamp file.
*
* @goal touch
*
* @phase process-sources
*/
public class MyMojo
extends AbstractMojo
{
/**
* Location of the file.
* @parameter expression="${project.build.directory}"
* @required
*/
private File outputDirectory;
public void execute()
throws MojoExecutionException
{
File f = outputDirectory;
if ( !f.exists() )
{
f.mkdirs();
}
File touch = new File( f, "touch.txt" );
FileWriter w = null;
try
{
w = new FileWriter( touch );
w.write( "touch.txt" );
}
catch ( IOException e )
{
throw new MojoExecutionException( "Error creating file " + touch, e );
}
finally
{
if ( w != null )
{
try
{
w.close();
}
catch ( IOException e )
{
// ignore
}
}
}
}
}
修改項目POM
默認的POM版本比較老，功能缺失，所以在開發之前需要修改自動生成項目中的POM：
- 升級maven-plugin-api包版本到3.8.3。自動生成POM的版本是低版本的2.0；
- 添加maven-plugin-annotations依賴，這個包內包含了Maven相關的注解，可以取代Tag；
- 添加maven-plugin-plugin插件依賴，這個包可以使插件支持JDK1.8以上的版本；
修改之后的POM如下所示：
<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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.demo.test</groupId>
<artifactId>demo-test-maven-plugin</artifactId>
<packaging>maven-plugin</packaging>
<version>1.0-SNAPSHOT</version>
<name>demo-test-maven-plug Maven Mojo</name>
<url>http://maven.apache.org</url>
<dependencies>
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-plugin-api</artifactId>
<version>3.8.3</version>
</dependency>
<dependency>
<groupId>org.apache.maven.plugin-tools</groupId>
<artifactId>maven-plugin-annotations</artifactId>
<version>3.6.1</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-plugin-plugin</artifactId>
<version>3.6.1</version>
</plugin>
</plugins>
</build>
</project>
添加自定義Mojo
開篇說過，本文項目中的插件需要兩個goal：
- goal1：執行命令
mvn demo-test:goal1，控制台輸出This is goal1.； - goal2：執行命令
mvn demo-test:goal2，向控制台輸出This is goal2.；
在Maven插件開發中，goal和Mojo類對應，所以我們也需要實現兩個Mojo類，如下所示，和默認生成的Mojo類不同：
@Mojo注解：定義插件相關的信息，如name表示goal的名稱；@Parameter注解：指定插件運行時使用的參數，name是參數名，defaultValue是默認值；
@Mojo(name = "goal1")
public class Goal1Mojo extends AbstractMojo {
@Parameter(name = "name", defaultValue = "test")
private String name;
public void execute() {
getLog().info("This is goal1.");
}
}
@Mojo(name = "goal2")
public class Goal2Mojo extends AbstractMojo {
@Parameter(name = "name", defaultValue = "test")
private String name;
public void execute() {
getLog().info("This is goal2.");
}
}
插件的使用
通過上面的步驟，我們簡單實現了一個Maven插件，插件的名稱是demo-test，插件包含兩個Goal：goal1和goal2，接下來，我們把插件項目編譯並發布，編譯和發布的步驟此處不做詳細介紹。
項目編譯發布好之后，我們在另外一個項目的POM中引入該插件：
<build>
<plugins>
<plugin>
<groupId>org.demo.test</groupId>
<artifactId>demo-test-maven-plugin</artifactId>
<version>1.0-SNAPSHOT</version>
</plugin>
</plugins>
</build>
- 在項目的命令行執行
mvn demo-test:goal1，可以看到以下輸出：
[INFO] Scanning for projects...
[INFO]
[INFO] ---------------------< com.example:javafx-spring >----------------------
[INFO] Building javafx-spring 0.0.1-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- demo-test-maven-plugin:1.0-SNAPSHOT:goal1 (default-cli) @ javafx-spring ---
[INFO] This is goal1.
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 0.470 s
[INFO] Finished at: 2021-11-18T17:55:11+08:00
[INFO] ------------------------------------------------------------------------
- 在項目的命令行執行
mvn demo-test:goal2，可以看到以下輸出：
[INFO] Scanning for projects...
[INFO]
[INFO] ---------------------< com.example:javafx-spring >----------------------
[INFO] Building javafx-spring 0.0.1-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- demo-test-maven-plugin:1.0-SNAPSHOT:goal2 (default-cli) @ javafx-spring ---
[INFO] This is goal2.
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 0.540 s
[INFO] Finished at: 2021-11-18T17:57:46+08:00
[INFO] ------------------------------------------------------------------------
至此，我們的Maven插件已經開發完成，達到最開始設定的目的。
附錄1：Maven注解詳解
import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecution;
import org.apache.maven.plugin.descriptor.PluginDescriptor;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Execute;
import org.apache.maven.plugins.annotations.InstantiationStrategy;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProject;
import org.apache.maven.settings.Settings;
// 此Mojo對應的目標的名稱
@Mojo( name = "<goal-name>",
aggregator = <false|true>,
configurator = "<role hint>",
// 執行策略
executionStrategy = "<once-per-session|always>",
inheritByDefault = <true|false>,
// 實例化策略
instantiationStrategy = InstantiationStrategy.<strategy>,
// 如果用戶沒有在POM中明確設置此Mojo綁定到的phase，那么綁定一個MojoExecution到那個phase
defaultPhase = LifecyclePhase.<phase>,
requiresDependencyResolution = ResolutionScope.<scope>,
requiresDependencyCollection = ResolutionScope.<scope>,
// 提示此Mojo需要被直接調用（而非綁定到生命周期階段）
requiresDirectInvocation = <false|true>,
// 提示此Mojo不能在離線模式下運行
requiresOnline = <false|true>,
// 提示此Mojo必須在一個Maven項目內運行
requiresProject = <true|false>,
// 提示此Mojo是否線程安全，線程安全的Mojo支持在並行構建中被並發的調用
threadSafe = <false|true> ) // (since Maven 3.0)
// 何時執行此Mojo
@Execute( goal = "<goal-name>", // 如果提供goal，則隔離執行此Mojo
phase = LifecyclePhase.<phase>, // 在此生命周期階段自動執行此Mojo
lifecycle = "<lifecycle-id>" ) // 在此生命周期中執行此Mojo
public class MyMojo
extends AbstractMojo
{
@Parameter( name = "parameter",
// 在POM中可使用別名來配置參數
alias = "myAlias",
property = "a.property",
defaultValue = "an expression, possibly with ${variables}",
readonly = <false|true>,
required = <false|true> )
private String parameter;
@Component( role = MyComponentExtension.class,
hint = "..." )
private MyComponent component;
@Parameter( defaultValue = "${session}", readonly = true )
private MavenSession session;
@Parameter( defaultValue = "${project}", readonly = true )
private MavenProject project;
@Parameter( defaultValue = "${mojoExecution}", readonly = true )
private MojoExecution mojo;
@Parameter( defaultValue = "${plugin}", readonly = true )
private PluginDescriptor plugin;
@Parameter( defaultValue = "${settings}", readonly = true )
private Settings settings;
@Parameter( defaultValue = "${project.basedir}", readonly = true )
private File basedir;
@Parameter( defaultValue = "${project.build.directory}", readonly = true )
private File target;
public void execute()
{
}
}
參考文章
本文最先發布至微信公眾號，版權所有，禁止轉載！