maven assembly plugin使用


使用場景

在使用maven來管理項目時,項目除了web項目,還有可能為控制台程序,一般用於開發一些后台服務的程序。最近在工作中也遇到了這種場景,使用quartz開發一個任務調度程序。程序中依賴很多jar包,項目的啟動時只需要初始化spring容器即可。

使用方法

使用一個簡單的基於spring框架的demo來做程序示例,來介紹maven assembly插件的使用方法。
項目中的代碼目錄如下:


在以上代碼目錄中,assembly目錄下為打包的描述文件,下面會詳細介紹該文件,bin目錄下為啟動腳本以及readme等文件,main下為maven標准中建立的文件,java代碼以及配置文件位於該目錄下。
打包完成后壓縮包目錄如下:


打包完成后,我們可以看到bin目錄來存放啟動腳本等文件,config為配置文件,lib下為運行時依賴的jar包。
使用maven assembly插件需要在pom文件中配置,添加這個插件

            <plugin>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>2.4.1</version>
                <executions>
                    <execution>
                        <id>make-zip</id>
                        <!-- 綁定到package生命周期階段上 -->
                        <phase>package</phase>
                        <goals>
                            <!-- 綁定到package生命周期階段上 -->
                            <goal>single</goal>
                        </goals>
                        <configuration>
                            <descriptors> <!--描述文件路徑-->
                                <descriptor>src/assembly/assembly.xml</descriptor>
                            </descriptors>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

其中execution節點,我們配置了執行maven assembly插件的一些配置,descriptor節點配置指向assembly.xml的路徑。
在assembly.xml配置了,我們打包的目錄以及相應的設置

<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
    <id>distribution</id>
    <formats>
        <format>zip</format>
    </formats>
    <fileSets>
        <fileSet>
            <directory>${project.basedir}\src\main\resources</directory>
            <outputDirectory>\</outputDirectory>
        </fileSet>
        <fileSet>
            <directory>${project.basedir}\src\bin</directory>
            <outputDirectory>\bin</outputDirectory>
        </fileSet>
    </fileSets>
    <dependencySets>
        <dependencySet>
            <useProjectArtifact>true</useProjectArtifact>
            <outputDirectory>lib</outputDirectory>
            <!-- 將scope為runtime的依賴包打包到lib目錄下。 -->
            <scope>runtime</scope>
        </dependencySet>
    </dependencySets></assembly>

assembly.xml的配置項非常多,可以參考http://maven.apache.org/plugins/maven-assembly-plugin/assembly.html
以上只是用了很少的一部分。
format設置包輸出的格式,以上格式設置的為zip格式,目前還支持zip,tar,tar.gz,tar.bz2,jar,dir,war格式
fileSet定義代碼目錄中與輸出目錄的映射,在該節點下還有 <includes/>,<excludes/>兩個非常有用的節點。
比如:

        <fileSet>
            <directory>${project.basedir}\src\main\resources</directory>
            <outputDirectory>\</outputDirectory>
            <includes>
                <include>some/path</include>
            </includes>
            <excludes>
                <exclude>some/path1</exclude>
            </excludes>
        </fileSet>

以上代碼表示歸檔時包括some/path,不包括some/path1
dependencySets節點下為依賴設置
在上述配置中,表示所有運行時依賴的jar包歸檔到lib目錄下。在上述截圖中lib目錄下的文件就是所有依賴的jar包

更多節點的用法可以去官網查詢
http://maven.apache.org/plugins/maven-assembly-plugin/assembly.html

下面的文章會介紹打包后的包如何做成windows服務,linux服務。

參考資料

http://maven.apache.org/plugins/maven-assembly-plugin/



免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM