首頁 > 軟體

關於maven:pom檔案的使用解析

2022-08-18 18:03:56

一、maven專案的目錄結構

pom檔案定於了一個maven專案的maven設定,一般pom檔案的放在專案或者模組的根目錄下。

maven的遵循約定大於設定,約定了如下的目錄結構:

目錄目的
${basedir}存放pom.xml和所有的子目錄
${basedir}/src/main/java專案的java原始碼
${basedir}/src/main/resources專案的資源,比如說property檔案,springmvc.xml
${basedir}/src/test/java專案的測試類,比如說Junit程式碼
${basedir}/src/test/resources測試用的資源
${basedir}/src/main/scripts專案指令碼原始碼的目錄
${basedir}/src/main/webapp/WEB-INFweb應用檔案目錄,web專案的資訊,比如存放web.xml、本地圖片、jsp檢視頁面
${basedir}/target打包輸出目錄
${basedir}/target/classes編譯輸出目錄
${basedir}/target/site生成檔案的目錄,可以通過index.html檢視專案的檔案
${basedir}/target/test-classes測試編譯輸出目錄
Test.javaMaven只會自動執行符合該命名規則的測試類
~/.m2/repositoryMaven預設的本地倉庫目錄位置

二、根元素和必要設定

<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>
    <!-- 公司或者組織的唯一標誌,也是打包成jar包路徑的依據 -->
    <!-- 例如com.companyname.project-group,maven打包jar包的路徑:/com/companyname/project-group -->
    <groupId>com.companyname.project-group</groupId>
 
    <!-- 專案的唯一ID,一個groupId下面可能多個專案,就是靠artifactId來區分的 -->
    <artifactId>project</artifactId>
 
    <!-- 專案當前版本,格式為:主版本.次版本.增量版本-限定版本號 -->
    <version>1.0</version>

    <!--專案產生的構件型別,包括jar、war、ear、pom等 -->
    <packaging>jar</packaging>
</project>

project是pom檔案的根元素,project下有modelVersion、groupId、artifactId、version、packaging等重要的元素。其中,groupId、artifactId、version三個元素用來定義一個專案的座標,也就是說,一個maven倉庫中,完全相同的一組groupId、artifactId、version,只能有一個專案。

  • project:整個pom組態檔的根元素,所有的設定都是寫在project元素裡面的;
  • modelVersion:指定了當前POM模型的版本,對於Maven2及Maven 3來說,它只能是4.0.0;
  • groupId:這是專案組的標識。它在一個組織或者專案中通常是唯一的。
  • artifactId:這是專案的標識,通常是工程的名稱。它在一個專案組(group)下是唯一的。
  • version:這是專案的版本號,用來區分同一個artifact的不同版本。
  • packaging:這是專案產生的構件型別,即專案通過maven打包的輸出檔案的字尾名,包括jar、war、ear、pom等。

三、父專案和parent元素

    <!--父專案的座標,座標包括group ID,artifact ID和version。 -->
    <!--如果專案中沒有規定某個元素的值,那麼父專案中的對應值即為專案的預設值 -->
    <parent>

        <!--被繼承的父專案的構件識別符號 -->
        <artifactId>com.companyname.project-group</artifactId>
        <!--被繼承的父專案的全球唯一識別符號 -->
        <groupId>base-project</groupId>
        <!--被繼承的父專案的版本 -->
        <version>1.0.1-RELEASE</version>

        <!-- 父專案的pom.xml檔案的相對路徑,預設值是../pom.xml。 -->
        <!-- 尋找父專案的pom:構建當前專案的地方--)relativePath指定的位置--)本地倉庫--)遠端倉庫 -->
        <relativePath>../pom.xml</relativePath>
    </parent>

所有的pom都繼承自一個父pom(Super POM)。父pom包含了一些可以被繼承的預設設定,如果專案的pom中沒有設定這些元素,就會使用父pom中設定。例如,Super POM中設定了預設倉庫http://repo1.maven.org/maven2,這樣哪怕專案的pom中沒有設定倉庫,也可以去這個預設倉庫中去下載依賴。實際上,maven pom檔案約定大於設定的原則,就是通過在Super POM中預定義了一些設定資訊來實現的。

Maven使用effective pom(Super pom加上工程自己的設定)來執行相關的目標,它幫助開發者在pom.xml中做盡可能少的設定。當然,這些設定也可以被重寫。

parent元素可以指定父pom。使用者可以通過增加parent元素來自定義一個父pom,從而繼承該pom的設定。parent元素中包含一些子元素,用來定位父專案和父專案的pom檔案位置。

  • parent:用於指定父專案;
  • groupId:parent的子元素,父專案的groupId,用於定位父專案;
  • artifactId:parent的子元素,父專案的artifactId,用於定位父專案;
  • version:parent的子元素,父專案的version,用於定位父專案;
  • relativePath:parent的子元素,用於定位父專案pom檔案的位置。

