1. 程式人生 > >Maven之pom.xml與setting.xml配置檔案詳解

Maven之pom.xml與setting.xml配置檔案詳解

.pom.xml詳解

 

 

1.概述

 

 

pom中節點如下分佈

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

 

    <!-- 基本配置 -->

    <groupId>

...</groupId>

    <artifactId>...</artifactId>

    <version>...</version>

    <packaging>...</packaging>

 

 

    <!-- 依賴配置 -->

    <dependencies

>...</dependencies>

    <parent>...</parent>

    <dependencyManagement>...</dependencyManagement>

    <modules>...</modules>

    <properties>...</properties>

 

    <!-- 構建配置 -->

    <build>...</build>

    <reporting>...</reporting>

 

    <!-- 專案資訊 -->

    <name>...</name>

    <description>...</description>

    <url>...</url>

    <inceptionYear>...</inceptionYear>

    <licenses>...</licenses>

    <organization>...</organization>

    <developers>...</developers>

    <contributors>...</contributors>

 

    <!-- 環境設定 -->

    <issueManagement>...</issueManagement>

    <ciManagement>...</ciManagement>

    <mailingLists>...</mailingLists>

    <scm>...</scm>

    <prerequisites>...</prerequisites>

    <repositories>...</repositories>

    <pluginRepositories>...</pluginRepositories>

    <distributionManagement>...</distributionManagement>

    <profiles>...</profiles>

</project>

 

 

 

2. 基本配置

 


modelVersionpom模型版本,maven23只能為4.0.0

groupId:組IDmaven用於定位

artifactId:在組中的唯一ID用於定位

version:專案版本

packaging:專案打包方式,有以下值:pom, jar, maven-plugin, ejb, war, ear, rar, par

 

 

 

 

3. 依賴配置

 

 

3.1 parent

 

用於確定父專案的座標。

   <parent>

    <groupId>com.learnPro</groupId>

    <artifactId>SIP-parent</artifactId>

    <relativePath></relativePath>

    <version>0.0.1-SNAPSHOT</version>

</parent>

 

groupId:父專案的構件識別符號

artifactId:父專案的唯一識別符號

relativePathMaven首先在當前專案的找父專案的pom,然後在檔案系統的這個位置(relativePath),然後在本地倉庫,再在遠端倉庫找。

version:父專案的版本


3.2 modules

 

有些maven專案會做成多模組的,這個標籤用於指定當前專案所包含的所有模組。之後對這個專案進行的maven操作,會讓所有子模組也進行相同操作。

 <modules>

   <module>com-a</>

   <module>com-b</>

   <module>com-c</>

</>

 


3.3 properties

 

 

用於定義pom常量

<properties>

    <java.version>1.7</java.version>

</properties>

上面這個常量可以在pom檔案的任意地方通過${java.version}來引用



3.4 dependencies

 

 

專案相關依賴配置,如果在父專案寫的依賴,會被子專案引用,一般父專案會將子專案公用的依賴引入(將在之後詳細講解)

<dependencies> 

    <dependency>

            <groupId>junit</groupId>

            <artifactId>junit</artifactId>

            <version>4.12</version>

    </dependency>

</dependencies>

這邊依賴和中央倉庫中的一致,就可以引入對應的jar

 


3.5 dependencyManagement

 

 

配置寫法同dependencies

<dependencyManagement>

    <dependencies>

    .....

    </dependencies>

</dependencyManagement>

在父模組中定義後,子模組不會直接使用對應依賴,但是在使用相同依賴的時候可以不加版本號:

 

父專案:

<dependencyManagement>

    <dependencies>

        <dependency>

            <groupId>junit</groupId>

            <artifactId>junit</artifactId>

            <version>4.12</version>

            <scope>test</scope>

        </dependency>

    </dependencies>

</dependencyManagement>

子專案:

<dependency>

    <groupId>junit</groupId>

    <artifactId>junit</artifactId>

</dependency>

 

這樣的好處是,父專案統一了版本,而且子專案可以在需要的時候才引用對應的依賴

 

 

 

4. 構建配置


4.1 build

 


