settings.xml

settings.xml文件可以放在两个地方
• Maven安装目录: $M2_HOME/conf/settings.xml
• 用户特定的Settings文件: ~/.m2/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/>
 <interactiveMode/>
 <usePluginRegistry/>
 <offline/>
 <pluginGroups/>
 <servers/>
 <mirrors/>
 <proxies/>
 <profiles/>
 <activeProfiles/>
</settings>

localRepository
本地仓库，默认存放在~/.m2/repository

interactiveMode
如果Maven需要和用户交互以获得输入，则设置成true，反之则应为false。默认
为true。

usePluginRegistry
如果需要让Maven使用文件
.m2/plugin-registry.xml来管默认为false。

offline
如果构建系统需要在离线模式下运行，则为true，默认为false。当由于网络设
置原因或者安全因素，构建服务器不能连接远程仓库的时候，该配置就十分有
用。理插件版本，则设为true。默认为false。

pluginGroups
该元素包含一个pluginGroup元素列表，每个子元素包含了一个groupId。当我们
使用某个插件，并且没有在命令行为其提供groupId的时候，Maven就会使用该列
表。默认情况下该列表包含了 org.apache.maven.plugins。


POM中的distributionManagement元素定义了部署的仓库。然而，一些设置如安全证书不
应该和pom.xml一起分发。这种类型的信息应该存在于构建服务器上的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">
 ...
 <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>
 ...
</settings>

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）

<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">
 ...
 <mirrors>
 <mirror>
 <id>planetmirror.com</id>
 <name>PlanetMirror Australia</name>
 <url>http://downloads.planetmirror.com/pub/maven2</url>
 <mirrorOf>central</mirrorOf>
 </mirror>
 </mirrors>
 ...
</settings>

id, name
该镜像的唯一定义符。id用来区分不同的mirror元素。
url
该镜像的URL。构建系统会优先考虑使用该URL，而非使用默认的服务器URL。
mirrorOf
被镜像的服务器的id。例如，如果我们要设置了一个Maven中央仓库（ http://
repo1.maven.org/maven2）的镜像，就需要将该元素设置成central。这必须和
中央仓库的id central完全一致。

代理（Proxies）

<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">
 ...
 <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>
 ...
</settings>

d
该代理的唯一定义符，用来区分不同的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。


激活（Activation）
Activation是profile的开启钥匙。如POM中的profile一样，profile的力量来自于它能
够在某些特定的环境中自动使用某些特定的值；这些环境通过activation元素指定。

<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">
 ...
 <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/content-zh/file2.properties</exists>
 <missing>/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/content-zh/file1.properties</missing>
 </file>
 </activation>
 ...
 </profile>
 </profiles>
 ...
</settings>

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）。
要了解在某个特定的构建中哪些profile会激活，可以使用maven-help-plugin。

mvn help:active-profiles



属性（Properties）
Maven属性和Ant中的属性一样，可以用来存放一些值。这些值可以在POM中的任何地方
使用标记${X}来使用，这里X是指属性的名称。属性有五种不同的形式，并且都能在
settings.xml文件中访问。
1. env.X: 在一个变量前加上"env."的前缀，会返回一个shell环境变量。例如， /
usr/lib/jvm/java-1.6.0-openjdk-1.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%）。
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} 的形式使用。

<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">
 ...
 <profiles>
 <profile>
 ...
 <properties>
 <user.install>/ebs1/build-machine/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/our-project</user.install>
 </properties>
 ...
 </profile>
 </profiles>
 ...
</settings>

仓库（Repositories）
仓库是Maven用来填充构建系统本地仓库所使用的一组远程项目。而Maven是从本地仓库
中使用其插件和依赖。不同的远程仓库可能含有不同的项目，而在某个激活的profile
下，可能定义了一些仓库来搜索需要的发布版或快照版构件。

<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">
 ...
 <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>
 ...
</settings>

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 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">
 ...
 <activeProfiles>
 <activeProfile>env-test</activeProfile>
 </activeProfiles>
</settings>

settings.xml中最后一需要理解的配置是activeProfiles元素。该元素包含
了一组activeProfile元素，每个activeProfile都含有一个profile id。任何
在activeProfile中定义的profile id，不论环境设置如何，其对应的profile都
会被激活。如果没有匹配的profile，则什么都不会发生。例如， env-test是一
个activeProfile，则在pom.xml（或者profile.xml）中对应id的profile会被激活。如
果运行过程中找不到这样一个profile，Maven则会像往常一样运行。