四、專案構建需要的資訊

    <!--構建專案需要的資訊 -->
    <build>
        <!--------------------- 路徑管理(在遵循約定大於設定原則下,不需要設定) --------------------->
        <!--專案原始碼目錄,當構建專案的時候,構建系統會編譯目錄裡的原始碼。該路徑是相對於pom.xml的相對路徑。 -->
        <sourceDirectory />
        <!--該元素設定了專案單元測試使用的原始碼目錄。該路徑是相對於pom.xml的相對路徑 -->
        <testSourceDirectory />
        <!--被編譯過的應用程式class檔案存放的目錄。 -->
        <outputDirectory />
        <!--被編譯過的測試class檔案存放的目錄。 -->
        <testOutputDirectory />        
        <!--專案指令碼原始碼目錄,該目錄下的內容,會直接被拷貝到輸出目錄,因為指令碼是被解釋的,而不是被編譯的 -->
        <scriptSourceDirectory />

        <!--------------------- 資源管理 --------------------->
        <!--這個元素描述了專案相關的所有資源路徑列表,例如和專案相關的屬性檔案,這些資源被包含在最終的打包檔案裡。 -->
        <resources>
            <!--這個元素描述了專案相關或測試相關的所有資源路徑 -->
            <resource>
                <!-- 描述了資源的目標輸出路徑。該路徑是相對於target/classes的路徑 -->
                <!-- 如果是想要把資源直接放在target/classes下,不需要設定該元素 -->
                <targetPath />
                <!--是否使用引數值代替引數名。引數值取自檔案裡設定的屬性,檔案在filters元素裡列出。 -->
                <filtering />
                <!--描述存放資源的目錄,該路徑相對POM路徑 -->
                <directory />
                <!--包含的模式列表,例如**/*.xml,只有符合條件的資原始檔才會在打包的時候被放入到輸出路徑中 -->
                <includes />
                <!--排除的模式列表,例如**/*.xml,符合的資原始檔不會在打包的時候會被過濾掉 -->
                <excludes />
            </resource>
        </resources>
        <!--這個元素描述了單元測試相關的所有資源路徑,例如和單元測試相關的屬性檔案。 -->
        <testResources>
            <!--這個元素描述了測試相關的所有資源路徑,子元素說明參考build/resources/resource元素的說明 -->
            <testResource>
                <targetPath />
                <filtering />
                <directory />
                <includes />
                <excludes />
            </testResource>
        </testResources>

        <!--------------------- 外掛管理 --------------------->
        <!-- 子專案可以參照的預設外掛資訊。pluginManagement中的外掛直到被參照時才會被解析或繫結到生命週期 -->
        <!-- 這裡只是做了宣告,並沒有真正的引入。給定外掛的任何本地設定都會覆蓋這裡的設定-->
        <pluginManagement>
            <!-- 可使用的外掛列表 -->
            <plugins>
                <!--plugin元素包含描述外掛所需要的資訊。 -->
                <plugin>
                    <!--外掛在倉庫裡的group ID -->
                    <groupId />
                    <!--外掛在倉庫裡的artifact ID -->
                    <artifactId />
                    <!--被使用的外掛的版本(或版本範圍) -->
                    <version />
                    <!-- 是否從該外掛下載Maven擴充套件(例如打包和型別處理器) -->
                    <!-- 由於效能原因,只有在真需要下載時,該元素才被設定成enabled -->
                    <extensions />
                    <!--在構建生命週期中執行一組目標的設定。每個目標可能有不同的設定。 -->
                    <executions>
                        <!--execution元素包含了外掛執行需要的資訊 -->
                        <execution>
                            <!--執行目標的識別符號,用於標識構建過程中的目標,或者匹配繼承過程中需要合併的執行目標 -->
                            <id />
                            <!--繫結了目標的構建生命週期階段,如果省略,目標會被繫結到源資料裡設定的預設階段 -->
                            <phase />
                            <!--設定的執行目標 -->
                            <goals />
                            <!--設定是否被傳播到子POM -->
                            <inherited />
                            <!--作為DOM物件的設定 -->
                            <configuration />
                        </execution>
                    </executions>
                    <!--專案引入外掛所需要的額外依賴 -->
                    <dependencies>
                        <!--參見dependencies/dependency元素 -->
                        <dependency>
                            ......
                        </dependency>
                    </dependencies>
                    <!--任何設定是否被傳播到子專案 -->
                    <inherited />
                    <!--作為DOM物件的設定 -->
                    <configuration />
                </plugin>
            </plugins>
        </pluginManagement>
        <!--使用的外掛列表 -->
        <plugins>
            <!--參見build/pluginManagement/plugins/plugin元素 -->
            <plugin>
                <groupId />
                <artifactId />
                <version />
                <extensions />
                <executions>
                    <execution>
                        <id />
                        <phase />
                        <goals />
                        <inherited />
                        <configuration />
                    </execution>
                </executions>
                <dependencies>
                    <!--參見dependencies/dependency元素 -->
                    <dependency>
                        ......
                    </dependency>
                </dependencies>
                <goals />
                <inherited />
                <configuration />
            </plugin>
        </plugins>

        <!--------------------- 構建擴充套件 --------------------->
        <!--使用來自其他專案的一系列構建擴充套件 -->
        <extensions>
            <!--每個extension描述一個會使用到其構建擴充套件的一個專案,extension的子元素是專案的座標 -->
            <extension>
                <!--專案座標三元素:groupId + artifactId + version -->
                <groupId />
                <artifactId />
                <version />
            </extension>
        </extensions>

        <!--------------------- 其他設定 --------------------->
        <!--當專案沒有規定目標(Maven2 叫做階段)時的預設值 -->
        <defaultGoal />
        <!--構建產生的所有檔案存放的目錄 -->
        <directory />
        <!--產生的構件的檔名,預設值是${artifactId}-${version}。 -->
        <finalName />
        <!--當filtering開關開啟時,使用到的過濾器屬性檔案列表 -->
        <filters />
    </build>

build標籤定義了構建專案需要的資訊,這部分資訊對於客製化化專案構建是非常重要的。這裡會根據build的子元素的特點,簡單地分類講解。

1、路徑管理

       <!--------------------- 路徑管理(在遵循約定大於設定原則下,不需要設定) --------------------->
        <!--專案原始碼目錄,當構建專案的時候,構建系統會編譯目錄裡的原始碼。該路徑是相對於pom.xml的相對路徑。 -->
        <sourceDirectory />
        <!--該元素設定了專案單元測試使用的原始碼目錄。該路徑是相對於pom.xml的相對路徑 -->
        <testSourceDirectory />
        <!--被編譯過的應用程式class檔案存放的目錄。 -->
        <outputDirectory />
        <!--被編譯過的測試class檔案存放的目錄。 -->
        <testOutputDirectory />        
        <!--專案指令碼原始碼目錄,該目錄下的內容,會直接被拷貝到輸出目錄,因為指令碼是被解釋的,而不是被編譯的 -->
        <scriptSourceDirectory />

路徑管理定義了各種原始碼和編譯結果的輸出路徑。如果遵循maven預設的路徑約定,這裡的幾個元素是不需要設定的。這些元素包括:

  • sourceDirectory:專案原始碼目錄,定義的是相對於pom檔案的相對路徑;
  • testSourceDirectory:專案單元測試原始碼目錄,定義的也是是相對於pom檔案的相對路徑;
  • outputDirectory:被編譯過的應用程式class檔案存放的目錄,也是是相對於pom檔案的相對路徑;
  • testOutoutDIrectory:被編譯過的測試class檔案存放的目錄,也是是相對於pom檔案的相對路徑;
  • scriptSourceDirectory:專案指令碼原始碼目錄,也是是相對於pom檔案的相對路徑。由於指令碼是解釋性的語言,所以該目錄下的內容,會直接被拷貝到輸出目錄,而不需要編譯。

2、資源管理

        <!--------------------- 資源管理 --------------------->
        <!--這個元素描述了專案相關的所有資源路徑列表,例如和專案相關的屬性檔案,這些資源被包含在最終的打包檔案裡。 -->
        <resources>
            <!--這個元素描述了專案相關或測試相關的所有資源路徑 -->
            <resource>
                <!-- 描述了資源的目標輸出路徑。該路徑是相對於target/classes的路徑 -->
                <!-- 如果是想要把資源直接放在target/classes下,不需要設定該元素 -->
                <targetPath />
                <!--是否使用引數值代替引數名。引數值取自檔案裡設定的屬性,檔案在filters元素裡列出 -->
                <filtering />
                <!--描述打包前的資源存放的目錄,該路徑相對POM路徑 -->
                <directory />
                <!--包含的模式列表,例如**/*.xml,只有符合條件的資原始檔才會在打包的時候被放入到輸出路徑中 -->
                <includes />
                <!--排除的模式列表,例如**/*.xml,符合的資原始檔不會在打包的時候會被過濾掉 -->
                <excludes />
            </resource>
        </resources>
        <!--這個元素描述了單元測試相關的所有資源路徑,例如和單元測試相關的屬性檔案。 -->
        <testResources>
            <!--這個元素描述了測試相關的所有資源路徑,子元素說明參考build/resources/resource元素的說明 -->
            <testResource>
                <targetPath />
                <filtering />
                <directory />
                <includes />
                <excludes />
            </testResource>
        </testResources>

這裡的元素主要是對應用程式resource資源和單元測試部分resource資源的管理,分別通過resource標籤和testResource標籤管理兩種資源。兩個標籤元素可選的子元素都是一樣的。子元素包括:

  • targetPath:描述了資源的目標輸出路徑,該路徑是相對於target/classes的路徑;
  • filtering:對檔案中的引數值進行過濾,需要被過濾的檔案在filter中指定;
  • directory:描述打包前的資源的存放路徑,這個路徑是相對於pom檔案所在目錄的相對路徑;
  • includes:包含的模式列表,例如**/*.xml。只有符合條件的資原始檔才會在打包的時候被放入到輸出路徑中;
  • excludes:排除的模式列表,例如**/*.xml,符合的資原始檔不會在打包的時候會被過濾掉。

3、外掛管理

外掛管理相關的元素有兩個,包括pluginManagement和plugins。pluginManagement中有子元素plugins,它和project下的直接子元素plugins的區別是,pluginManagement主要是用來宣告子專案可以參照的預設外掛資訊,這些外掛如果只寫在pluginManagement中是不會被引入的。project下的直接子元素plugins中定義的才是這個專案中真正需要被引入的外掛。

        <!--------------------- 外掛管理 --------------------->
        <!-- 子專案可以參照的預設外掛資訊。pluginManagement中的外掛直到被參照時才會被解析或繫結到生命週期 -->
        <!-- 這裡只是做了宣告,並沒有真正的引入。給定外掛的任何本地設定都會覆蓋這裡的設定-->
        <pluginManagement>
            <!-- 可使用的外掛列表 -->
            <plugins>
                <!--plugin元素包含描述外掛所需要的資訊。 -->
                <plugin>
                    <!--外掛定位座標三元素:groupId + artifactId + version -->
                    <groupId />
                    <artifactId />
                    <version />
                    <!-- 是否使用這個外掛的Maven擴充套件(extensions),預設為false -->
                    <!-- 由於效能原因,只有在真需要下載時,該元素才被設定成enabled -->
                    <extensions />
                    <!--在構建生命週期中執行一組目標的設定。每個目標可能有不同的設定。 -->
                    <executions>
                        <!--execution元素包含了外掛執行需要的資訊 -->
                        <execution>
                            <!--執行目標的識別符號,用於標識構建過程中的目標,或者匹配繼承過程中需要合併的執行目標 -->
                            <id />
                            <!--繫結了目標的構建生命週期階段,如果省略,目標會被繫結到源資料裡設定的預設階段 -->
                            <phase />
                            <!--設定的執行目標 -->
                            <goals />
                            <!--設定是否被傳播到子POM -->
                            <inherited />
                            <!--作為DOM物件的設定 -->
                            <configuration />
                        </execution>
                    </executions>
                    <!--專案引入外掛所需要的額外依賴,參見dependencies元素 -->
                    <dependencies>
                            ......
                    </dependencies>
                    <!--任何設定是否被傳播到子專案 -->
                    <inherited />
                    <!--作為DOM物件的設定 -->
                    <configuration />
                </plugin>
            </plugins>
        </pluginManagement>
        <!--使用的外掛列表,這裡是真正的引入外掛。參見build/pluginManagement/plugins元素 -->
        <plugins>
            ......
        </plugins>

4、構建擴充套件

extensions是在此構建中使用的專案的列表,它們將被包含在執行構建的classpath中。這些專案可以啟用對構建過程的擴充套件,並使活動的外掛能夠對構建生命週期進行更改。簡而言之,擴充套件是在構建期間啟用的artifacts。擴充套件不需要實際執行任何操作,也不包含 Mojo。因此,擴充套件對於指定普通外掛介面的多個實現中的一個是非常好的。

        <!--------------------- 構建擴充套件 --------------------->
        <!--使用來自其他專案的一系列構建擴充套件 -->
        <extensions>
            <!--每個extension描述一個會使用到其構建擴充套件的一個專案,extension的子元素是專案的座標 -->
            <extension>
                <!--專案座標三元素:groupId + artifactId + version -->
                <groupId />
                <artifactId />
                <version />
            </extension>
        </extensions>

5、其他設定

build中還有一些設定,如下:

        <!--------------------- 其他設定 --------------------->
        <!--當專案沒有規定目標(Maven2 叫做階段)時的預設值 -->
        <defaultGoal />
        <!--構建產生的所有檔案存放的目錄 -->
        <directory />
        <!--產生的構件的檔名,預設值是${artifactId}-${version}。 -->
        <finalName />
        <!--當filtering開關開啟時,使用到的過濾器屬性檔案列表 -->
        <filters />

五、專案依賴相關資訊

pom檔案中通過dependencyManagement來宣告依賴,通過dependencies元素來管理依賴。dependencyManagement下的子元素只有一個直接的子元素dependencice,其設定和dependencies子元素是完全一致的;而dependencies下只有一類直接的子元素:dependency。一個dependency子元素表示一個依賴專案。

    <!--該元素描述了專案相關的所有依賴。 這些依賴自動從專案定義的倉庫中下載 -->
    <dependencies>
        <dependency>
            <!------------------- 依賴座標 ------------------->
            <!--依賴專案的座標三元素:groupId + artifactId + version -->
            <groupId>org.apache.maven</groupId>
            <artifactId>maven-artifact</artifactId>
            <version>3.8.1</version>

            <!------------------- 依賴型別 ------------------->
            <!-- 依賴型別,預設是jar。通常表示依賴檔案的擴充套件名,但有例外。一個型別可以被對映成另外一個擴充套件名或分類器 -->
            <!-- 型別經常和使用的打包方式對應,儘管這也有例外,一些型別的例子:jar,war,ejb-client和test-jar -->
            <!-- 如果設定extensions為true,就可以在plugin裡定義新的型別 -->
            <type>jar</type>
            <!-- 依賴的分類器。分類器可以區分屬於同一個POM,但不同構建方式的構件。分類器名被附加到檔名的版本號後面 -->
            <!-- 如果想將專案構建成兩個單獨的JAR,分別使用Java 4和6編譯器,就可以使用分類器來生成兩個單獨的JAR構件 -->
            <classifier></classifier>

            <!------------------- 依賴傳遞 ------------------->
            <!--依賴排除,即告訴maven只依賴指定的專案,不依賴該專案的這些依賴。此元素主要用於解決版本衝突問題 -->
            <exclusions>
                <exclusion>
                    <artifactId>spring-core</artifactId>
                    <groupId>org.springframework</groupId>
                </exclusion>
            </exclusions>
            <!-- 可選依賴,用於阻斷依賴的傳遞性。如果在專案B中把C依賴宣告為可選,那麼依賴B的專案中無法使用C依賴 -->
            <optional>true</optional>
            
            <!------------------- 依賴範圍 ------------------->
            <!--依賴範圍。在專案發布過程中,幫助決定哪些構件被包括進來
                - compile:預設範圍,用於編譯;  - provided:類似於編譯,但支援jdk或者容器提供,類似於classpath 
                - runtime: 在執行時需要使用;    - systemPath: 僅用於範圍為system。提供相應的路徑 
                - test: 用於test任務時使用;    - system: 需要外在提供相應的元素。通過systemPath來取得 
                - optional: 當專案自身被依賴時,標註依賴是否傳遞。用於連續依賴時使用 -->
            <scope>test</scope>
            <!-- 該元素為依賴規定了檔案系統上的路徑。僅供scope設定system時使用。但是不推薦使用這個元素 -->
            <!-- 不推薦使用絕對路徑,如果必須要用,推薦使用屬性匹配絕對路徑,例如${java.home} -->
            <systemPath></systemPath>
        </dependency>
    </dependencies>

    <!-- 繼承自該專案的所有子專案的預設依賴資訊,這部分的依賴資訊不會被立即解析。 -->
    <!-- 當子專案宣告一個依賴,如果group ID和artifact ID以外的一些資訊沒有描述,則使用這裡的依賴資訊 -->
    <dependencyManagement>
        <dependencies>
            <!--參見dependencies/dependency元素 -->
            <dependency>
                ......
            </dependency>
        </dependencies>
    </dependencyManagement>

