1. 程式人生 > >pom檔案中maven-assembly-plugin外掛學習

pom檔案中maven-assembly-plugin外掛學習

一、使用場景

如果專案是微服務架構,可能用到這個外掛的概率比較高,平時普通的專案不需要這樣的實現方式。

如果專案內的一部分通用功能,不需要挨個引用,則需要將通用功能部分達成jar包。

二、Maven-assembly-plugin作用 1、作用:要想將寫的程式和它本身所依賴的jar包一起build到一個包裡,是maven中針對打包任務而提供的標準外掛。

2、其他作用:

1)提供一個把工程依賴元素、模組、網站文件等其他檔案存放到單個歸檔檔案裡。

2)打包成指定格式分發包,支援各種主流的格式如zip、tar.gz、jar和war等,具體打包哪些檔案是高度可控的。

3)能夠自定義包含/排除指定的目錄或檔案。

三、總體來說,實現外掛maven-assembly-plugin需要兩個步驟:

第1步驟:pom.xml檔案裡配置maven-assembly-plugin,指定描述檔案

第2步驟:描述檔案配置具體引數

對應步驟1 ------> 專案中pom.xml的配置如下:

<?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/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
 
	<groupId>com.study</groupId>
	<artifactId>center</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>
 
	<build>
		<plugins>
			<plugin>
				<artifactId>maven-assembly-plugin</artifactId>
				<configuration>
					<appendAssemblyId>false</appendAssemblyId>
					<descriptors>
						<descriptor>src/main/assembly/package.xml</descriptor>
					</descriptors>
				</configuration>
				<executions>
					<execution>
						<id>make-assembly</id>
						<phase>package</phase>
						<goals>
							<goal>single</goal>
						</goals>
					</execution>
				</executions>
			</plugin>
		</plugins>
	</build>
</project>

單行解釋如下:

<plugin>
   <artifactId>maven-assembly-plugin</artifactId> <!--外掛引用-->
   <configuration>
      <appendAssemblyId>false</appendAssemblyId>
      <descriptors>  <!--描述檔案路徑-->
         <descriptor>src/main/assembly/package.xml</descriptor> 
      </descriptors>

   </configuration>
   <executions>
      <execution>
         <id>make-assembly</id>  <!--名字任意 -->
         <phase>package</phase>  <!-- 繫結到package生命週期階段上 -->
         <goals>
            <goal>single</goal>  <!-- 只執行一次 --> 
         </goals>
      </execution>
   </executions>
</plugin>

對應步驟2 ------> 這樣配置後,在專案的對應路徑下,找到package.xml檔案(描述檔案)(我在eclipse中是新建的package.xml檔案)

package.xml檔案(描述檔案)內容如下:

<?xml version="1.0" encoding="UTF-8"?>
<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3 http://maven.apache.org/xsd/assembly-1.1.3.xsd">
    <id>package</id>
    <formats>
        <format>dir</format>
    </formats>
    <includeBaseDirectory>true</includeBaseDirectory>
    <fileSets>
        <fileSet>
            <directory>src/main/resources</directory>
            <outputDirectory>/config</outputDirectory>
        </fileSet>
        <fileSet>
            <directory>src/main/bin</directory>
            <outputDirectory>/</outputDirectory>
        </fileSet>
        <fileSet>
            <directory>${project.build.directory}</directory>
            <outputDirectory>/</outputDirectory>
            <includes>
                <include>*.jar</include>
            </includes>
        </fileSet>
    </fileSets>
    <dependencySets>
        <dependencySet>
            <outputDirectory>lib</outputDirectory>
            <scope>runtime</scope>
            <excludes>
                <exclude>${groupId}:${artifactId}</exclude>
            </excludes>
        </dependencySet>
    </dependencySets>
</assembly>

描述符檔案說明:

1、ID

id 識別符號,新增到生成檔名稱的字尾符。如果指定 id 的話,目標檔案則是 ${artifactId}-${id}.tar.gz

<id>package</id>

2、formats

maven-assembly-plugin 支援的打包格式有zip、tar、tar.gz (or tgz)、tar.bz2 (or tbz2)、jar、dir、war,可以同時指定多個打包格式

<formats>
    <format>dir</format>
    ...可配置多個
</formats>

3、dependencySets

用來定製工程依賴 jar 包的打包方式,核心元素如下:

元素 型別 作用
outputDirectory String 指定包依賴目錄,該目錄是相對於根目錄
includes/include* List<String> 包含依賴
excludes/exclude* List<String> 排除依賴
<dependencySets>
    <dependencySet>
        <outputDirectory>lib</outputDirectory>
        <scope>runtime</scope>
        <excludes>
            <exclude>${groupId}:${artifactId}</exclude>
        </excludes>
    </dependencySet>
</dependencySets>

4、fileSets

管理一組檔案的存放位置,核心元素如下:

元素 型別 作用
outputDirectory String 指定包依賴目錄,該目錄是相對於根目錄
includes/include* List<String> 包含依賴
excludes/exclude* List<String> 排除依賴
<fileSets>
    <fileSet>
        <directory>src/main/resources</directory>
        <outputDirectory>/config</outputDirectory><!--resource檔案輸出路徑-->
    </fileSet>
    <fileSet>
        <directory>src/main/bin</directory>
        <outputDirectory>/</outputDirectory>  <!--bin目錄檔案輸出路徑-->
    </fileSet>
    <fileSet>
        <directory>${project.build.directory}</directory> <!--jar檔案輸出路徑-->
        <outputDirectory>/</outputDirectory>
        <includes>
            <include>*.jar</include>
        </includes>
    </fileSet>
</fileSets>

三、找到生成的包

實現了上述兩步之後,在專案路徑/target目錄下,有jar包如下:

開啟center-0.0.1-SNAPSHOT檔案,輸出格式符合描述檔案內的配置。如下: