【Maven】maven 插件開發實戰

来源:https://www.cnblogs.com/kiwifly/archive/2020/03/31/12602407.html
-Advertisement-
Play Games

前言 眾所周知，maven 實質上是一個插件執行框架，所有的工作都是通過插件完成的。包括我們日常使用到的類似 install、clean、deploy、compiler。。。這些命令，其實底層都是一個一個的 maven 插件。 如何開發自己的插件 1. maven 插件的命名規範 在寫一個項目之前， ...


image.png

前言


眾所周知，maven 實質上是一個插件執行框架，所有的工作都是通過插件完成的。包括我們日常使用到的類似 install、clean、deploy、compiler。。。這些命令，其實底層都是一個一個的 maven 插件。

如何開發自己的插件

1. maven 插件的命名規範


在寫一個項目之前，第一件事就是確定一個名稱。maven 插件也不例外。它有著自己的一套命名規範。但是規範很簡單，一句話就可以概括，官方插件命名的格式為 maven-xxx-plugin,非官方的插件命名為 xxx-maven-plugin 。是不是覺得很眼熟，沒錯，spring boot starter 的命名也有類似的規範。


好的，我們的第一個 maven 插件項目就叫 demo-maven-plugin 吧。

2. 創建項目


名稱起好了，下一步就是創建這個項目。如果你使用 idea 的話，那麼創建十分的便捷，按如下步驟即可：

2.1 選擇 org.apache.maven.archetypes:maven-archetype-mojo 為骨架創建項目


image.png

  1. 選擇創建新項目
  2. 選擇通過 maven 創建
  3. 勾選 Create from archetype 通過項目骨架創建
  4. 選擇 org.apache.maven.archetypes:maven-archetype-mojo
  5. 點擊下一步

2.2 輸入在第一步起的項目名


image.png


點擊 Next

2.3 點擊 Finish 完成項目創建


image.png

2.4  分析項目文件

項目結構


image.png

可以看到生成的項目就是我們最最常見的 maven 項目的結構，生成的文件也很少，一個 pom.xml 文件，一個 MyMojo 文件，簡單介紹一下這兩個文件

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/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>cn.coder4j.study.example</groupId>
  <artifactId>demo-maven-plugin</artifactId>
  <packaging>maven-plugin</packaging>
  <version>1.0-SNAPSHOT</version>
  <name>demo-mavne-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>
</project>

首先生成的項目 pom.xml 中，自動依賴了兩個項目，一個是 maven-plugin-api ，這個是開發 maven 插件必須依賴的核心包。另一個是單元測試時使用的 junit 包。這兩個沒什麼要註意的，真正要註意的是這個項目的 packaging，通常我遇到的 packaging 都是 jar、war、pom，這裡比較特殊是 maven-plugin。

MyMojo.java
package cn.coder4j.study.example;