這裡也是根據元素的作用,簡單的對dependency的子元素做了一下分類。下面按分類來看一下dependency的子元素:

1、依賴座標

依然是通過groupId + artifactId + version來在倉庫中定位一個專案:

  • groupId:parent的子元素,父專案的groupId,用於定位父專案;
  • artifactId:parent的子元素,父專案的artifactId,用於定位父專案;
  • version:parent的子元素,父專案的version,用於定位父專案;

2、依賴型別

這個分類主要包括兩個元素,分別是依賴型別和依賴的分類器。同一個專案,即使打包成同一種型別,也可以有多個檔案同時存在,因為它們的分類器可能是不同的。

  • type:依賴型別,預設是jar。通常表示依賴檔案的擴充套件名,但也有例外。一個型別可以被對映成另外一個擴充套件名或分類器。型別經常和使用的打包方式對應,儘管這也有例外,一些型別的例子:jar,war,ejb-client和test-jar。如果設定extensions為true,就可以在plugin裡定義新的型別。
  • classifier:依賴的分類器。分類器可以區分屬於同一個POM,但不同構建方式的構件。分類器名被附加到檔名的版本號後面,如果想將專案構建成兩個單獨的JAR,分別使用Java 4和6編譯器,就可以使用分類器來生成兩個單獨的JAR構件

3、依賴傳遞

依賴傳遞相關的子元素主要有兩個,用於依賴排除的exclusions和設定依賴是否可選的optional。

  • exclusions:排除該專案中的一些依賴,即本專案A依賴該dependency指示的專案B,但是不依賴專案B中依賴的這些依賴;
  • optional:可選依賴,用於阻斷依賴的傳遞性,即本專案不會依賴父專案中optional設定為true的依賴。

4、依賴範圍

還有一些其他元素:

  • scope:依賴範圍。在專案發布過程中,幫助決定哪些構件被包括進來

- compile:預設範圍,用於編譯; - provided:類似於編譯,但支援jdk或者容器提供,類似於classpath

- runtime: 在執行時需要使用; - systemPath: 僅用於範圍為system,提供相應的路徑

- test: 用於test任務時使用; - system: 需要外在提供相應的元素,通過systemPath來取得

- optional: 當專案自身被依賴時,標註依賴是否傳遞。用於連續依賴時使用

  • systemPath:該元素為依賴規定了檔案系統上的絕對路徑。僅在scope設定成system時才會使用。不推薦使用這個元素。不推薦使用絕對路徑,如果必須要用,推薦使用屬性匹配絕對路徑,例如${java.home}

六、生成檔案相關的元素

    <!--專案的名稱, Maven生成檔案使用 -->
    <name>project-maven</name>

    <!--專案主頁的URL, Maven生成檔案使用 -->
    <url>http://123.a.b/nsnxs</url>

    <!-- 專案的詳細描述, Maven生成檔案使用。當這個元素能夠用HTML格式描述時,不鼓勵使用純文字描述 -->
    <!--如果你需要修改生成的web站點的索引頁面,你應該修改你自己的索引頁檔案,而不是調整這裡的檔案 -->
    <description>Description of this maven project</description>

備註:maven可以通過mvn site命令生成專案的相關檔案。

和生成檔案相關的元素,包括name,url,和description。

  • name:專案名稱,maven生成檔案會使用專案名;
  • url:專案主頁的地址,maven生成檔案的時候使用。
  • description:專案描述。如果可以使用HTML格式進行描述的時候,不推薦使用純文字的描述。

七、遠端倉庫列表

遠端倉庫列表的設定,包括依賴和擴充套件的遠端倉庫設定,以及外掛的遠端倉庫設定。在本地倉庫找不到的情況下,maven下載依賴、擴充套件和外掛就是從這裡設定的遠端倉庫中進行下載。

需要注意的是release和snapshot兩者的區別。release是穩定版本,一經發布不再修改,想釋出修改後的專案,只能升級專案版本再進行釋出;snapshot是不穩定的,一個snapshot的版本可以不斷改變。專案在開發期間一般會使用snapshot,更方便進行頻繁的程式碼更新;一旦釋出到外部,或者開發基本完成,程式碼迭代不再頻繁,則推薦使用release。

    <!--發現依賴和擴充套件的遠端倉庫列表。 -->
    <repositories>
        <!--包含需要連線到遠端倉庫的資訊 -->
        <repository>
            <!--如何處理遠端倉庫裡釋出版本的下載 -->
            <releases>
                <!--值為true或者false,表示該倉庫是否為下載某種型別構件(釋出版,快照版)開啟。 -->
                <enabled />
                <!--該元素指定更新發生的頻率。Maven會比較本地POM和遠端POM的時間戳 -->
                <!--選項:always,daily(預設),interval:X(X單位為分鐘),或者never。 -->
                <updatePolicy />
                <!--當Maven驗證構件校驗檔案失敗時該怎麼做。選項:ignore,fail,或者warn -->
                <checksumPolicy />
            </releases>
            <!-- 如何處理遠端倉庫裡快照版本的下載 -->
            <!-- 有了releases和snapshots這兩組設定,就可以在每個單獨的倉庫中,為每種型別的構件採取不同的策略 -->
            <snapshots>
                <enabled />
                <updatePolicy />
                <checksumPolicy />
            </snapshots>
 
            <!--遠端倉庫唯一識別符號。可以用來匹配在settings.xml檔案裡設定的遠端倉庫 -->
            <id>nanxs-repository-proxy</id>
            <!--遠端倉庫名稱 -->
            <name>nanxs-repository-proxy</name>
            <!--遠端倉庫URL,按protocol://hostname/path形式 -->
            <url>http://192.168.1.169:9999/repository/</url>
            <!-- 用於定位和排序構件的倉庫佈局型別。可以是default或者legacy -->
            <layout>default</layout>
        </repository>
    </repositories>
    
    <!--發現外掛的遠端倉庫列表,這些外掛用於構建和報表 -->
    <pluginRepositories>
        <!--包含需要連線到遠端外掛倉庫的資訊。參見repositories/repository元素 -->
        <pluginRepository>
            ......
        </pluginRepository>
    </pluginRepositories>