用於配置專案構建相關資訊

 <build>    

    <!--該元素設定了專案原始碼目錄,當構建專案的時候,構建系統會編譯目錄裡的原始碼。該路徑是相對於pom.xml的相對路徑。-->    

    <sourceDirectory/>    

    <!--該元素設定了專案指令碼原始碼目錄,該目錄和原始碼目錄不同:絕大多數情況下,該目錄下的內容 會被拷貝到輸出目錄(因為指令碼是被解釋的,而不是被編譯的)。-->    

  <scriptSourceDirectory/>    

  <!--該元素設定了專案單元測試使用的原始碼目錄,當測試專案的時候,構建系統會編譯目錄裡的原始碼。該路徑是相對於pom.xml的相對路徑。-->    

  <testSourceDirectory/>   

 

  <!--被編譯過的應用程式class檔案存放的目錄。-->    

  <outputDirectory/>    

 

  <!--被編譯過的測試class檔案存放的目錄。-->    

  <testOutputDirectory/>   

 

  <!--使用來自該專案的一系列構建擴充套件-->  

  <extensions>    

   <!--描述使用到的構建擴充套件。-->    

   <extension>    

    <!--構建擴充套件的groupId-->    

    <groupId/>    

    <!--構建擴充套件的artifactId-->    

    <artifactId/>    

    <!--構建擴充套件的版本-->    

    <version/>    

   </extension>    

  </extensions>   

 

  <!--當專案沒有規定目標(Maven2 叫做階段)時的預設值-->    

  <defaultGoal/>    

  <!--這個元素描述了專案相關的所有資源路徑列表,例如和專案相關的屬性檔案,這些資源被包含在最終的打包檔案裡。-->    

 

  <resources>    

   <!--這個元素描述了專案相關或測試相關的所有資源路徑-->    

   <resource>    

    <!-- 描述了資源的目標路徑。該路徑相對target/classes目錄(例如${project.build.outputDirectory})。舉個例 子,如果你想資源在特定的包裡(org.apache.maven.messages),你就必須該元素設定為org/apache/maven /messages。然而,如果你只是想把資源放到原始碼目錄結構裡,就不需要該配置。-->    

    <targetPath/>    

    <!--是否使用引數值代替引數名。引數值取自properties元素或者檔案裡配置的屬性,檔案在filters元素裡列出。-->    

    <filtering/>    

    <!--描述存放資源的目錄,該路徑相對POM路徑-->    

    <directory/>    

    <!--包含的模式列表,例如**/*.xml.-->    

    <includes/>    

    <!--排除的模式列表,例如**/*.xml-->    

    <excludes/>    

   </resource>    

  </resources>    

 

 

  <!--這個元素描述了單元測試相關的所有資源路徑,例如和單元測試相關的屬性檔案。-->    

  <testResources>    

   <!--這個元素描述了測試相關的所有資源路徑,參見build/resources/resource元素的說明-->    

   <testResource>    

    <targetPath/><filtering/><directory/><includes/><excludes/>    

   </testResource>    

  </testResources>    

 

  <!--構建產生的所有檔案存放的目錄-->    

  <directory/> 

   

  <!--產生的構件的檔名,預設值是${artifactId}-${version}。-->    

  <finalName/>  

  

  <!--當filtering開關開啟時,使用到的過濾器屬性檔案列表-->    

  <filters/>    

  <!--子專案可以引用的預設外掛資訊。該外掛配置項直到被引用時才會被解析或繫結到生命週期。給定外掛的任何本地配置都會覆蓋這裡的配置-->    

 

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

 </build>

 

 

 

4.2 reporting

 

 

該元素描述使用報表外掛產生報表的規範。當用戶執行mvn site”,這些報表就會執行。 在頁面導航欄能看到所有報表的連結。

<reporting>

  <!--true,則,網站不包括預設的報表。這包括“專案資訊”選單中的報表。-->    

  <excludeDefaults/>    

  <!--所有產生的報表存放到哪裡。預設值是${project.build.directory}/site。-->    

  <outputDirectory/>    

  <!--使用的報表外掛和他們的配置。-->    

  <plugins>    

   <!--plugin元素包含描述報表外掛需要的資訊-->    

   <plugin>    

    <!--報表外掛在倉庫裡的group ID-->    

    <groupId/>    

    <!--報表外掛在倉庫裡的artifact ID-->    

    <artifactId/>    

    <!--被使用的報表外掛的版本(或版本範圍)-->    

    <version/>    

    <!--任何配置是否被傳播到子專案-->    

    <inherited/>    

    <!--報表外掛的配置-->    

    <configuration/>    

    <!--一組報表的多重規範,每個規範可能有不同的配置。一個規範(報表集)對應一個執行目標 。例如,有1,2,3,4,5,6,7,8,9個報表。1,2,5構成A報表集,對應一個執行目標。2,5,8構成B報表集,對應另一個執行目標-->    

    <reportSets>    

     <!--表示報表的一個集合,以及產生該集合的配置-->    

     <reportSet>    

      <!--報表集合的唯一識別符號,POM繼承時用到-->    

      <id/>    

      <!--產生報表集合時,被使用的報表的配置-->    

      <configuration/>    

      <!--配置是否被繼承到子POMs-->    

      <inherited/>    

      <!--這個集合裡使用到哪些報表-->    

      <reports/>    

     </reportSet>    

    </reportSets>    

   </plugin>    

  </plugins>    

 </reporting>

 

 

 

5. 專案資訊

 

 

 

name:給使用者提供更為友好的專案名

description:專案描述,maven文件中儲存

url:主頁的URLmaven文件中儲存

inceptionYear:專案建立年份,4位數字。當產生版權資訊時需要使用這個值

licenses:該元素描述了專案所有License列表。 應該只列出該專案的license列表,不要列出依賴專案的license列表。如果列出多個license,使用者可以選擇它們中的一個而不是接受所有license。(如下)

<license>

    <!--license用於法律上的名稱-->    

    <name>...</name>     

    <!--官方的license正文頁面的URL-->    

    <url>....</url>

    <!--專案分發的主要方式:repo,可以從Maven庫下載 manual, 使用者必須手動下載和安裝依賴-->    

    <distribution>repo</distribution>     

    <!--關於license的補充資訊-->    

    <comments>....</comments>     

</license> 

 

organization1.name組織名2.url組織主頁url

developers:專案開發人員列表(如下)

contributors:專案其他貢獻者列表,同developers

<developers>

    <!--某個開發者資訊-->

    <developer>  

        <!--開發者的唯一識別符號-->

        <id>....</id>  

        <!--開發者的全名-->

        <name>...</name>  

        <!--開發者的email-->

        <email>...</email>  

        <!--開發者的主頁-->

        <url>...<url/>

        <!--開發者在專案中的角色-->

        <roles>  

            <role>Java Dev</role>  

            <role>Web UI</role>  

        </roles> 

        <!--開發者所屬組織--> 

        <organization>sun</organization>  

        <!--開發者所屬組織的URL-->

        <organizationUrl>...</organizationUrl>  

        <!--開發者屬性,如即時訊息如何處理等-->

        <properties>

            <!-- 和主標籤中的properties一樣,可以隨意定義子標籤 -->

        </properties> 

        <!--開發者所在時區, -11到12範圍內的整數。--> 

        <timezone>-5</timezone>  

    </developer>  

</developers>  

 

 

 

6.環境設定

 


6.1 issueManagement

 

 

目的問題管理系統(Bugzilla, Jira, Scarab)的名稱和URL

 

<issueManagement>

    <system>Bugzilla</system>

    <url>http://127.0.0.1/bugzilla/</url>

</issueManagement>

system:系統型別

url:路徑

 

 

 


6.2 ciManagement

 

 

 

專案的持續整合資訊

 <ciManagement>

    <system>continuum</system>

    <url>http://127.0.0.1:8080/continuum</url>

    <notifiers>

      <notifier>

        <type>mail</type>

        <sendOnError>true</sendOnError>

        <sendOnFailure>true</sendOnFailure>

        <sendOnSuccess>false</sendOnSuccess>

        <sendOnWarning>false</sendOnWarning>

        <address>[email protected]</address>

        <configuration></configuration>

      </notifier>

    </notifiers>

  </ciManagement>

system:持續整合系統的名字

url:持續整合系統的URL

notifiers:構建完成時,需要通知的開發者/使用者的配置項。包括被通知者資訊和通知條件(錯誤,失敗,成功,警告)

type:通知方式

sendOnError:錯誤時是否通知

sendOnFailure:失敗時是否通知

sendOnSuccess:成功時是否通知

sendOnWarning:警告時是否通知

address:通知傳送到的地址

configuration:擴充套件項

 

 

 

6.3 mailingLists

 

 

專案相關郵件列表資訊

  <mailingLists>

    <mailingList>

      <name>User List</name>

      <subscribe>[email protected]</subscribe>

      <unsubscribe>user-unsubscribe@127.0.0.1</unsubscribe>

      <post>[email protected]</post>

      <archive>http://127.0.0.1/user/</archive>

      <otherArchives>

   <otherArchive>http://base.google.com/base/1/127.0.0.1</otherArchive>

      </otherArchives>

    </mailingList>

    .....

  </mailingLists>

 

subscribe, unsubscribe: 訂閱郵件(取消訂閱)的地址或連結,如果是郵件地址,建立文件時,mailto:連結會被自動建立

archive:瀏覽郵件資訊的URL

post:接收郵件的地址

 


 

6.4 scm

 

 

 

允許你配置你的程式碼庫,供Maven web站點和其它外掛使用

  <scm>

    <connection>scm:svn:http://127.0.0.1/svn/my-project</connection>

    <developerConnection>scm:svn:https://127.0.0.1/svn/my-project</developerConnection>

    <tag>HEAD</tag>

    <url>http://127.0.0.1/websvn/my-project</url>

  </scm>

 

connection, developerConnection:這兩個表示我們如何連線到maven的版本庫。connection只提供讀,developerConnection將提供寫的請求

寫法如:scm:[provider]:[provider_specific]

如果連線到CVS倉庫,可以配置如下:scm:cvs:pserver:127.0.0.1:/cvs/root:my-project

tag:專案標籤,預設HEAD

url:共有倉庫路徑

 

 


6.5 prerequisites

 

 

 

專案構建的前提

<prerequisites>

    <maven>2.0.6</maven>

</prerequisites>

 

 


6.6 repositories,pluginRepositories

 

 

 

依賴和擴充套件的遠端倉庫列表,同setting.xml配置中介紹的。

  <repositories>

    <repository>

      <releases>

        <enabled>false</enabled>

        <updatePolicy>always</updatePolicy>

        <checksumPolicy>warn</checksumPolicy>

      </releases>

      <snapshots>

        <enabled>true</enabled>

        <updatePolicy>never</updatePolicy>

        <checksumPolicy>fail</checksumPolicy>

      </snapshots>

      <id>codehausSnapshots</id>

      <name>Codehaus Snapshots</name>

      <url>http://snapshots.maven.codehaus.org/maven2</url>

      <layout>default</layout>

    </repository>

  </repositories>

  <pluginRepositories>

    ...

  </pluginRepositories>

releases, snapshots:這是各種構件的策略,release或者snapshot。這兩個集合,POM就可以根據獨立倉庫任意型別的依賴改變策略。如:一個人可能只啟用下載snapshot用來開發。

enabletrue或者false,決定倉庫是否對於各自的型別啟用(release或者snapshot)

updatePolicy: 這個元素決定更新頻率。maven將比較本地pom的時間戳(儲存在倉庫的maven資料檔案中)和遠端的.有以下選擇: always, daily (預設), interval:X (x是代表分鐘的整型)never.

checksumPolicy:當Maven向倉庫部署檔案的時候,它也部署了相應的校驗和檔案。可選的為:ignorefailwarn,或者不正確的校驗和。

layout:在上面描述倉庫的時候,提到他們有統一的佈局。Maven 2有它倉庫預設佈局。然而,Maven 1.x有不同佈局。使用這個元素來表明它是default還是legacy

 

 


 

6.7 distributionManagement

 

 

 

它管理的分佈在整個構建過程生成的工件和支援檔案

   <distributionManagement>

    ...

    <downloadUrl>http://mojo.codehaus.org/my-project</downloadUrl>

    <status>deployed</status>

  </distributionManagement>

 

downloadUrl: 其他pom<