/*
 * Copyright 2001-2005 The Apache Software Foundation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

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
                }
            }
        }
    }
}


首先生成的類繼承了 AbstractMojo 這個抽象類，這裡是 maven 插件的規範要求，maven 插件必須要繼承 AbstractMojo 並實現他的 execute 方法。


另外可以看到類與方法使用了很多 tag。註意是 tag 而不是註解，註解是直接標記的，而 tag 是在文檔註釋裡面的。


其中 @goal 這個 tag 的作用是指定插件的命名，比如我們常用的 mvn clean，這個 clean 就是他的 @goal 。


而 @phase 是綁定插件執行的生成周期，比如你綁定在 clean 這個周期，那你在執行 clean 的時候會自動觸發你的插件。


@parameter 用來指定插件的參數。


小朋友你是否有很多問號？tag 這個東西寫在文檔註釋裡面的東西，方便是方便但是容易寫錯呀，寫錯沒有語法報錯，寫對時候也沒有語法提示，為什麼不直接用註解的形式呢？原因是 java 的註解是 jdk1.5 之後才有的，而實現 maven 的時候還沒有這種語法。所以要一條路走到黑，一直背這個歷史包袱嗎？當然不是，後面我們會說解決辦法。另外，這種寫法雖然不推薦使用了，但是有些 maven 的經典插件由於完成時間比較早，熟悉這些 tag 對於理解代碼也有幫助。

3. 開發插件

3.1 代碼未動，依賴先行 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/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>cn.coder4j.study.example</groupId>
  <artifactId>demo-maven-plugin</artifactId>
  <packaging>maven-plugin</packaging>
  <version>1.0-SNAPSHOT</version>
  <name>demo-mavne-plugin Maven Mojo</name>
  <url>http://maven.apache.org</url>
  <dependencies>
    <dependency>
      <groupId>org.apache.maven</groupId>
      <artifactId>maven-plugin-api</artifactId>
      <version>3.5.2</version>
    </dependency>
    <dependency>
      <groupId>org.apache.maven.plugin-tools</groupId>
      <artifactId>maven-plugin-annotations</artifactId>
      <version>3.5.2</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-plugin-plugin</artifactId>
        <version>3.5.2</version>
      </plugin>
    </plugins>
  </build>
</project>


相較於預設的 pom.xml 文件，我們做瞭如下幾個變動：

  1. 升級 maven-plugin-api 的插件版本到 3.5.2 。原生的 2.0 實在是太老了。
  2. 添加 maven-plugin-annotations 這個依賴，還記得上面說的 tag 的事嗎？有了這個依賴就可以直接使用註解了
  3. 添加 maven-plugin-plugin 插件依賴，添加這個依賴主要是為了在 jdk1.8 能編譯通過，否則會報錯

3.2 DemoMojo.java

/*
 *
 *  * *
 *  *  * blog.coder4j.cn
 *  *  * Copyright (C) 2016-2020 All Rights Reserved.
 *  *
 *
 */
package cn.coder4j.study.example;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;

/**
 * @author buhao
 * @version DemoMojo.java, v 0.1 2020-03-30 22:51 buhao
 */
@Mojo(name = "hello")
public class DemoMojo extends AbstractMojo {

    @Parameter(name = "name", defaultValue = "kiwi")
    private String name;

    public void execute() throws MojoExecutionException, MojoFailureException {
        getLog().info("hello " + name);
    }
}


首先，同生成的類一樣，我們的類必須繼承 AbstractMojo 並實現他的 execute 方法，而 execute 方法其實就是這個插件的入口類。


示例代碼中有兩個很重要的註解，一個是 @Mojo ，它主要用來定義插件相關的信息相當於上面說的 @goal ，其中 name 屬性用來指定這個插件名稱，同 clean 類似。


另外一個重要註解 @Parameter ，則是用來指定插件運行時使用的參數，其中 name 是參數名，defaultValue 顧名思義是預設值，也就是在用戶沒有設置的時候使用的值。


詳細的插件及作用如下：

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()
    {
    }
}


回到示例上了，我們這個插件作用很簡單，根據配置輸出 hello xxx，如果沒有配置就輸出 hello kiwi。我們在寫插件時，當然不會這樣寫，但是通過這個 demo，你就掌握了 maven 插件的大部分知識，可以自己做一些很有趣的插件。

4. 使用插件


首先上面我們的代碼寫完了，必須要 Install 一下，否則別的項目無法直接依賴，如果你還想給其它人使用，那還需上傳到 maven 倉庫。

4.1 依賴插件

    <build>
        <plugins>
            <plugin>
                <groupId>cn.coder4j.study.example</groupId>
                <artifactId>demo-maven-plugin</artifactId>
                <version>1.0-SNAPSHOT</version>
            </plugin>
        </plugins>
    </build>


在我們想使用插件的項目中，添加如上配置，其中 plugin 中使用我們插件的  GAV 信息。

4.2 啟動插件


image.png


如果上面配置的都正確，那麼在 idea 右側的 Maven 中，你配置的項目的 Plugins 下會多了一個 demo（具體根據你插件項目的名稱），而 demo 裡面會有一個 demo:hello，其中這個 demo 對應你插件項目的名稱，而 hello 對應你插件的名稱也就是 @Mojo 中的 name 。


好的，我們雙擊一下，demo:hello ，會輸出如下日誌：


image.png


這樣，我們的第一個 Maven 插件就好了。

4.3 配置參數