八、專案分發資訊相關元素

    <!--專案分發資訊,在執行mvn deploy後表示要釋出的位置。用於把網站部署到遠端伺服器或者把構件部署到遠端倉庫 -->
    <distributionManagement>
        <!--部署專案產生的構件到遠端倉庫需要的資訊 -->
        <repository>
            <!-- 是分配給快照一個唯一的版本號 -->
            <uniqueVersion />
            <!-- 其他設定參見repositories/repository元素 -->
            <id>nanxs-maven2</id>
            <name>nanxsmaven2</name>
            <url>file://${basedir}/target/deploy</url>
            <layout />
        </repository>
        <!--構件的快照部署的倉庫。預設部署到distributionManagement/repository元素設定的倉庫 -->
        <snapshotRepository>
            <uniqueVersion />
            <id>nanxs-maven2</id>
            <name>Nanxs-maven2 Snapshot Repository</name>
            <url>scp://svn.baidu.com/nanxs:/usr/local/maven-snapshot</url>
            <layout />
        </snapshotRepository>
        <!--部署專案的網站需要的資訊 -->
        <site>
            <!--部署位置的唯一識別符號,用來匹配站點和settings.xml檔案裡的設定 -->
            <id>nanxs-site</id>
            <!--部署位置的名稱 -->
            <name>business api website</name>
            <!--部署位置的URL,按protocol://hostname/path形式 -->
            <url>scp://svn.baidu.com/nanxs:/var/www/localhost/nanxs-web</url>
        </site>
        <!--專案下載頁面的URL。如果沒有該元素,使用者應該參考主頁 -->
        <!--本元素是為了幫助定位那些不在倉庫裡的構件(license限制) -->
        <downloadUrl />
        <!--如果構件有了新的group ID和artifact ID(構件移到了新的位置),這裡列出構件的重定位資訊 -->
        <relocation>
            <!--構件新的group ID -->
            <groupId />
            <!--構件新的artifact ID -->
            <artifactId />
            <!--構件新的版本號 -->
            <version />
            <!--顯示給使用者的,關於移動的額外資訊,例如原因 -->
            <message />
        </relocation>
        <!-- 給出該構件在遠端倉庫的狀態。本地專案中不能設定該元素,因為這是工具自動更新的 -->
        <!-- 有效的值有:none(預設),converted(倉庫管理員從 Maven 1 POM轉換過來),
            partner(直接從夥伴Maven 2倉庫同步過來),deployed(從Maven 2範例部署),
            verified(被核實時正確的和最終的) -->
        <status />
    </distributionManagement>

專案分發資訊的相關設定,在distributionManagement中設定。設定的內容包括:

  • repositorysnapshotRepository:專案產生的構建/快照構建部署的遠端倉庫。如果不設定snapshotRepository,快照也會部署到repository中;
  • site:部署專案的網站需要的資訊;
  • downloadUrl:專案下載頁面的URL,這是為不在倉庫中的構建提供的;
  • relocation:如果構件有了新的group ID和artifact ID(移到了新的位置),這裡列出構件的新的資訊;
  • status:給出該構件在遠端倉庫的狀態,本地專案中不能設定該元素,這是工具自動更新的。

九、報表規範

報表規範描述的是使用mvn site命令時使用的一些設定。

    <!-- 該元素描述使用報表外掛產生報表的規範 -->
    <!-- 當用戶執行"mvn site",這些報表就會執行,在頁面導航欄能看到所有報表的連結 -->
    <reporting>
        <!--網站是否排除預設的報表。這包括"專案資訊"選單中的報表。 -->
        <excludeDefaults />
        <!--所有產生的報表存放到哪裡。預設值是${project.build.directory}/site。 -->
        <outputDirectory />
        <!--使用的報表外掛和他們的設定。 -->
        <plugins>
            <!--plugin元素包含描述報表外掛需要的資訊 -->
            <plugin>
                <!--報表外掛定位:groupId + artifactId + version -->
                <groupId />
                <artifactId />
                <version />
 
                <!--任何設定是否被傳播到子專案 -->
                <inherited />
                <!--報表外掛的設定 -->
                <configuration />
                <!-- 一組報表的多重規範,每個規範可能有不同的設定。一個規範(報表集)對應一個執行目標 -->
                <!-- 例如,有1~9這9個報表。1,2構成A報表集,對應一個執行目標;2,5構成B報表集,對應另一個執行目標 -->
                <reportSets>
                    <!--表示報表的一個集合,以及產生該集合的設定 -->
                    <reportSet>
                        <!--報表集合的唯一識別符號,POM繼承時用到 -->
                        <id />
                        <!--產生報表集合時,被使用的報表的設定 -->
                        <configuration />
                        <!--設定是否被繼承到子POMs -->
                        <inherited />
                        <!--這個集合裡使用到哪些報表 -->
                        <reports />
                    </reportSet>
                </reportSets>
            </plugin>
        </plugins>
    </reporting>

