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

Maven之setting.xml配置檔案詳解

setting.xml配置檔案
maven的配置檔案settings.xml存在於兩個地方:

1.安裝的地方:${M2_HOME}/conf/settings.xml

2.使用者的目錄:${user.home}/.m2/settings.xml

前者又被叫做全域性配置,對作業系統的所有使用者生效;後者被稱為使用者配置,只對當前作業系統的使用者生效。如果兩者都存在,它們的內容將被合併,並且使用者範圍的settings.xml會覆蓋全域性的settings.xml。

Maven安裝後,使用者目錄下不會自動生成settings.xml,只有全域性配置檔案。如果需要建立使用者範圍的settings.xml,可以將安裝路徑下的settings複製到目錄${user.home}/.m2/。Maven預設的settings.xml是一個包含了註釋和例子的模板,可以快速的修改它來達到你的要求。

全域性配置一旦更改,所有的使用者都會受到影響,而且如果maven進行升級,所有的配置都會被清除,所以要提前複製和備份${M2_HOME}/conf/settings.xml檔案,一般情況下不推薦配置全域性的settings.xml。

<?xml version="1.0" encoding="UTF-8"?>  

<settings   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/settings-1.0.0.xsd">
<!--本地倉庫。該值表示構建系統本地倉庫的路徑。其預設值為${user.home}/.m2/repository。 --> <localRepository>usr/local/maven</localRepository> <!--Maven是否需要和使用者互動以獲得輸入。如果Maven需要和使用者互動以獲得輸入,則設定成true,反之則應為false。預設為true。 -->
<interactiveMode>true</interactiveMode> <!--Maven是否需要使用plugin-registry.xml檔案來管理外掛版本。 --> <!--如果設定為true,則在{user.home}/.m2下需要有一個plugin-registry.xml來對plugin的版本進行管理 --> <!--預設為false。 --> <usePluginRegistry>false</usePluginRegistry> <!--表示Maven是否需要在離線模式下執行。如果構建系統需要在離線模式下執行,則為true,預設為false。 --> <!--當由於網路設定原因或者安全因素,構建伺服器不能連線遠端倉庫的時候,該配置就十分有用。 --> <offline>false</offline> <!--當外掛的組織Id(groupId)沒有顯式提供時,供搜尋外掛組織Id(groupId)的列表。 --> <!--該元素包含一個pluginGroup元素列表,每個子元素包含了一個組織Id(groupId)。 --> <!--當我們使用某個外掛,並且沒有在命令列為其提供組織Id(groupId)的時候,Maven就會使用該列表。 --> <!--預設情況下該列表包含了org.apache.maven.plugins。 --> <pluginGroups> <!--plugin的組織Id(groupId) --> <pluginGroup>org.codehaus.mojo</pluginGroup> </pluginGroups> <!--用來配置不同的代理,多代理profiles可以應對筆記本或移動裝置的工作環境:通過簡單的設定profile id就可以很容易的更換整個代理配置。 --> <proxies> <!--代理元素包含配置代理時需要的資訊 --> <proxy> <!--代理的唯一定義符,用來區分不同的代理元素。 --> <id>myproxy</id> <!--該代理是否是啟用的那個。true則啟用代理。當我們聲明瞭一組代理,而某個時候只需要啟用一個代理的時候,該元素就可以派上用處。 --> <active>true</active> <!--代理的協議。 協議://主機名:埠,分隔成離散的元素以方便配置。 --> <protocol>http://…</protocol> <!--代理的主機名。協議://主機名:埠,分隔成離散的元素以方便配置。 --> <host>proxy.somewhere.com</host> <!--代理的埠。協議://主機名:埠,分隔成離散的元素以方便配置。 --> <port>8080</port> <!--代理的使用者名稱,使用者名稱和密碼錶示代理伺服器認證的登入名和密碼。 --> <username>proxyuser</username> <!--代理的密碼,使用者名稱和密碼錶示代理伺服器認證的登入名和密碼。 --> <password>somepassword</password> <!--不該被代理的主機名列表。該列表的分隔符由代理伺服器指定;例子中使用了豎線分隔符,使用逗號分隔也很常見。 --> <nonProxyHosts>*.google.com|ibiblio.org</nonProxyHosts> </proxy> </proxies> <!--配置服務端的一些設定。一些設定如安全證書不應該和pom.xml一起分發。這種型別的資訊應該存在於構建伺服器上的settings.xml檔案中。 --> <servers> <!--伺服器元素包含配置伺服器時需要的資訊 --> <server> <!--這是server的id(注意不是使用者登陸的id),該id與distributionManagement中repository元素的id相匹配。 --> <id>server001</id> <!--鑑權使用者名稱。鑑權使用者名稱和鑑權密碼錶示伺服器認證所需要的登入名和密碼。 --> <username>my_login</username> <!--鑑權密碼 。鑑權使用者名稱和鑑權密碼錶示伺服器認證所需要的登入名和密碼。 --> <password>my_password</password> <!--鑑權時使用的私鑰位置。和前兩個元素類似,私鑰位置和私鑰密碼指定了一個私鑰的路徑(預設是/home/hudson/.ssh/id_dsa)以及如果需要的話,一個金鑰 --> <!--將來passphrase和password元素可能會被提取到外部,但目前它們必須在settings.xml檔案以純文字的形式宣告。 --> <privateKey>${usr.home}/.ssh/id_dsa</privateKey> <!--鑑權時使用的私鑰密碼。 --> <passphrase>some_passphrase</passphrase> <!--檔案被建立時的許可權。如果在部署的時候會建立一個倉庫檔案或者目錄,這時候就可以使用許可權(permission)。--> <!--這兩個元素合法的值是一個三位數字,其對應了unix檔案系統的許可權,如664,或者775。 --> <filePermissions>664</filePermissions> <!--目錄被建立時的許可權。 --> <directoryPermissions>775</directoryPermissions> <!--傳輸層額外的配置項 --> <configuration></configuration> </server> </servers> <!--為倉庫列表配置的下載映象列表。 --> <mirrors> <!--給定倉庫的下載映象。 --> <mirror> <!--該映象的唯一識別符號。id用來區分不同的mirror元素。 --> <id>planetmirror.com</id> <!--映象名稱 --> <name>PlanetMirror Australia</name> <!--該映象的URL。構建系統會優先考慮使用該URL,而非使用預設的伺服器URL。 --> <url>http://downloads.planetmirror.com/pub/maven2</url> <!--被映象的伺服器的id。例如,如果我們要設定了一個Maven中央倉庫(http://repo1.maven.org/maven2)的映象,--> <!--就需要將該元素設定成central。這必須和中央倉庫的id central完全一致。 --> <mirrorOf>central</mirrorOf> </mirror> </mirrors> <!--根據環境引數來調整構建配置的列表。settings.xml中的profile元素是pom.xml中profile元素的裁剪版本。--> <!--它包含了id,activation, repositories, pluginRepositories和 properties元素。--> <!--這裡的profile元素只包含這五個子元素是因為這裡只關心構建系統這個整體(這正是settings.xml檔案的角色定位),而非單獨的專案物件模型設定。--> <!--如果一個settings中的profile被啟用,它的值會覆蓋任何其它定義在POM中或者profile.xml中的帶有相同id的profile。 --> <profiles> <!--根據環境引數來調整的構件的配置 --> <profile> <!--該配置的唯一識別符號。 --> <id>test</id> <!--自動觸發profile的條件邏輯。Activation是profile的開啟鑰匙。--> <!--如POM中的profile一樣,profile的力量來自於它能夠在某些特定的環境中自動使用某些特定的值;這些環境通過activation元素指定。--> <!--activation元素並不是啟用profile的唯一方式。settings.xml檔案中的activeProfile元素可以包含profile的id。--> <!--profile也可以通過在命令列,使用-P標記和逗號分隔的列表來顯式的啟用(如,-P test)。 --> <activation> <!--profile預設是否啟用的標識 --> <activeByDefault>false</activeByDefault> <!--activation有一個內建的java版本檢測,如果檢測到jdk版本與期待的一樣,profile被啟用。 --> <jdk>1.7</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/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/</exists> <!--如果指定的檔案不存在,則啟用profile。 --> <missing>/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/</missing> </file> </activation> <!--對應profile的擴充套件屬性列表。Maven屬性和Ant中的屬性一樣,可以用來存放一些值。這些值可以在POM中的任何地方使用標記${X}來使用,這裡X是指屬性的名稱。--> <!--屬性有五種不同的形式,並且都能在settings.xml檔案中訪問。 --> <!--1. env.X: 在一個變數前加上"env."的字首,會返回一個shell環境變數。例如,"env.PATH"指代了$path環境變數(在Windows上是%PATH%)。 --> <!--2. project.x:指代了POM中對應的元素值。 --> <!--3. settings.x: 指代了settings.xml中對應元素的值。 --> <!--4. Java System Properties: 所有可通過java.lang.System.getProperties()訪問的屬性都能在POM中使用該形式訪問, --> <!-- 如/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0/jre。 --> <!--5. x: 在<properties/>元素中,或者外部檔案中設定,以${someVar}的形式使用。 --> <properties> <!-- 如果這個profile被啟用,那麼屬性${user.install}就可以被訪問了 --> <user.install>usr/local/winner/jobs/maven-guide</user.install> </properties> <!--遠端倉庫列表,它是Maven用來填充構建系統本地倉庫所使用的一組遠端專案。 --> <repositories> <!--包含需要連線到遠端倉庫的資訊 --> <repository> <!--遠端倉庫唯一標識 --> <id>codehausSnapshots</id> <!--遠端倉庫名稱 --> <name>Codehaus Snapshots</name> <!--如何處理遠端倉庫裡釋出版本的下載 --> <releases> <!--true或者false表示該倉庫是否為下載某種型別構件(釋出版,快照版)開啟。 --> <enabled>false</enabled> <!--該元素指定更新發生的頻率。Maven會比較本地POM和遠端POM的時間戳。這裡的選項是:--> <!--always(一直),daily(預設,每日),interval:X(這裡X是以分鐘為單位的時間間隔),或者never(從不)。 --> <updatePolicy>always</updatePolicy> <!--當Maven驗證構件校驗檔案失敗時該怎麼做:--> <!--ignore(忽略),fail(失敗),或者warn(警告)。 --> <checksumPolicy>warn</checksumPolicy> </releases> <!--如何處理遠端倉庫裡快照版本的下載。有了releases和snapshots這兩組配置,POM就可以在每個單獨的倉庫中,為每種型別的構件採取不同的策略。--> <!--例如,可能有人會決定只為開發目的開啟對快照版本下載的支援。參見repositories/repository/releases元素 --> <snapshots> <enabled /> <updatePolicy /> <checksumPolicy /> </snapshots> <!--遠端倉庫URL,按protocol://hostname/path形式 --> <url>http://snapshots.maven.codehaus.org/maven2</url> <!--用於定位和排序構件的倉庫佈局型別-可以是default(預設)或者legacy(遺留)。--> <!--Maven 2為其倉庫提供了一個預設的佈局;然而,Maven 1.x有一種不同的佈局。我們可以使用該元素指定佈局是default(預設)還是legacy(遺留)。 --> <layout>default</layout> </repository> </repositories> <!--發現外掛的遠端倉庫列表。倉庫是兩種主要構件的家。第一種構件被用作其它構件的依賴。這是中央倉庫中儲存的大部分構件型別。另外一種構件型別是外掛。--> <!--Maven外掛是一種特殊型別的構件。由於這個原因,外掛倉庫獨立於其它倉庫。pluginRepositories元素的結構和repositories元素的結構類似。--> <!--每個pluginRepository元素指定一個Maven可以用來尋找新外掛的遠端地址。 --> <pluginRepositories> <!--包含需要連線到遠端外掛倉庫的資訊.參見profiles/profile/repositories/repository元素的說明 --> <pluginRepository> <releases> <enabled /> <updatePolicy /> <checksumPolicy /> </releases> <snapshots> <enabled /> <updatePolicy /> <checksumPolicy /> </snapshots> <id /> <name /> <url /> <layout /> </pluginRepository> </pluginRepositories> <!--手動啟用profiles的列表,按照profile被應用的順序定義activeProfile。 該元素包含了一組activeProfile元素,每個activeProfile都含有一個profile id。--> <!--任何在activeProfile中定義的profile id,不論環境設定如何,其對應的 profile都會被啟用。--> <!--如果沒有匹配的profile,則什麼都不會發生。例如,env-test是一個activeProfile,則在pom.xml(或者profile.xml)中對應id的profile會被啟用。--> <!--如果執行過程中找不到這樣一個profile,Maven則會像往常一樣執行。 --> <activeProfiles> <activeProfile>env-test</activeProfile> </activeProfiles> </profile> </profiles> </settings>

