Maven 插件

如果你的項目是基于maven構建，那么在項目的pom文件中，經常會看到這樣的配置DkK28資訊網——每日最新資訊28at.com

<build>    <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>                <encoding>UTF-8</encoding>            </configuration>        </plugin>    </plugins></build>

在上面的代碼中，我們使用了插件maven-compiler-plugin，這個插件的作用是將編寫的java代碼編譯成指定的版本與編碼的class文件。DkK28資訊網——每日最新資訊28at.com

Maven插件的組成

• goal

maven中的插件是有很多目標(goal)組成的，開發插件，實際上就是去編寫插件中目標的具體代碼。每個目標對應一個java類，這個類在maven中叫做MOJO，maven提供了一個Mojo的接口，我們開發插件也就是去實現這個接口DkK28資訊網——每日最新資訊28at.com

org.apache.maven.plugin.Mojo

通過goal我們可以定義插件在maven哪個生命周期中執行，比如上面的maven-compiler-plugin在compile階段執行。DkK28資訊網——每日最新資訊28at.com

• configuration

插件執行階段，我們可以通過配置定義各種參數，這樣就能根據不同參數按需求執行插件，比如上面的maven-compiler-plugin中，在configuration 下的配置DkK28資訊網——每日最新資訊28at.com

<configuration>    <source>1.8</source>    <target>1.8</target>    <encoding>UTF-8</encoding></configuration>

maven-compiler-plugin的配置信息中，source和target屬性指定了編譯的java版本，encoding屬性指定了編譯結果的編碼。DkK28資訊網——每日最新資訊28at.com

Maven插件的分類

Maven插件分為兩種：DkK28資訊網——每日最新資訊28at.com

• 核心插件：Maven自帶的插件，如maven-compiler-plugin，maven-surefire-plugin等。
• 非核心插件：第三方開發的插件，如sonar-maven-plugin，pmd-maven-plugin等。

插件的生命周期

Maven插件的生命周期分為三個階段：DkK28資訊網——每日最新資訊28at.com

• 初始化階段：在這個階段，Maven會將插件的配置信息加載到一個org.apache.maven.plugin.Plugin對象中，這個對象中包含了插件的配置信息，如插件的id，version，dependencies等。
• 執行階段：在這個階段，Maven會調用插件的execute()方法，這個方法就是插件的核心，這個方法的執行是有順序的，先執行initialize()方法，然后執行execute()方法
• 銷毀階段：在這個階段，Maven會調用插件的cleanup()方法，這個方法的執行是無順序的，先執行execute()方法，然后執行cleanup()方法。

Maven插件的執行

Maven插件的執行分為兩種：DkK28資訊網——每日最新資訊28at.com

• 手動執行：在命令行中，使用mvn插件的id，如mvn compiler:compile，這個命令會先執行插件的初始化階段，然后執行插件的執行階段，最后執行插件的銷毀階段。
• 自動執行：在pom.xml文件中配置插件的執行，如maven-compiler-plugin，這個配置會先執行插件的初始化階段，然后執行插件的執行階段，最后執行插件的銷銷毀階段。

比如基于idea時，我們可以在Maven工具欄，通過Lifecycle菜單中，選擇相應的生命周期函數，然后點擊Run按鈕，即可執行插件。比如插件配置的在compile階段執行，那么配置在compile對應的goal都會觸發。DkK28資訊網——每日最新資訊28at.com

同樣我們可以直接通過mvn命令調用插件，這樣插件就不需要依賴于maven的生命周期函數取執行了。DkK28資訊網——每日最新資訊28at.com

// mvn groupId:artifactId:goal -Dprop=valuemvn com.sucls.blog:build-maven-plugin:printDate -Dname=XX

如何寫一個Maven插件？DkK28資訊網——每日最新資訊28at.com

下面通過一個簡單的示例來演示如何寫一個Maven插件。DkK28資訊網——每日最新資訊28at.com

1. 創建一個maven項目
2. 添加相關依賴