十、profile設定

    <!--在列的專案構建profile,如果被啟用,會修改構建處理 -->
    <profiles>
        <!--根據環境引數或命令列引數啟用某個構建處理 -->
        <profile>
            <!--構建設定的唯一識別符號。即用於命令列啟用,也用於在繼承時合併具有相同識別符號的profile。 -->
            <id />
            <!--自動觸發profile的條件邏輯。Activation是profile的開啟鑰匙,profile的力量來自於它 -->
            <!-- 能夠在某些特定的環境中自動使用某些特定的值;這些環境通過activation元素指定。activation元素並不是啟用profile的唯一方式 -->
            <activation>
                <!--profile預設是否啟用的標誌 -->
                <activeByDefault />
                <!--當匹配的jdk被檢測到,profile被啟用。例如,1.4啟用JDK1.4,1.4.0_2,而!1.4啟用所有版本不是以1.4開頭的JDK -->
                <jdk />
                <!--當匹配的作業系統屬性被檢測到,profile被啟用。os元素可以定義一些作業系統相關的屬性。 -->
                <os>
                    <!--啟用profile的作業系統的名字 -->
                    <name>Windows XP</name>
                    <!--啟用profile的作業系統所屬家族(如 'windows') -->
                    <family>Windows</family>
                    <!--啟用profile的作業系統體系結構 -->
                    <arch>x86</arch>
                    <!--啟用profile的作業系統版本 -->
                    <version>5.1.2600</version>
                </os>
                <!--如果Maven檢測到某一個屬性(其值可以在POM中通過${名稱}參照),其擁有對應的名稱和值,Profile就會被啟用 -->
                <!--如果值欄位是空的,那麼存在屬性名稱欄位就會啟用profile,否則按區分大小寫方式匹配屬性值欄位 -->
                <property>
                    <!--啟用profile的屬性的名稱 -->
                    <name>mavenVersion</name>
                    <!--啟用profile的屬性的值 -->
                    <value>2.0.3</value>
                </property>
                <!--提供一個檔名,通過檢測該檔案的存在或不存在來啟用profile。missing檢查檔案是否存在,如果不存在則啟用profile -->
                <!--另一方面,exists則會檢查檔案是否存在,如果存在則啟用profile -->
                <file>
                    <!--如果指定的檔案存在,則啟用profile。 -->
                    <exists>/usr/local/abcd/abcd-home/jobs/maven-guide-zh-to-production/workspace/
                    </exists>
                    <!--如果指定的檔案不存在,則啟用profile。 -->
                    <missing>/usr/local/abcd/abcd-home/jobs/maven-guide-zh-to-production/workspace/
                    </missing>
                </file>
            </activation>
 
            <!--構建專案所需要的資訊。參見build元素 -->
            <build />
            <!--發現依賴和擴充套件的遠端倉庫列表。詳情參見repositories元素 -->
            <repositories />
            <!--發現外掛的遠端倉庫列表,這些外掛用於構建和報表。詳情參見pluginRepositories元素 -->
            <pluginRepositories />
            <!--該元素描述了專案相關的所有依賴。 詳細設定參見dependencies -->
            <dependencies />
            <!--該元素包括使用報表外掛產生報表的規範。當用戶執行"mvn site",這些報表就會執行。在頁面導航欄能看到所有報表的連結。參見reporting元素 -->
            <reporting />
            <!--參見dependencyManagement元素 -->
            <dependencyManagement />
            <!--參見distributionManagement元素 -->
            <distributionManagement />
 
            <!--不贊成使用. 現在Maven忽略該元素. -->
            <reports />
            <!--模組(有時稱作子專案) 被構建成專案的一部分。列出的每個模組元素是指向該模組的目錄的相對路徑 -->
            <modules />
            <!--參見properties元素 -->
            <properties />
        </profile>
    </profiles>

十一、郵寄清單和持續整合設定

    <!--專案持續整合資訊 -->
    <ciManagement>
        <!--持續整合系統的名字,例如continuum -->
        <system />
        <!--該專案使用的持續整合系統的URL(如果持續整合系統有web介面的話)。 -->
        <url />
        <!--構建完成時,需要通知的開發者/使用者的設定項。包括被通知者資訊和通知條件(錯誤,失敗,成功,警告) -->
        <notifiers>
            <!--設定一種方式,當構建中斷時,以該方式通知使用者/開發者 -->
            <notifier>
                <!--傳送通知的途徑 -->
                <type />
                <!--發生錯誤時是否通知 -->
                <sendOnError />
                <!--構建失敗時是否通知 -->
                <sendOnFailure />
                <!--構建成功時是否通知 -->
                <sendOnSuccess />
                <!--發生警告時是否通知 -->
                <sendOnWarning />
                <!--不贊成使用。通知傳送到哪裡 -->
                <address />
                <!--擴充套件設定項 -->
                <configuration />
            </notifier>
        </notifiers>
    </ciManagement>
 
    <!--專案相關郵寄清單資訊 -->
    <mailingLists>
        <!--該元素描述了專案相關的所有郵寄清單。自動產生的網站參照這些資訊。 -->
        <mailingList>
            <!--郵件的名稱 -->
            <name>Demo</name>
            <!--傳送郵件的地址或連結,如果是郵件地址,建立檔案時,mailto: 連結會被自動建立 -->
            <post>nanxs@123.com</post>
            <!--訂閱郵件的地址或連結,如果是郵件地址,建立檔案時,mailto: 連結會被自動建立 -->
            <subscribe>nanxs@123.com</subscribe>
            <!--取消訂閱郵件的地址或連結,如果是郵件地址,建立檔案時,mailto: 連結會被自動建立 -->
            <unsubscribe>nanxs@123.com</unsubscribe>
            <!--你可以瀏覽郵件資訊的URL -->
            <archive>http:/a.b.c/nanxs/demo/dev/</archive>
        </mailingList>
    </mailingLists>

