使用maven-assembly-plugin插件自定義項(xiàng)目打包

在Maven中锄俄,主要有3個(gè)插件可以用來(lái)打包:

  • maven-jar-plugin浇坐,默認(rèn)的打包插件,用來(lái)打普通的project JAR包仅偎;
  • maven-shade-plugin跨蟹,用來(lái)打可執(zhí)行JAR包,也就是所謂的fat JAR包橘沥;
  • maven-assembly-plugin窗轩,支持自定義的打包結(jié)構(gòu),也可以定制依賴(lài)項(xiàng)等座咆。

我們?nèi)粘J褂玫囊詍aven-assembly-plugin為最多痢艺,因?yàn)榇髷?shù)據(jù)項(xiàng)目中往往有很多shell腳本、SQL腳本介陶、.properties及.xml配置項(xiàng)等堤舒,采用assembly插件可以讓輸出的結(jié)構(gòu)清晰而標(biāo)準(zhǔn)化。

要使用該插件哺呜,就在項(xiàng)目pom文件中加入以下內(nèi)容舌缤。

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>${maven-assembly-plugin.version}<version>
                <executions>
                    <execution>
                        <id>make-assembly</id>
                        <!-- 綁定到package生命周期 -->
                        <phase>package</phase>
                        <goals>
                            <!-- 只運(yùn)行一次 -->
                            <goal>single</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <!-- 配置描述符文件 -->
                    <descriptor>src/main/assembly/assembly.xml</descriptor>
                    <!-- 也可以使用Maven預(yù)配置的描述符
                    <descriptorRefs>
                        <descriptorRef>jar-with-dependencies</descriptorRef>
                    </descriptorRefs> -->
                </configuration>
            </plugin>
        </plugins>
    </build>

assembly插件的打包方式是通過(guò)descriptor(描述符)來(lái)定義的。
Maven預(yù)先定義好的描述符有bin某残,src国撵,project,jar-with-dependencies等玻墅。比較常用的是jar-with-dependencies介牙,它是將所有外部依賴(lài)JAR都加入生成的JAR包中,比較傻瓜化澳厢。
但要真正達(dá)到自定義打包的效果环础,就需要自己寫(xiě)描述符文件,格式為XML剩拢。下面是我們的項(xiàng)目中常用的一種配置线得。

<assembly>
    <id>assembly</id>

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

    <includeBaseDirectory>true</includeBaseDirectory>

    <fileSets>
        <fileSet>
            <directory>src/main/bin</directory>
            <includes>
                <include>*.sh</include>
            </includes>
            <outputDirectory>bin</outputDirectory>
            <fileMode>0755</fileMode>
        </fileSet>
        <fileSet>
            <directory>src/main/conf</directory>
            <outputDirectory>conf</outputDirectory>
        </fileSet>
        <fileSet>
            <directory>src/main/sql</directory>
            <includes>
                <include>*.sql</include>
            </includes>
            <outputDirectory>sql</outputDirectory>
        </fileSet>
        <fileSet>
            <directory>target/classes/</directory>
            <includes>
                <include>*.properties</include>
                <include>*.xml</include>
                <include>*.txt</include>
            </includes>
            <outputDirectory>conf</outputDirectory>
        </fileSet>
    </fileSets>

    <files>
        <file>
            <source>target/${project.artifactId}-${project.version}.jar</source>
            <outputDirectory>.</outputDirectory>
        </file>
    </files>

    <dependencySets>
        <dependencySet>
            <unpack>false</unpack>
            <scope>runtime</scope>
            <outputDirectory>lib</outputDirectory>
        </dependencySet>
    </dependencySets>
</assembly>
id與formats
  • formats是assembly插件支持的打包文件格式,有zip裸扶、tar框都、tar.gz、tar.bz2呵晨、jar魏保、war∶溃可以同時(shí)定義多個(gè)format谓罗。
  • id則是添加到打包文件名的標(biāo)識(shí)符,用來(lái)做后綴季二。
  • 也就是說(shuō)檩咱,如果按上面的配置揭措,生成的文件就是${artifactId}-${version}-assembly.tar.gz。
fileSets/fileSet

用來(lái)設(shè)置一組文件在打包時(shí)的屬性刻蚯。

  • directory:源目錄的路徑绊含。
  • includes/excludes:設(shè)定包含或排除哪些文件,支持通配符炊汹。
  • fileMode:指定該目錄下的文件屬性躬充,采用Unix八進(jìn)制描述法,默認(rèn)值是0644讨便。
  • outputDirectory:生成目錄的路徑充甚。