<dependencies>        <dependency>            <groupId>org.apache.maven</groupId>            <artifactId>maven-plugin-api</artifactId>            <version>${maven-plugin-api.version}</version>        </dependency>        <dependency>            <groupId>org.apache.maven.plugin-tools</groupId>            <artifactId>maven-plugin-annotations</artifactId>            <version>${maven-plugin-annotations.version}</version>            <scope>provided</scope>        </dependency>    </dependencies>

3. 編寫插件代碼

@Mojo(name = "printDate")public class PrintDatePlugin extends AbstractMojo {    @Parameter(property = "name",defaultValue = "printDate")    private String name;    @Parameter(property = "description",defaultValue = "打印日期插件")    private String description;    @Parameter(property = "format",defaultValue = "yyyy-MM-dd HH:mm:ss")    private String format;    @Override    public void execute() throws MojoExecutionException, MojoFailureException {        Date date = new Date();        Log log = getLog();        log.info(StringUtils.repeat("=",20));        log.info(String.format("開始執行插件：%s", name));        log.info(String.format("插件信息：%s", description));        log.info(String.format("執行插件：%s", DateFormatUtils.format(date,format)));        log.info(StringUtils.repeat("=",20));    }}

4. 打包插件

// 執行下面的命令 或者通過 idea中maven工具欄的package直接打包mvn clean package

5. 使用插件 創建一個新的項目，在pom.xml中添加插件的配置信息

<build>    <plugins>      <plugin>        <groupId>com.sucls.blog</groupId>        <artifactId>build-maven-plugin</artifactId>        <version>${project.version}</version>        <executions>          <execution>            <id>print-date</id>            <phase>compile</phase>            <goals>              <goal>printDate</goal>            </goals>            <configuration>              <name>PD</name>              <format>yyyy-MM-dd</format>            </configuration>          </execution>        </executions>      </plugin>    </plugins>  </build>

6. 執行插件

mvn clean complie

觀察控制臺可以看到這樣的信息：DkK28資訊網——每日最新資訊28at.com

[INFO] --- build-maven-plugin:1.0-SNAPSHOT:printDate (print-date) @ build-maven-plugin ---[INFO] [INFO] ===============[INFO] 開始執行插件：PD[INFO] 插件信息：打印日期插件[INFO] 執行插件：2023-12-05[INFO] ===============

上面的示例中，主要做了下面的事情：DkK28資訊網——每日最新資訊28at.com

1. 定義了一個打印日期的插件 也就是一個maven項目
2. 為插件定義goal 一個goal也就是一個org.apache.maven.plugin.Mojo類，通過@Mojo注解，定義了插件的名稱和goal，一個插件中可以包含多個goal，在配置時同樣可以對應多個
3. 為插件添加參數 在每一個Mojo中，通過@Parameter定義插件相關參數，這樣在插件執行階段即可通過參數完成對應邏輯
4. 在其他項目中引入插件 在pom文件中，像其他插件一樣通過groupId:artifactId:version引入自己定義的插件，配置maven的哪個生命周期階段執行插件的goal，以及插件的參數。
5. 使用插件 maven生命周期中，各個階段都會找到所關聯的插件并執行。

結束語

通過maven插件，可以根據我們的項目，定義一些重復，但耗時的編碼工作，通過插件的形式，可以自動化完成這些工作，從而提高開發效率。DkK28資訊網——每日最新資訊28at.com

DkK28資訊網——每日最新資訊28at.com

本文鏈接：http://www.tebozhan.com/showinfo-26-44413-0.html怎么寫一個Maven插件來提升生產效率？

聲明：本網頁內容旨在傳播知識，若有侵權等問題請及時與本網聯系，我們將在第一時間刪除處理。郵件：2376512515@qq.com

上一篇： 讓 Java 程序運行更快的 15 個技巧，肯定有你不知道的

下一篇： 手把手教你IDEA進行遠程Debug調試的來龍去脈