maven-assembly-plugin 入門指南

當你使用 Maven 對項目打包時,你需要了解以下 3 個打包 plugin芥炭,它們分別是

plugin function
maven-jar-plugin maven 默認打包插件,用來創(chuàng)建 project jar
maven-shade-plugin 用來打可執(zhí)行包恃慧,executable(fat) jar
maven-assembly-plugin 支持定制化打包方式园蝠,例如 apache 項目的打包方式

下面我們就簡單介紹一下 maven-assembly-plugin。

使用方法

  • 使用 descriptorRefs(官方提供的定制化打包方式)痢士,官方提供的 descriptorRef 有 bin, jar-with-dependencies, src, project彪薛。【不建議使用】
<project>
  [...]
  <build>
    [...]
    <plugins>
      <plugin>
        <!-- NOTE: We don't need a groupId specification because the group is
             org.apache.maven.plugins ...which is assumed by default.
         -->
        <artifactId>maven-assembly-plugin</artifactId>
        <version>3.0.0</version>
        <configuration>
          <descriptorRefs>
            <descriptorRef>jar-with-dependencies</descriptorRef>
          </descriptorRefs>
        </configuration>
        [...]
</project>

  • 使用 descriptors怠蹂,指定打包文件 src/assembly/src.xml善延,在該配置文件內(nèi)指定打包操作。
<project>
  [...]
  <build>
    [...]
    <plugins>
      <plugin>
        <artifactId>maven-assembly-plugin</artifactId>
        <version>3.0.0</version>
        <configuration>
          <descriptors>
            <descriptor>src/assembly/src.xml</descriptor>
          </descriptors>
        </configuration>
        [...]
</project>

描述符文件元素

id

<id>release</id>

id 標識符城侧,添加到生成文件名稱的后綴符易遣。如果指定 id 的話,目標文件則是 {artifactId}-{id}.tar.gz

formats

maven-assembly-plugin 支持的打包格式有zip嫌佑、tar豆茫、tar.gz (or tgz)、tar.bz2 (or tbz2)屋摇、jar揩魂、dir、war摊册,可以同時指定多個打包格式

  <formats>
    <format>tar.gz</format>
    <format>dir</format>
  </formats>

dependencySets

用來定制工程依賴 jar 包的打包方式肤京,核心元素如下表所示颊艳。

元素 類型 作用
outputDirectory String 指定包依賴目錄茅特,該目錄是相對于根目錄
includes/include* List<String> 包含依賴
excludes/exclude* List<String> 排除依賴
<dependencySets>
    <dependencySet>
      <outputDirectory>/lib</outputDirectory>
    </dependencySet>
  </dependencySets>

fileSets

管理一組文件的存放位置,核心元素如下表所示棋枕。