上面的配置檔案對各個節點的含義及作用都有註解。實際應用中,經常使用的是、、、有限幾個節點,其他節點使用預設值足夠應對大部分的應用場景。

節點
在倉庫的配置一節中,已經對setting.xml中的常用節點做了詳細的說明。在這裡需要特別介紹一下的是節點的配置,profile是maven的一個重要特性。

節點包含了啟用(activation),倉庫(repositories),外掛倉庫(pluginRepositories)和屬性(properties)共四個子元素元素。profile元素僅包含這四個元素是因為他們涉及到整個的構建系統,而不是個別的專案級別的POM配置。

profile可以讓maven能夠自動適應外部的環境變化,比如同一個專案,在linux下編譯linux的版本,在win下編譯win的版本等。一個專案可以設定多個profile,也可以在同一時間設定多個profile被啟用(active)的。自動啟用的 profile的條件可以是各種各樣的設定條件,組合放置在activation節點中,也可以通過命令列直接指定。如果認為profile設定比較複雜,可以將所有的profiles內容移動到專門的 profiles.xml 檔案中,不過記得和pom.xml放在一起。

activation節點是設定該profile在什麼條件下會被啟用,常見的條件有如下幾個:

  1. os

判斷作業系統相關的引數,它包含如下可以自由組合的子節點元素

message - 規則失敗之後顯示的訊息

arch - 匹配cpu結構,常見為x86

family - 匹配作業系統家族,常見的取值為:dos,mac,netware,os/2,unix,windows,win9x,os/400等

name - 匹配作業系統的名字

version - 匹配的作業系統版本號

display - 檢測到作業系統之後顯示的資訊

  1. jdk

檢查jdk版本,可以用區間表示。

  1. property

檢查屬性值,本節點可以包含name和value兩個子節點。

  1. file

檢查檔案相關內容,包含兩個子節點:exists和missing,用於分別檢查檔案存在和不存在兩種情況。

如果settings中的profile被啟用,那麼它的值將覆蓋POM或者profiles.xml中的任何相等ID的profiles。

如果想要某個profile預設處於啟用狀態,可以在中將該profile的id放進去。這樣,不論環境設定如何,其對應的 profile都會被啟用。