settings.xml配置詳解

簡單值

一半頂層settings元素是簡單值，它們表示的一系列值可以配置Maven的核心行為：settings.xml中的簡單頂層元素

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

< localRepository>/ebs1/build-machine/usr/local/hudson/hudson-home/jobs/maven-guide-< /localRepository>
< interactiveMode>true< /interactiveMode>
< usePluginRegistry>false</usePluginRegistry >
< offline>false</offline>
< pluginGroups>
　　< pluginGroup>org.codehaus.mojo</pluginGroup >
　　<pluginGroup>org.codehaus.cargo</pluginGroup>
< /pluginGroups>
...
< /settings>

這些簡單頂層元素是：

• localRepository:該值表示構建系統本地倉庫的路徑。其默認值為 /ebs1/build-machine/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/.m2/repository 。
• interactiveMode:如果Maven需要和用戶交互以獲得輸入，則設置成 true ，反之則應為 false。默認為 true。
• usePluginRegistry:如果需要讓Maven使用文件 /ebs1/build-machine/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/.m2/plugin-registry.xml 來管理插件版本，則設為 true 。默認為false 。
• offline:如果構建系統需要在離線模式下運行，則為 true ，默認為false 。當由於網絡設置原因或者安全因素，構建服務器不能連接遠程倉庫的時候，該配置就十分有用。
• pluginGroups:該元素包含一個 pluginGroup 元素列表，每個子元素包含了一個 groupId 。當我們使用某個插件，並且沒有在命令行為其提供 groupId 的時候，Maven就會使用該列表。默認情況下該列表包含了 org.apache.maven.plugins 

服務器（Servers）

POM中的 distributionManagement元素定義了部署的倉庫。然而，一些設置如安全證書不應該和 pom.xml 一起分發。這種類型的信息應該存在於構建服務器上的 settings.xml 文件中。

< servers>
    < server>
        < id>server001</id>
        < username>my_login</username>
        < password>my_password</password >
        < privateKey>${usr.home}/.ssh/id_dsa</privateKey >
        < passphrase>some_passphrase</passphrase >
        < filePermissions>664</filePermissions >
        < directoryPermissions>775</directoryPermissions >
        < configuration></configuration>
    < /server>
< /servers>        

server下的元素包括：

• id:這是server的 id （注意不是用戶登陸的 id），該 id 與distributionManagement 中repository元素的 id 相匹配。
• username, password:這對元素表示服務器認證所需要的登錄名和密碼。
• privateKey, passphrase:和前兩個元素類似，這一對元素指定了一個私鑰的路徑（默認是 /home/hudson/.ssh/id_dsa ）以及如果需要的話，一個密語。將來passphrase和password元素可能會被提取到外部，但目前它們必須在settings.xml 文件以純文本的形式聲明。
• filePermissions, directoryPermissions:如果在部署的時候會創建一個倉庫文件或者目錄，這時候就可以使用權限（permission）。這兩個元素合法的值是一個三位數字，其對應了*nix文件系統的權限，如664，或者775。

鏡像（Mirrors）

< mirrors>
    < mirror>
        <id>repo2</id>    
        <mirrorOf>central</mirrorOf>    
        <name>Human Readable Name for this Mirror.</name>    
        <url>http://repo2.maven.org/maven2/</url>
    < /mirror>
< /mirrors>

•     id, name:該鏡像的唯一定義符。id用來區分不同的mirror元素。
•     url:該鏡像的URL。構建系統會優先考慮使用該URL，而非使用默認的服務器URL。
•     mirrorOf:被鏡像的服務器的id。例如，如果我們要設置了一個Maven中央倉庫（http://repo1.maven.org/maven2）的鏡像，就需要將該元素設置成central。這必須和中央倉庫的id central完全一致。

代理（Proxies）

< proxies>
    < proxy>
    　　< id>myproxy</id>
    　　< 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>

• id:該代理的唯一定義符，用來區分不同的proxy元素。
• active:true 則激活代理。當我們聲明了一組代理，而某個時候只需要激活一個代理的時候，該元素就可以派上用處。
• protocol, host, port:該代理的 protocol://host:port ，（協議://主機名:端口），分隔成離散的元素以方便配置。
• username, password:這一對元素表示代理服務器認證的登錄名和密碼。
• nonProxyHosts:這里定義一個不該被代理的主機名列表。該列表的分隔符由代理服務器指定；上述的例子中使用了豎線分隔符，使用逗號分隔也很常見。

Profiles

settings.xml 中的profile 元素是 pom.xml中 profile 元素的裁剪版本。它包含了 activation, repositories , pluginRepositories 和 properties元素。這里的profile元素只包含這四個子元素是因為這里只關心構建系統這個整體（這正是 settings.xml文件的角色定位），而非單獨的項目對象模型設置。

如果一個settings中的profile被激活，它的值會覆蓋任何其它定義在POM中或者profile.xml中的帶有相同id的profile。

<profiles>
    <profile>
        <id>test</id>
        <activation>
            <activeByDefault>false</activeByDefault>
            <jdk>1.5</jdk>
            <os>
                <name>Windows XP</name>
                <family>Windows</family>
                <arch>x86</arch>
                <version>5.1.2600</version>
            </os>
            <property>
                <name>mavenVersion</name>
                <value>2.0.3</value>
            </property>
            <file>
                <exists>/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/
                </exists>
                <missing>/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/
                </missing>
            </file>
        </activation>
    </profile>