元素 類型 作用
outputDirectory String 指定文件集合的輸出目錄白修,該目錄是相對于根目錄
includes/include* List<String> 包含文件
excludes/exclude* List<String> 排除文件
fileMode String 指定文件屬性,使用八進制表達重斑,分別為(User)(Group)(Other)所屬屬性兵睛,默認為 0644
  <fileSets>
    <fileSet>
      <includes>
        <include>bin/**</include>
      </includes>
      <fileMode>0755</fileMode>
    </fileSet>

    <fileSet>
      <includes>
        <include>/conf/**</include>
        <include>logs</include>
      </includes>
    </fileSet>

  </fileSets>

files

可以指定目的文件名到指定目錄,其他和 fileSets 相同窥浪,核心元素如下表所示祖很。

元素 類型 作用
source String 源文件,相對路徑或絕對路徑
outputDirectory String 輸出目錄
destName String 目標文件名
fileMode String 設置文件 UNIX 屬性
 <files>
    <file>
      <source>README.txt</source>
      <outputDirectory>/</outputDirectory>
    </file>
  </files>

樣例

工程目錄結(jié)構

scribe-log4j2-test

pom.xml

<build>
  <finalName>scribe-log4j2-test</finalName>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-compiler-plugin</artifactId>
    </plugin>

    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-assembly-plugin</artifactId>
      <configuration>
        <descriptors>
          <descriptor>src/main/assembly/release.xml</descriptor>
        </descriptors>
      </configuration>

      <executions>
        <execution>
          <id>make-assembly</id> <!-- this is used for inheritance merges -->
          <phase>package</phase> <!-- bind to the packaging phase -->
          <goals>
            <goal>single</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

release.xml

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

  <formats>
    <format>tar.gz</format>
    <format>dir</format>
  </formats>

  <dependencySets>
    <dependencySet>
      <outputDirectory>/lib</outputDirectory>
    </dependencySet>
  </dependencySets>

  <fileSets>
    <fileSet>
      <includes>
        <include>bin/**</include>
      </includes>
      <fileMode>0755</fileMode>
    </fileSet>

    <fileSet>
      <includes>
        <include>/conf/**</include>
        <include>logs</include>
      </includes>
    </fileSet>

  </fileSets>

  <files>
    <file>
      <source>README.txt</source>
      <outputDirectory>/</outputDirectory>
    </file>
  </files>

</assembly>

最終創(chuàng)建生成可執(zhí)行二進制工程

參考

maven 入門指南
maven 生命周期
Maven 默認插件以及功能
maven 依賴管理
maven-shade-plugin 入門指南
maven-assembly-plugin

最后編輯于
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末漾脂,一起剝皮案震驚了整個濱河市假颇,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌骨稿,老刑警劉巖笨鸡,帶你破解...
    沈念sama閱讀 206,126評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件姜钳,死亡現(xiàn)場離奇詭異,居然都是意外死亡形耗,警方通過查閱死者的電腦和手機哥桥,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,254評論 2 382
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來激涤,“玉大人拟糕,你說我怎么就攤上這事∥羝冢” “怎么了已卸?”我有些...
    開封第一講書人閱讀 152,445評論 0 341
  • 文/不壞的土叔 我叫張陵,是天一觀的道長硼一。 經(jīng)常有香客問我累澡,道長,這世上最難降的妖魔是什么般贼? 我笑而不...
    開封第一講書人閱讀 55,185評論 1 278
  • 正文 為了忘掉前任愧哟,我火速辦了婚禮,結(jié)果婚禮上肥矢,老公的妹妹穿的比我還像新娘灭抑。我一直安慰自己,他們只是感情好庆冕,可當我...
    茶點故事閱讀 64,178評論 5 371
  • 文/花漫 我一把揭開白布力九。 她就那樣靜靜地躺著,像睡著了一般棕兼。 火紅的嫁衣襯著肌膚如雪灾炭。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 48,970評論 1 284
  • 那天只泼,我揣著相機與錄音,去河邊找鬼。 笑死孽惰,一個胖子當著我的面吹牛库说,可吹牛的內(nèi)容都是我干的字管。 我是一名探鬼主播抽活,決...
    沈念sama閱讀 38,276評論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼誉尖!你這毒婦竟也來了没咙?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 36,927評論 0 259
  • 序言:老撾萬榮一對情侶失蹤捉捅,失蹤者是張志新(化名)和其女友劉穎无牵,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體谭溉,經(jīng)...
    沈念sama閱讀 43,400評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 35,883評論 2 323
  • 正文 我和宋清朗相戀三年粘茄,在試婚紗的時候發(fā)現(xiàn)自己被綠了吠架。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 37,997評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡俱诸,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出出吹,到底是詐尸還是另有隱情巍耗,我是刑警寧澤驯耻,帶...
    沈念sama閱讀 33,646評論 4 322
  • 正文 年R本政府宣布,位于F島的核電站涩赢,受9級特大地震影響霎肯,放射性物質(zhì)發(fā)生泄漏驮俗。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 39,213評論 3 307
  • 文/蒙蒙 一渊额、第九天 我趴在偏房一處隱蔽的房頂上張望奔垦。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,204評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽巧娱。三九已至,卻和暖如春锻离,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,423評論 1 260
  • 我被黑心中介騙來泰國打工惕蹄, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留张峰,地道東北人。 一個月前我還...
    沈念sama閱讀 45,423評論 2 352
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子磺樱,可洞房花燭夜當晚...
    茶點故事閱讀 42,722評論 2 345

推薦閱讀更多精彩內(nèi)容