Maven2的配置文件settings.xml
簡介：
概覽
當Maven運行過程中的各種配置，例如pom.xml，不想綁定到一個固定的project或者要分配給用戶時，我們使用settings.xml中的settings元素來確定這些配置。這包含了本地倉庫位置，遠程倉庫服務器以及認證信息等。
settings.xml存在于兩個地方：
1.安裝的地方：$M2_HOME/conf/settings.xml
2.用戶的目錄：${user.home}/.m2/settings.xml
前者又被叫做全局配置，后者被稱為用戶配置。如果兩者都存在，它們的內(nèi)容將被合并，并且用戶范圍的settings.xml優(yōu)先。
如果你偶爾需要創(chuàng)建用戶范圍的settings，你可以簡單的copy Maven安裝路徑下的settings到目錄${user.home}/.m2。Maven默認的settings.xml是一個包含了注釋和例子的模板，你可以快速的修改它來達到你的要求。
下面是settings下的頂層元素的一個概覽：
1 <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" 2 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 3 xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 4 http://maven.apache.org/xsd/settings-1.0.0.xsd"> 5 <localRepository/> 6 <interactiveMode/> 7 <usePluginRegistry/> 8 <offline/> 9 <pluginGroups/> 10 <servers/> 11 <mirrors/> 12 <proxies/> 13 <profiles/> 14 <activeProfiles/> 15 </settings>settings的內(nèi)容可以在下面這些地方篡改：
1.${user.home}和所有其他的系統(tǒng)屬性
2.${env.HOME}等環(huán)境變量
注意：settins.xml中profiles下定義的屬性不能被篡改。
配置細節(jié)：
簡單的值
一半以上的頂級settings元素師簡單的值，代表了一直處于活躍的構建系統(tǒng)的元素的取值范圍。
?
1 <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" 2 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 3 xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 4 http://maven.apache.org/xsd/settings-1.0.0.xsd"> 5 <localRepository>${user.home}/.m2/repository</localRepository> 6 <interactiveMode>true</interactiveMode> 7 <usePluginRegistry>false</usePluginRegistry> 8 <offline>false</offline> 9 ... 10 </settings>localRepository：這個值是構建系統(tǒng)的本地倉庫的路徑。默認的值是${user.home}/.m2/repository.如果一個系統(tǒng)想讓所有登陸的用戶都用同一個本地倉庫的話，這個值是極其有用的。
interactiveMode：如果Maven要試圖與用戶交互來得到輸入就設置為true，否則就設置為false，默認為true。
usePluginRegistry：如果Maven使用${user.home}/.m2/plugin-registry.xml來管理plugin的版本，就設置為true，默認為false。
offline：如果構建系統(tǒng)要在離線模式下工作，設置為true，默認為false。如果構建服務器因為網(wǎng)絡故障或者安全問題不能與遠程倉庫相連，那么這個設置是非常有用的。
插件組
這個元素包含了一系列pluginGroup元素，每個又包含了一個groupId。當一個plugin被使用，而它的groupId沒有被提供的時候，這個列表將被搜索。這個列表自動的包含了org.apache.maven.plugins和org.codehaus.mojo。
?
1 <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" 2 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 3 xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 4 http://maven.apache.org/xsd/settings-1.0.0.xsd"> 5 ... 6 <pluginGroups> 7 <pluginGroup>org.mortbay.jetty</pluginGroup> 8 </pluginGroups> 9 ... 10 </settings>例如，有了上面的配置，Maven命令行可以使用簡單的命令執(zhí)行org.morbay.jetty:jetty-maven-plugin:run，如下
mvn jetty run
服務器
用來下載和部署的倉庫是用POM中的repositories和distributionManagement元素來定義的。但是某些配置例如username和password就不應該隨著pom.xml來分配了。這種類型的信息應該保存在構建服務器中的settings.xml中。
?
1 <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" 2 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 3 xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 4 http://maven.apache.org/xsd/settings-1.0.0.xsd"> 5 ... 6 <servers> 7 <server> 8 <id>server001</id> 9 <username>my_login</username> 10 <password>my_password</password> 11 <privateKey>${user.home}/.ssh/id_dsa</privateKey> 12 <passphrase>some_passphrase</passphrase> 13 <filePermissions>664</filePermissions> 14 <directoryPermissions>775</directoryPermissions> 15 <configuration></configuration> 16 </server> 17 </servers> 18 ... 19 </settings>id：這是Server的ID(不是登錄進來的user)，與Maven想要連接上的repository/mirror中的id元素相匹配。
username，password：這兩個元素成對出現(xiàn)，表示連接這個server需要驗證username和password。
privateKey，passphrase：與前兩個元素一樣，這兩個成對出現(xiàn)，分別指向了一個私鑰(默認的是${user.home}/.ssh/id_dsa)和一個passphrase。passphrase和password元素可能在將來被客觀化，但是現(xiàn)在必須以文本形式在settings.xml中設置。
filePermissions，directoryPermissions：當一個倉庫文件或者目錄在部署階段被創(chuàng)建的時候，就必須用到權限許可。他們合法的值是三個數(shù)字，就像*nix中的文件權限，例如：664，775.
注意：如果你使用了一個私鑰來登錄server，那么password元素必須被省略，否則私鑰將被忽視。
密碼加密
一個新特征：服務器password和passphrase加密已經(jīng)被升到2.1.0+
鏡像
?
1 <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" 2 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 3 xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 4 http://maven.apache.org/xsd/settings-1.0.0.xsd"> 5 ... 6 <mirrors> 7 <mirror> 8 <id>planetmirror.com</id> 9 <name>PlanetMirror Australia</name> 10 <url>http://downloads.planetmirror.com/pub/maven2</url> 11 <mirrorOf>central</mirrorOf> 12 </mirror> 13 </mirrors> 14 ... 15 </settings>id，name：唯一的鏡像標識和用戶友好的鏡像名稱。id被用來區(qū)分mirror元素，并且當連接時候被用來獲得相應的證書。
url：鏡像基本的URL，構建系統(tǒng)敬將使用這個URL來連接倉庫，而不是原來的倉庫URL。
mirrorOf：鏡像所包含的倉庫的Id。例如，指向Maven central倉庫的鏡像(http://repo1.maven.org/maven2/)，設置這個元素為central。更多的高級映射例如repo1,repo2 或者*,!inhouse都是可以的。沒必要一定和mirror的id相匹配。
代理
?
1 <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" 2 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 3 xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 4 http://maven.apache.org/xsd/settings-1.0.0.xsd"> 5 ... 6 <proxies> 7 <proxy> 8 <id>myproxy</id> 9 <active>true</active> 10 <protocol>http</protocol> 11 <host>proxy.somewhere.com</host> 12 <port>8080</port> 13 <username>proxyuser</username> 14 <password>somepassword</password> 15 <nonProxyHosts>*.google.com|ibiblio.org</nonProxyHosts> 16 </proxy> 17 </proxies> 18 ... 19 </settings>id：proxy的唯一標識，用來區(qū)別proxy元素。
active：當proxy被激活的時候為true。當申明的代理很多的時候，這個很有用，但是同一時間僅有一個被激活。
protocol，host，port：代理地址protocol://host:port的分散形式。
username，password：兩個元素成對出現(xiàn)，提供連接proxy服務器時的認證。
nonProxyHosts：這里列出了不需要使用代理的hosts。列表的分隔符是proxy服務器想要的類型。上面例子使用了pipe分隔符，逗號分隔符也比較通用。
配置文件
settings.xml中的profile是pom.xml中的profile的簡潔形式。它包含了激活(activation)，倉庫(repositories)，插件倉庫(pluginRepositories)和屬性(properties)元素。profile元素僅包含這四個元素是因為他們涉及到整個的構建系統(tǒng)，而不是個別的POM配置。
如果settings中的profile被激活，那么它的值將重載POM或者profiles.xml中的任何相等ID的profiles。
激活(activation)
activations是profile的關鍵，就像POM中的profiles，profile的能力在于它在特定情況下可以修改一些值。而這些情況是通過activation來指定的。
?
1 <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" 2 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 3 xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 4 http://maven.apache.org/xsd/settings-1.0.0.xsd"> 5 ... 6 <profiles> 7 <profile> 8 <id>test</id> 9 <activation> 10 <activeByDefault>false</activeByDefault> 11 <jdk>1.5</jdk> 12 <os> 13 <name>Windows XP</name> 14 <family>Windows</family> 15 <arch>x86</arch> 16 <version>5.1.2600</version> 17 </os> 18 <property> 19 <name>mavenVersion</name> 20 <value>2.0.3</value> 21 </property> 22 <file> 23 <exists>${basedir}/file2.properties</exists> 24 <missing>${basedir}/file1.properties</missing> 25 </file> 26 </activation> 27 ... 28 </profile> 29 </profiles> 30 ... 31 </settings>如果所有指定的條件都達到了，那么，activation就被觸發(fā)，而且不需要一次性全部達到。
jdk：在jdk元素中，activation有一個內(nèi)建的，java版本檢測。如果檢測到jdk版本與期待的一樣，那么就激活。在上面的例子中，1.5.0_06是滿足的。
os：os元素可以定義一些上面所示的操作系統(tǒng)特定的屬性。
property：如果Maven檢測到相應的名值對的屬性，那么，這個profile將被激活。
file：如果給定的文件存在，或者不存在那么將激活這個profile。
activation并不是唯一激活profile的途徑。settings.xml中的activeProfile包含了profile的id。他們也可以通過命令行來顯式的激活，例如-P test。
如果你想查看在一個構建過程中有哪些profile會被激活。就使用maven-help-plugin
mvn help:active-profiles
屬性(properites)
Maven的屬性是值占位符，就像Ant中的屬性。如果X是一個屬性的話，那么它的值在POM中可以使用${X}來進行任意地方的訪問。他們來自于五種不同的風格，所有都可以從settings.xml文件中訪問到。
1.env.X：使用“env.”前綴將會返回當前的環(huán)境變量。例如${env.PATH}就是使用了$path環(huán)境變量。
2.project.X：一個點“.”分割的路徑，在POM中就是相關的元素的值。例如：<project><version>1.0</version></project>就可以通過${project.version}來訪問。
3.settings.X：一個點“.”分割的路徑，在settings.xml中就是相對應的元素的值，例如：<settings><offline>false</offline></settings>就可以通過${settings.offline}來訪問。
4.Java系統(tǒng)屬性：所有通過java.lang.System.getProperties()來訪問的屬性都可以像POM中的屬性一樣訪問，例如：${java.home}
5.X：被<properties/>或者外部文件定義的屬性，值可以這樣訪問${someVar}
?
1 <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" 2 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 3 xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 4 http://maven.apache.org/xsd/settings-1.0.0.xsd"> 5 ... 6 <profiles> 7 <profile> 8 ... 9 <properties> 10 <user.install>${user.home}/our-project</user.install> 11 </properties> 12 ... 13 </profile> 14 </profiles> 15 ... 16 </settings>如果這個profile被激活，那么屬性${user.install}就可以被訪問了。
倉庫(repositories)
倉庫是Maven用來構筑構建系統(tǒng)的本地倉庫的遠程項目集合。它來自于被Maven叫做插件和依賴的本地倉庫。不同的遠程倉庫包含不同的項目，當profile被激活，他們就會需找匹配的release或者snapshot構件。
?
1 <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" 2 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 3 xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 4 http://maven.apache.org/xsd/settings-1.0.0.xsd"> 5 ... 6 <profiles> 7 <profile> 8 ... 9 <repositories> 10 <repository> 11 <id>codehausSnapshots</id> 12 <name>Codehaus Snapshots</name> 13 <releases> 14 <enabled>false</enabled> 15 <updatePolicy>always</updatePolicy> 16 <checksumPolicy>warn</checksumPolicy> 17 </releases> 18 <snapshots> 19 <enabled>true</enabled> 20 <updatePolicy>never</updatePolicy> 21 <checksumPolicy>fail</checksumPolicy> 22 </snapshots> 23 <url>http://snapshots.maven.codehaus.org/maven2</url> 24 <layout>default</layout> 25 </repository> 26 </repositories> 27 <pluginRepositories> 28 ... 29 </pluginRepositories> 30 ... 31 </profile> 32 </profiles> 33 ... 34 </settings>releases，snapshots：這是各種構件的策略，release或者snapshot。因了這兩個集合，POM可以在單個的倉庫中不依賴于另外一個的策略而改變當前策略。例如：一個人可能只下載snapshot用來開發(fā)。
enable：true或者false，來標記倉庫是否為各自的類型激活(release 或者 snapshot)。
updatePolicy：這個元素指明了更新的頻率。Maven會比較本地POM與遠程的時間戳。可選的項目為：always，daily，interval:X，nerver。
checksumPolicy：當Maven向倉庫部署文件的時候，它也部署了相應的校驗和文件。可選的為：ignore，fail，warn，或者不正確的校驗和。
layout：在上面描述倉庫的時候，我們提到他們有統(tǒng)一的布局。這完全正確。使用這個來表明它是default還是legacy。
插件倉庫(plugin repositories)
倉庫包含了兩種重要類型的構件。第一種是用來做其他構件依賴的構件，這是在中央倉庫中的大多數(shù)插件。另外一種類型的構件就是插件。Maven的插件本身就是一種特殊的構件。因此，插件倉庫被從其他倉庫中分離出來。無論怎么說，pluginRepositories元素模塊的結構與repositories模塊很相似。pluginRepository元素指向一個可以找到新插件的遠程地址。
激活配置(Active Profiles)
?
1 <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" 2 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 3 xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 4 http://maven.apache.org/xsd/settings-1.0.0.xsd"> 5 ... 6 <activeProfiles> 7 <activeProfile>env-test</activeProfile> 8 </activeProfiles> 9 </settings>settings.xml最后一個謎題是activeProfiles元素。它包含一系列的activeProfile元素，每個都有一個profile id的值，任何profile id被定義到activeProfile的profile將被激活，不管其他的環(huán)境設置怎么樣。如果沒有匹配的profile被找到，那么就什么事情也不做。例如：如果env-test是一個activeProfile，一個在pom.xml或者profile.xml中的具有相應id的profile將被激活。如果沒有這樣的profile被找到，就什么事也不做，一切照常。
與50位技術專家面對面20年技術見證，附贈技術全景圖總結
以上是生活随笔為你收集整理的Maven2的配置文件settings.xml的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 木瓜的家常做法？
- 下一篇： 2.Maven特点，Maven约定，建立