Maven學習(五) - 插件maven-assembly-plugin

Assembly插件主要是聚合項目的輸出，好比依賴，模塊以及其餘文件。通俗的來講，就是將項目內容按照必定規則及指定格式從新組合並輸出。它支持的輸出格式有多種：

• jar jar包
• war war包
• dir 文件目錄
• zip zip壓縮包
• tar tar壓縮包
• tar.gz
• tar.bz2
• tar.xz

爲何須要Assembly插件呢？由於對於服務類型的後臺程序，線上運行時通常經過腳本的方式啓動和中止，而項目中的目錄結構複雜且不夠直觀，且項目文件也須要合併和過濾，Assembly插件就能夠幫助咱們完成。

Assembly使用

使用Assembly插件須要在pom.xml中加入如下配置

<plugin>
	<artifactId>maven-assembly-plugin</artifactId>
	<version>3.1.0</version>
	<configuration>
		<descriptors>
			<descriptor>src/main/assembly/assembly.xml</descriptor>
		</descriptors>
	</configuration>
	<executions>
		<execution>
			<id>make-assembly</id>
			<phase>package</phase>
			<goals>
				<goal>single</goal>
			</goals>
		</execution>
	</executions>
</plugin>

Assembly插件通常綁定的階段爲package，主要的插件目標就是assembly:single。在<configuration>的<descriptor>中指定assembly組裝規則的XML。

如今咱們的項目目錄以下

+ src
    + main
        + java
        + resources
            + jdbc.properties
        + bin
            + start.sh
            + stop.sh
        + assembly
            + assembly.xml

最終咱們想要生成的目錄以下

+ bin
    start.sh
    stop.sh
+ conf
    jdbc.properties
+ lib(依賴jar包目錄)
    xxx.jar

同時但願能輸出成zip格式，那麼assembly.xml的配置以下

<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0 http://maven.apache.org/xsd/assembly-2.0.0.xsd">
  <id>distribution</id>
  <!-- 輸出格式 -->
  <formats>
    <format>jar</format>
    <format>zip</format>
  </formats>
  <!-- 指定文件組的組裝方式 -->
  <fileSets>
  	<!-- 將項目中src/main/bin目錄下的腳本文件copy到target目錄的bin目錄下 -->
    <fileSet>
      <directory>src/main/bin</directory>
      <outputDirectory>bin</outputDirectory>
    </fileSet>
    <!-- 將項目中src/main/resources目錄下的資源文件copy到target目錄的conf目錄下 -->
    <fileSet>
      <directory>src/main/resources</directory>
      <outputDirectory>conf</outputDirectory>
      <!-- 過濾資源文件，對其中的maven變量進行復制 -->
	  <filtered>true</filtered>
    </fileSet>
  </fileSets>
  <!-- 指定依賴jar包輸出的目錄 -->
  <dependencySets>
  	<dependencySet>
  		<useProjectArtifact>true</useProjectArtifact>
  		<outputDirectory>lib</outputDirectory>
  		<!-- 只包含runtime做用域的依賴 -->
  		<scope>runtime</scope>
  	</dependencySet>
  </dependencySets>
</assembly>

命令行執行

mvn clean package

項目的target目錄下會生成兩個文件

• xxx-distribution.jar
• xxx-distribution.zip

xxx是項目的finalName-version，而distribution後綴是默認加上assembly.xml中的id，若是不想要這個後綴，能夠在pom.xml的插件的<configuration>中設置appendAssemblyId爲false

<configuration>
	<appendAssemblyId>false</appendAssemblyId>
	<descriptors>
		<descriptor>src/main/assembly/assembly.xml</descriptor>
	</descriptors>
</configuration>

若是有另外的變量屬性文件，也能夠在<configuration>中配置

<configuration>
	<appendAssemblyId>false</appendAssemblyId>
	<filters>
		<filter>src/main/filter/filter.properties</filter>
	</filters>
	<descriptors>
		<descriptor>src/main/assembly/assembly.xml</descriptor>
	</descriptors>
</configuration>

assembly.xml中的更多配置見http://maven.apache.org/plugins/maven-assembly-plugin/assembly.html

pom文件中插件的更多配置見http://maven.apache.org/plugins/maven-assembly-plugin/single-mojo.html

includes/excludes

在<fileSet>中可使用includes/excludes進行細粒度的控制，此控制對<filtered>也生效

<fileSet>
	<directory>src/main/resources</directory>
	<outputDirectory>conf</outputDirectory>
	<filtered>true</filtered>
	<excludes>
		<exclude>some/path1</exclude>
	</excludes>
</fileSet>
<fileSet>
	<directory>src/main/resources</directory>
	<outputDirectory>conf</outputDirectory>
	<filtered>false</filtered>
	<includes>
		<include>some/path2</include>
	</includes>
</fileSet>

第一個<fileSet>將src/main/resources輸出到target/conf，而且過濾變量屬性，可是排除some/path1的文件。第二個<fileSet>將src/main/resources下的some/path2輸出到target/conf，但不過濾變量屬性。

建立可執行的jar

默認狀況下，經過mvn package生成的jar包中由於沒有指定Main-Class屬性，所以並不能使用-jar配置直接運行。Assembly插件支持<archive>元素(maven-archive)配置Main-Class。

<configuration>
	<archive>
		<manifest>
			<mainClass>com.lcifn.maven.Application</mainClass>
		</manifest>
	</archive>
</configuration>

再執行命令

mvn clean package

新生成的jar包中的META-INF/MANIFEST.MF中就包含了Main-Class屬性

使用containerDescriptorHandlers合併文件

Assembly插件支持經常使用的文件合併功能，特別是META-INF下的services文件或spirng文件(spring.handlers和spring.schemas)。

metaInf-services

聚合全部的META-INF/services文件合併成一個文件

<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0 http://maven.apache.org/xsd/assembly-2.0.0.xsd">
  ....
  <containerDescriptorHandlers>
    <containerDescriptorHandler>
      <handlerName>metaInf-services</handlerName>
    </containerDescriptorHandler>
  </containerDescriptorHandlers>
</assembly>

metaInf-spring

聚合全部的**META-INF/spring.**文件合併成一個文件

<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0 http://maven.apache.org/xsd/assembly-2.0.0.xsd">
  ....
  <containerDescriptorHandlers>
    <containerDescriptorHandler>
      <handlerName>metaInf-spring</handlerName>
    </containerDescriptorHandler>
  </containerDescriptorHandlers>
</assembly>

file-aggregator

也能夠給定正則表達式匹配文件合併成一個文件，如下匹配全部file.txt而後合併成一個file.txt

<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0 http://maven.apache.org/xsd/assembly-2.0.0.xsd">
  ....
  <containerDescriptorHandlers>
    <containerDescriptorHandler>
      <handlerName>file-aggregator</handlerName>
      <configuration>
        <filePattern>.*/file.txt</filePattern>
        <outputPath>file.txt</outputPath>
      </configuration>
    </containerDescriptorHandler>
  </containerDescriptorHandlers>
</assembly>

參考文檔：

1. http://maven.apache.org/plugins/maven-assembly-plugin/index.html