files/file

與fileSets大致相同,不過(guò)是指定單個(gè)文件霸褒,并且還可以通過(guò)destName屬性來(lái)設(shè)置與源文件不同的名稱(chēng)伴找。

dependencySets/dependencySet

用來(lái)設(shè)置工程依賴(lài)文件在打包時(shí)的屬性。也與fileSets大致相同废菱,不過(guò)還有兩個(gè)特殊的配置:

  • unpack:布爾值技矮,false表示將依賴(lài)以原來(lái)的JAR形式打包,true則表示將依賴(lài)解成*.class文件的目錄結(jié)構(gòu)打包昙啄。
  • scope:表示符合哪個(gè)作用范圍的依賴(lài)會(huì)被打包進(jìn)去穆役。compile與provided都不用管,一般是寫(xiě)runtime梳凛。

按照以上配置打包好后,將.tar.gz文件上傳到服務(wù)器梳杏,解壓之后就會(huì)得到bin韧拒、conf、lib等規(guī)范化的目錄結(jié)構(gòu)十性,十分方便叛溢。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市劲适,隨后出現(xiàn)的幾起案子楷掉,更是在濱河造成了極大的恐慌,老刑警劉巖霞势,帶你破解...
    沈念sama閱讀 206,214評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件烹植,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡愕贡,警方通過(guò)查閱死者的電腦和手機(jī)草雕,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,307評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)固以,“玉大人墩虹,你說(shuō)我怎么就攤上這事嘱巾。” “怎么了诫钓?”我有些...
    開(kāi)封第一講書(shū)人閱讀 152,543評(píng)論 0 341
  • 文/不壞的土叔 我叫張陵旬昭,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我菌湃,道長(zhǎng)稳懒,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 55,221評(píng)論 1 279
  • 正文 為了忘掉前任慢味,我火速辦了婚禮场梆,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘纯路。我一直安慰自己或油,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,224評(píng)論 5 371
  • 文/花漫 我一把揭開(kāi)白布驰唬。 她就那樣靜靜地躺著顶岸,像睡著了一般。 火紅的嫁衣襯著肌膚如雪叫编。 梳的紋絲不亂的頭發(fā)上辖佣,一...
    開(kāi)封第一講書(shū)人閱讀 49,007評(píng)論 1 284
  • 那天,我揣著相機(jī)與錄音搓逾,去河邊找鬼卷谈。 笑死,一個(gè)胖子當(dāng)著我的面吹牛霞篡,可吹牛的內(nèi)容都是我干的世蔗。 我是一名探鬼主播,決...
    沈念sama閱讀 38,313評(píng)論 3 399
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼朗兵,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼污淋!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起余掖,我...
    開(kāi)封第一講書(shū)人閱讀 36,956評(píng)論 0 259
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤寸爆,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后盐欺,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體赁豆,經(jīng)...
    沈念sama閱讀 43,441評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,925評(píng)論 2 323
  • 正文 我和宋清朗相戀三年找田,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了歌憨。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,018評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡墩衙,死狀恐怖务嫡,靈堂內(nèi)的尸體忽然破棺而出甲抖,到底是詐尸還是另有隱情,我是刑警寧澤心铃,帶...
    沈念sama閱讀 33,685評(píng)論 4 322
  • 正文 年R本政府宣布准谚,位于F島的核電站,受9級(jí)特大地震影響去扣,放射性物質(zhì)發(fā)生泄漏柱衔。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,234評(píng)論 3 307
  • 文/蒙蒙 一愉棱、第九天 我趴在偏房一處隱蔽的房頂上張望唆铐。 院中可真熱鬧,春花似錦奔滑、人聲如沸艾岂。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 30,240評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)王浴。三九已至,卻和暖如春梅猿,著一層夾襖步出監(jiān)牢的瞬間氓辣,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 31,464評(píng)論 1 261
  • 我被黑心中介騙來(lái)泰國(guó)打工袱蚓, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留钞啸,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 45,467評(píng)論 2 352
  • 正文 我出身青樓癞松,卻偏偏與公主長(zhǎng)得像爽撒,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子响蓉,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,762評(píng)論 2 345

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