十二、專案的描述性資訊

    <!--專案的問題管理系統(Bugzilla, Jira, Scarab,或任何你喜歡的問題管理系統)的名稱和URL -->
    <issueManagement>
        <!--問題管理系統(例如jira)的名字, -->
        <system>jira</system>
        <!--該專案使用的問題管理系統的URL -->
        <url>http://jira.baidu.com/nanxs</url>
    </issueManagement>
 
    <!--專案建立年份,4位元數位。當產生版權資訊時需要使用這個值。 -->
    <inceptionYear />
 
    <!--專案開發者列表 -->
    <developers>
        <!--某個專案開發者的資訊 -->
        <developer>
            <!--SCM裡專案開發者的唯一識別符號 -->
            <id>HELLO WORLD</id>
            <!--專案開發者的全名 -->
            <name>nanxs</name>
            <!--專案開發者的email -->
            <email>123@abc.com</email>
            <!--專案開發者的主頁的URL -->
            <url />
            <!--專案開發者在專案中扮演的角色,角色元素描述了各種角色 -->
            <roles>
                <role>Project Manager</role>
                <role>Architect</role>
            </roles>
            <!--專案開發者所屬組織 -->
            <organization>demo</organization>
            <!--專案開發者所屬組織的URL -->
            <organizationUrl>http://a.b.com/nanxs</organizationUrl>
            <!--專案開發者屬性,如即時訊息如何處理等 -->
            <properties>
                <dept>No</dept>
            </properties>
            <!--專案開發者所在時區, -11到12範圍內的整數。 -->
            <timezone>-5</timezone>
        </developer>
    </developers>
 
    <!--專案的其他貢獻者列表 -->
    <contributors>
        <!--專案的其他貢獻者。參見developers/developer元素 -->
        <contributor>
            <name />
            <email />
            <url />
            <organization />
            <organizationUrl />
            <roles />
            <timezone />
            <properties />
        </contributor>
    </contributors>
 
    <!--該元素描述了專案所有License列表。 應該只列出該專案的license列表,不要列出依賴專案的license列表 -->
    <!--如果列出多個license,使用者可以選擇它們中的一個而不是接受所有license -->
    <licenses>
        <!--描述了專案的license,用於生成專案的web站點的license頁面,其他一些報表和validation也會用到該元素。 -->
        <license>
            <!--license用於法律上的名稱 -->
            <name>Apache 2</name>
            <!--官方的license正文頁面的URL -->
            <url>http://a.b.com/nanxs/LICENSE-1.0.txt</url>
            <!--專案分發的主要方式: repo,可以從Maven庫下載 manual, 使用者必須手動下載和安裝依賴 -->
            <distribution>repo</distribution>
            <!--關於license的補充資訊 -->
            <comments>A business-friendly OSS license</comments>
        </license>
    </licenses>
 
    <!--SCM(Source Control Management)標籤允許你設定你的程式碼庫,供Maven web站點和其它外掛使用。 -->
    <scm>
        <!--SCM的URL,該URL描述了版本庫和如何連線到版本庫。該連線唯讀 -->
        <connection>scm:svn:http://a.b.com/nanxs</connection>
        <!--給開發者使用的,類似connection元素。即該連線不僅僅唯讀 -->
        <developerConnection>scm:svn:http://a.b.com/nanxs</developerConnection>
        <!--當前程式碼的標籤,在開發階段預設為HEAD -->
        <tag />
        <!--指向專案的可瀏覽SCM庫(例如ViewVC或者Fisheye)的URL。 -->
        <url>http://a.b.com/nanxs</url>
    </scm>
 
    <!--描述專案所屬組織的各種屬性。Maven產生的檔案用 -->
    <organization>
        <!--組織的全名 -->
        <name>demo</name>
        <!--組織主頁的URL -->
        <url>http://a.b.com/nanxs</url>
    </organization>

十三、其他設定

    <!--描述了這個專案構建環境中的前提條件。 -->
    <prerequisites>
        <!--構建該專案或使用該外掛所需要的Maven的最低版本 -->
        <maven />
    </prerequisites>
 
    <!--模組(有時稱作子專案) 被構建成專案的一部分。列出的每個模組元素是指向該模組的目錄的相對路徑 -->
    <modules />
 
    <!--以值替代名稱,Properties可以在整個POM中使用,也可以作為觸發條件(見settings.xml中activation元素的說明) -->
    <!-格式是<name>value</name>。 -->
    <properties />
 
    <!--不推薦使用,現在Maven忽略該元素. -->
    <reports></reports>

以上為個人經驗,希望能給大家一個參考,也希望大家多多支援it145.com。 


IT145.com E-mail:sddin#qq.com