maven 包管理平臺-07-plugins 常見外掛介紹

老马啸西风發表於2024-03-04
MavenPlugin

擴充閱讀

maven 包管理平臺-01-maven 入門介紹 + Maven、Gradle、Ant、Ivy、Bazel 和 SBT 的詳細對比表格

maven 包管理平臺-02-windows 安裝配置 + mac 安裝配置

maven 包管理平臺-03-maven project maven 專案的建立入門

maven 包管理平臺-04-maven archetype 專案原型

maven 包管理平臺-05-multi module 多模組

maven 包管理平臺-06-常用技巧 實時更新快照/亂碼問題/下載很慢/包依賴解決包衝突/如何匯入本地 jar

maven 包管理平臺-07-plugins 常見外掛介紹

maven 包管理平臺-08-nexus 自己搭建 maven 倉庫

maven 外掛

Maven 在其核心是一個外掛執行框架；所有工作都由外掛完成。

尋找要執行的特定目標嗎？此頁面列出了核心外掛和其他外掛。

有構建和報告外掛：

  • 構建（Build） 外掛將在構建過程中執行，它們應該在 POM 中的 <build/> 元素中進行配置。

  • 報告（Reporting） 外掛將在站點生成期間執行，它們應該在 POM 中的 <reporting/> 元素中進行配置。因為報告外掛的結果是生成站點的一部分，所以報告外掛應該同時進行國際化和本地化。您可以閱讀更多關於外掛本地化的資訊以及您可以如何幫助的內容。

Maven 外掛

核心外掛

這些外掛對應於預設的核心階段（即 clean，compile 等）。

它們也可能有多個目標。

compiler

編譯 Java 原始碼。

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>${maven-compiler-plugin.version}</version>
    <configuration>
        <source>1.8</source>
        <target>1.8</target>
    </configuration>
</plugin>

surefire

在隔離的類載入器中執行 JUnit 單元測試。

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <version>${maven-surefire-plugin.version}</version>
    <configuration>
        <skipTests>true</skipTests>
        <testFailureIgnore>true</testFailureIgnore>
    </configuration>
</plugin>

報告外掛

生成報告的外掛，在 POM 中配置為報告，並在站點生成生命週期下執行。

javadoc

為專案生成 Javadoc 文件。

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.9.1</version>


    <configuration>
        <!--maven 多模組-->
        <aggregate>true</aggregate>

        <!--路徑-->
        <reportOutputDirectory>../doc</reportOutputDirectory>
        <!--目錄-->
        <destDir>myapidocs</destDir>

        <!--IOS ERROR: Unable to find javadoc command: The environment variable JAVA_HOME is not correctly set.-->
        <javadocExecutable>${java.home}/../bin/javadoc</javadocExecutable>


        <!--自定義標籤-->
        <tags>
            <tag>
                <!--name為你Java程式碼中的註解的名字-->
                <name>Description</name>
                <!--事實上這個就是說你要把哪些（方法、欄位、類）上面的註解放到JavaDoc中-->
                <placement>a</placement>
                <!--head。假設不寫這個，用的就是name，假設寫了，那麼顯示效果例如以下：-->
                <head>用途</head>
            </tag>
        </tags>
    </configuration>

</plugin>

其他

許多其他專案提供了它們自己的 Maven 外掛。

tomcat7

執行 Apache Tomcat 容器以進行快速 Web 應用程式開發。

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.tomcat.maven</groupId>
            <artifactId>tomcat7-maven-plugin</artifactId>
            <version>${plugin.tomcat.version}</version>
            <configuration>
                <port>8081</port>
                <path>/</path>
                <uriEncoding>${project.build.sourceEncoding}</uriEncoding>
            </configuration>
        </plugin>
    </plugins>
</build>

Versions

versions-plugin zh_CN

mvn versions:set -DnewVersion=1.0.1-SNAPSHOT
  • commit
mvn versions:commit
  • revert
mvn versions:revert

正確修改方法:

(1) 修改父類

mvn versions:set -DgroupId=com.framework -DartifactId=framework* -DoldVersion=* -DnewVersion=1.0.2-SNAPSHOT

(2) 修改子類

mvn -N versions:update-child-modules

Auto-Config

Auto-Config

簡單案例

Import in maven

<?xml version="1.0" encoding="UTF-8"?>
<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">
    <properties>
        <!-- 定義autoconfig的版本，建議將此行寫在parent pom.xml中。 -->
        <autoconfig-plugin-version>1.2</autoconfig-plugin-version>
    </properties>
    <build>
        <plugins>
            <plugin>
                <groupId>com.alibaba.citrus.tool</groupId>
                <artifactId>autoconfig-maven-plugin</artifactId>
                <version>${autoconfig-plugin-version}</version>
                <configuration>
                    <!-- 要進行AutoConfig的目標檔案，預設為${project.artifact.file}。
                    <dest>${project.artifact.file}</dest>
                    -->
                    <!-- 配置後，是否展開目標檔案，預設為false，不展開。
                    <exploding>true</exploding>
                    -->
                    <!-- 展開到指定目錄，預設為${project.build.directory}/${project.build.finalName}。
                    <explodedDirectory>
                        ${project.build.directory}/${project.build.finalName}
                    </explodedDirectory>
                    -->
                </configuration>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>autoconfig</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