可能你還記得，我們在寫 DemoMojo 的時候還指定了一個 name 屬性，並且為它指定了一個 Parameter，這個如何使用。只要在依賴的插件下麵添加 configuration 標簽就可以了。

    <build>
        <plugins>
            <plugin>
                <groupId>cn.coder4j.study.example</groupId>
                <artifactId>demo-maven-plugin</artifactId>
                <version>1.0-SNAPSHOT</version>
                <configuration>
                    <name>tom</name>
                </configuration>
            </plugin>
        </plugins>
    </build>


其中 configuration 標簽內的標簽，對應你定義的參數名稱，而且 idea 還有語法提示，很 nice。


好的，我們再運行一下，結果如下：


image.png


好的，大功告成。

其它

參考鏈接


Maven 插件開發

Maven 插件編寫

項目源碼

因為篇幅有限，無法貼完所有代碼，如遇到問題可到 github 上查看源碼。

關於我

image.png

本文由博客一文多發平臺 OpenWrite 發佈！


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 裝飾者模式和觀察者模式
    一、裝飾者模式 1、裝飾者模式（Decorator Pattern）：指在不改變原有對象的基礎之上，將功能附加到對象上，提供了比繼承更有彈性的替代方案（擴展原有對象的功能）。（屬於結構型模式） 2、適用場景 用於擴展一個類的功能或給一個類增加附加職責 動態的給一個對象添加功能，這些功能可以再動態的撤 ...
  • 關於 webassebmly Blazor RPC 調用
    離開了園子很久很久了 疫情期間，沒有辦法出差，正好當前時間是自己規劃的查漏補缺時間，把缺少的Web模塊的統計分析圖表加進去 Webassembly 老早是聽說了，但由於項目的原因，也一直沒有精力去關註，倒是 netcore3.1期待了很久，雖然最後測試了一下，自己需要的核心介面還沒有添加進去，但是W ...
  • [Redis] 萬字長文帶你總結Redis，助你面試升級打怪
    文章目錄 "Redis的介紹、優缺點、使用場景" Linux中的安裝 常用命令 "Redis各個數據類型及其使用場景" Redis字元串（String） Redis哈希（Hash） Redis列表（List） Redis集合（Set） Redis有序集合（sorted set） "Redis 瑞士軍 ...
  • 實現介面冪等性的幾種方案
    搶微信紅包的時候我們都知道：一個紅包一旦你搶過之後，以後無論你點多少次都是一樣的結果。紅包會提示你已經搶過此紅包，而不會讓你再搶一次。 搶紅包介面就是一個非常典型的冪等介面，搶一次和搶多次具有一樣的效果。類似的介面在我們的開發過程中會有很多，比如在電商的下單過程中： 訂單創建介面,第一次調用返回超時 ...
  • 圖解Java設計模式之觀察者模式
    圖解Java設計模式之觀察者模式 天氣預報項目需求 天氣預報設計方案 1 - 普通方案 觀察者模式（Observer）原理 觀察者模式解決天氣預報需求 觀察者模式在JDK應用的源碼分析 天氣預報項目需求 1）氣象站可以將每天測量到的濕度、溫度、氣壓等等以公告的形式發佈出去（比如發佈到自己的網站或第三 ...
  • Python異常拋出後使用except接收的原因
    首先我們來看一個具有異常拋出功能的程式： def register(): username=input("please input your user name: ") if len(username)<6: raise Exception("the str must be over 6 place ...
  • 項目結構介紹
    通常的項目結構 各個目錄詳細介紹： 然後接下來/src/main/resources目錄，裡面主要存放靜態配置文件和頁面靜態資源等東西： 當然，這地方估計有一個很多人都會糾結的關於DTO/VO/DO等數據模型定義的區分。 這在《阿裡巴巴Java開發手冊》中倒是做了一個所謂的嚴格區分，那本書上是這樣去 ...
  • C 實戰練習題目1
    題目：有1、2、3、4個數字，能組成多少個互不相同且無重覆數字的三位數？都是多少？ 程式分析：可填在百位、十位、個位的數字都是1、2、3、4。組成所有的排列後再去 掉不滿足條件的排列。 實例： 1 #include<stdio.h> 2 3 int main() 4 { 5 int i,j,k; 6 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類