</profiles>

當所有指定的條件符合的時候，profile機會被激活，雖然大部分情況我們不會需要所有的條件。

• jdk:activation通過其jdk元素，提供了一個內置的，Java-核心的檢查器。如果我們運行的一個jdk版本號，這里所配置的值能作為前綴與之匹配，激活就會發生。在上述的例子中，1.5.0_06就能夠匹配。
• os:os 元素可以定義一些操作系統相關的屬性，如上例。
• property:如果Maven檢測到某一個屬性（其值可以在POM中通過${名稱}引用），其擁有對應的名稱和值，Profile就會被激活。
• file:最后，通過提供一個文件名，通過檢測該文件的存在或不存在來激活profile。
• activation 元素並不是激活profile的唯一方式。 settings.xml 文件中的 activeProfile元素可以包含profile的id。profile也可以通過在命令行，使用-P標記和逗號分隔的列表來顯式的激活（如，-P test）

激活（Activation）

Activation是profile的開啟鑰匙。如POM中的profile一樣，profile的力量來自於它能夠在某些特定的環境中自動使用某些特定的值；這些環境通過activation元素指定

屬性（Properties）

Maven屬性和Ant中的屬性一樣，可以用來存放一些值。這些值可以在POM中的任何地方使用標記${X}來使用，這里X是指屬性的名稱。屬性有五種不同的形式，並且都能在settings.xml文件中訪問。

• env.X: 在一個變量前加上"env."的前綴，會返回一個shell環境變量。例如， /usr/lib/jvm/java-1.6.0openjdk1.6.0.0/bin:/usr/local/bin:/usr/local/maven/bin:/usr/kerberos/sbin:/usr/kerberos/bin:/usr/java/latest/bin:/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin:/root/bin:/usr/bin:/usr/local/bin 指代了$path 環境變量（在Windows上是 %PATH% ）。
• project.x：這個點（.）標記的路徑，指代了POM中對應的元素值。
• settings.x: 這個點（.）標記的路徑，指代了settings.xml中對應元素的值。
• Java System Properties: 所有可通過 java.lang.System.getProperties() 訪問的屬性都能在POM中使用該形式訪問，如 /usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0/jre 。
• x: 在<properties/>元素中，或者外部文件中設置，以 ${someVar} 的形式使用

< profiles>
    < profile>
    ...
    < properties>
    < user.install>/ebs1/build-machine/usr/local/hudson/hudson-home/jobs/maven-guide-< /properties>
    ...
    < /profile>
< /profiles>

倉庫（Repositories）

倉庫是Maven用來填充構建系統本地倉庫所使用的一組遠程項目。而Maven是從本地倉庫中使用其插件和依賴。不同的遠程倉庫可能含有不同的項目，而在某個激活的profile下，可能定義了一些倉庫來搜索需要的發布版或快照版構件。

<profiles>
    <profile>
        <repositories>
            <repository>
                <id>codehausSnapshots</id>
                <name>Codehaus Snapshots</name>
                <releases>
                    <enabled>false</enabled>
                    <updatePolicy>always</updatePolicy>
                    <checksumPolicy>warn</checksumPolicy>
                </releases>
                <snapshots>
                    <enabled>true</enabled>
                    <updatePolicy>never</updatePolicy>
                    <checksumPolicy>fail</checksumPolicy>
                </snapshots>
                <url>
                    http://snapshots.maven.codehaus.org/maven2
                </url>
                <layout>default</layout>
            </repository>
        </repositories>
        <pluginRepositories>
        </pluginRepositories>
    </profile>
</profiles>

• releases, snapshots:這里配置了兩種構件，發布版（Release）和快照版（Snapshot）的策略。有了這兩組配置，POM就可以在每個單獨的倉庫中，為每種類型類型的構件采取不同的策略。例如，可能有人會決定只為開發的目的開啟對快照版本下載的支持。
• enabled:true 或者false 表示該倉庫是否為某種類型構件（發布版或者快照版）開啟
• updatePolicy:該元素指定更新發生的頻率。Maven會比較本地POM和遠程POM的時間戳。這里的選項是：always（一直），daily（默認，每日），interval：X（這里X是以分鍾為單位的時間間隔），或者never（從不）。
• checksumPolicy:當Maven將構件部署到倉庫中時，它也會部署對應的校驗和文件。當沒有校驗和文件，或者該文件不正確時，你的選項有ignore（忽略），fail（失敗），或者warn（警告）。
• layout:在上面的倉庫描述中，它們都遵循一個共同的布局。大部分情況都是這樣。Maven 2為其倉庫提供了一個默認的布局；然而，Maven 1.x有一種不同的布局。我們可以使用該元素指定布局是default（默認）還是legacy（遺留）

插件倉庫

倉庫是兩種主要構件的家。第一種構件被用作其它構件的依賴。這是中央倉庫中存儲大部分構件類型。另外一種構件類型是插件。Maven插件是一種特殊類型的構件。由於這個原因，插件倉庫獨立於其它倉庫。 pluginRepositories 元素的結構和 repositories元素的結構類似。每個 pluginRepository 元素指定一個Maven可以用來尋找新插件的遠程地址。

激活的Profile

settings.xml 中最后一需要理解的配置是 activeProfiles 元素。該元素包含了一組 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>