跳過執行

$   mvn install –Dautoconfig.skip
  • 想使用配置檔案

(1) 直接將生成的配置檔案 antx.properties 視為配置檔案使用。放在本地。
(2) 打成war包之後可以自動屬性替換掉。

1、 maven war struct:

war-project（源目錄結構）               -> war-project.war（目標目錄結構）
 │  pom.xml
 │
 └─src
     └─main
         ├─java
         ├─resources                    -> /WEB-INF/classes
         │      file1.xml                      file1.xml
         │      file2.xml                      file2.xml
         │
         └─webapp                       -> /
             ├─META-INF                 -> /META-INF
             │  └─autoconf              -> /META-INF/autoconf
             │        auto-config.xml          auto-config.xml
             │
             └─WEB-INF                  -> /WEB-INF
                   web.xml                     web.xml
                   file3.xml                   file3.xml

  • /META-INF/autoconf 目錄用來存放AutoConfig的描述檔案，以及可選的模板檔案。

  • auto-config.xml 是用來指導AutoConfig行為的關鍵描述檔案。

2、 maven jar struct

jar-project（源目錄結構）               -> jar-project.jar（目標目錄結構）
 │  pom.xml
 │
 └─src
     └─main
         ├─java
         └─resources                    -> /
             │  file1.xml                      file1.xml
             │  file2.xml                      file2.xml
             │
             └─META-INF                 -> /META-INF
                 └─autoconf             -> /META-INF/autoconf
                       auto-config.xml         auto-config.xml

3、Common directory

directory
 │  file1.xml
 │  file2.xml
 │
 └─conf
       auto-config.xml

auto-config

<?xml version="1.0" encoding="UTF-8"?>
<config>
    <group>

        <property name="petstore.work"
                    description="應用程式的工作目錄" />

        <property name="petstore.loggingRoot"
                    defaultValue="${petstore.work}/logs"
                    description="日誌檔案目錄" />

        <property name="petstore.upload"
                    defaultValue="${petstore.work}/upload"
                    description="上傳檔案的目錄" />

        <property name="petstore.loggingLevel"
                    defaultValue="warn"
                    description="日誌檔案級別">

            <validator name="choice"
                         choice="trace, debug, info, warn, error" />

        </property>

    </group>
    <script>
        <generate template="WEB-INF/web.xml" />
        <generate template="WEB-INF/common/resources.xml" />
    </script>
</config>

完整的properties

<property
    name="..."
    [defaultValue="..."]
    [description="..."]
    [required="true|false"]
>
    <validator name="..." />
    <validator name="..." />
    ...
</property>

生成配置檔案的指令

<generate
    template="..."
    [destfile="..."]
    [charset="..."]
    [outputCharset="..."]
>

auto-config 命令

$ autoconfig
Detected system charset encoding: UTF-8
If your can't read the following text, specify correct one like this:
  autoconfig -c mycharset

使用方法：autoconfig [可選引數] [目錄名|包檔名]

可選引數：
 -c,--charset                輸入/輸出編碼字符集
 -d,--include-descriptors
                             包含哪些配置描述檔案，例如：conf/auto-config.xml，可使用*、**、?萬用字元，如有多項，用逗號分隔
 -D,--exclude-descriptors    排除哪些配置描述檔案，可使用*、**、?萬用字元，如有多項，用逗號分隔
 -g,--gui                    圖形使用者介面（互動模式）
 -h,--help                   顯示幫助資訊
 -i,--interactive            互動模式：auto|on|off，預設為auto，無參數列示on
 -I,--non-interactive        非互動模式，相當於--interactive=off
 -n,--shared-props-name      共享的屬性檔案的名稱
 -o,--output                 輸出檔名或目錄名
 -P,--exclude-packages       排除哪些打包檔案，可使用*、**、?萬用字元，如有多項，用逗號分隔
 -p,--include-packages
                             包含哪些打包檔案，例如：target/*.war，可使用*、**、?萬用字元，如有多項，用逗號分隔
 -s,--shared-props           共享的屬性檔案URL列表，以逗號分隔
 -T,--type                   檔案型別，例如：war, jar, ear等
 -t,--text                   文字使用者介面（互動模式）
 -u,--userprop               使用者屬性檔案
 -v,--verbose                顯示更多資訊

可執行 jar

  • xml 引入
<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-assembly-plugin</artifactId>
	<version>2.5.5</version>
	<configuration>
		<archive>
			<manifest>
				<mainClass>com.xxg.Main</mainClass>
			</manifest>
		</archive>
		<descriptorRefs>
			<descriptorRef>jar-with-dependencies</descriptorRef>
		</descriptorRefs>
	</configuration>
	<executions>
		<execution>
			<id>make-assembly</id>
			<phase>package</phase>
			<goals>
				<goal>single</goal>
			</goals>
		</execution>
	</executions>
</plugin>
  • 命令列執行
$   mvn package

本文由部落格一文多發平臺 OpenWrite 釋出！

相關文章