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。

1. <?xml version=”1.0″ encoding=”UTF-8″?>
2. <settings   xmlns=”http://maven.apache.org/POM/4.0.0″
3. xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”
4. xsi:schemaLocation=”http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd”>
5. <!–本地仓库。该值表示构建系统本地仓库的路径。其默认值为${user.home}/.m2/repository。  –>
6. <localRepository>usr/local/maven</localRepository>
7. <!–Maven是否需要和用户交互以获得输入。如果Maven需要和用户交互以获得输入，则设置成true，反之则应为false。默认为true。 –>
8. <interactiveMode>true</interactiveMode>
9. <!–Maven是否需要使用plugin-registry.xml文件来管理插件版本。  –>
10. <!–如果设置为true，则在{user.home}/.m2下需要有一个plugin-registry.xml来对plugin的版本进行管理  –>
11. <!–默认为false。 –>
12. <usePluginRegistry>false</usePluginRegistry>
13. <!–表示Maven是否需要在离线模式下运行。如果构建系统需要在离线模式下运行，则为true，默认为false。  –>
14. <!–当由于网络设置原因或者安全因素，构建服务器不能连接远程仓库的时候，该配置就十分有用。  –>
15. <offline>false</offline>
16. <!–当插件的组织Id（groupId）没有显式提供时，供搜寻插件组织Id（groupId）的列表。  –>
17. <!–该元素包含一个pluginGroup元素列表，每个子元素包含了一个组织Id（groupId）。  –>
18. <!–当我们使用某个插件，并且没有在命令行为其提供组织Id（groupId）的时候，Maven就会使用该列表。  –>
19. <!–默认情况下该列表包含了org.apache.maven.plugins。  –>
20. <pluginGroups>
21. <!–plugin的组织Id（groupId）  –>
22. <pluginGroup>org.codehaus.mojo</pluginGroup>
23. </pluginGroups>
24. <!–用来配置不同的代理，多代理profiles可以应对笔记本或移动设备的工作环境：通过简单的设置profile id就可以很容易的更换整个代理配置。  –>
25. <proxies>
26. <!–代理元素包含配置代理时需要的信息 –>
27. <proxy>
28. <!–代理的唯一定义符，用来区分不同的代理元素。 –>
29. <id>myproxy</id>
30. <!–该代理是否是激活的那个。true则激活代理。当我们声明了一组代理，而某个时候只需要激活一个代理的时候，该元素就可以派上用处。  –>
31. <active>true</active>
32. <!–代理的协议。 协议://主机名:端口，分隔成离散的元素以方便配置。 –>
33. <protocol>http://…</protocol>
34. <!–代理的主机名。协议://主机名:端口，分隔成离散的元素以方便配置。   –>
35. <host>proxy.somewhere.com</host>
36. <!–代理的端口。协议://主机名:端口，分隔成离散的元素以方便配置。  –>
37. <port>8080</port>
38. <!–代理的用户名，用户名和密码表示代理服务器认证的登录名和密码。  –>
39. <username>proxyuser</username>
40. <!–代理的密码，用户名和密码表示代理服务器认证的登录名和密码。  –>
41. <password>somepassword</password>
42. <!–不该被代理的主机名列表。该列表的分隔符由代理服务器指定；例子中使用了竖线分隔符，使用逗号分隔也很常见。 –>
43. <nonProxyHosts>*.google.com|ibiblio.org</nonProxyHosts>
44. </proxy>
45. </proxies>
46. <!–配置服务端的一些设置。一些设置如安全证书不应该和pom.xml一起分发。这种类型的信息应该存在于构建服务器上的settings.xml文件中。 –>
47. <servers>
48. <!–服务器元素包含配置服务器时需要的信息  –>
49. <server>
50. <!–这是server的id（注意不是用户登陆的id），该id与distributionManagement中repository元素的id相匹配。 –>
51. <id>server001</id>
52. <!–鉴权用户名。鉴权用户名和鉴权密码表示服务器认证所需要的登录名和密码。  –>
53. <username>my_login</username>
54. <!–鉴权密码 。鉴权用户名和鉴权密码表示服务器认证所需要的登录名和密码。  –>
55. <password>my_password</password>
56. <!–鉴权时使用的私钥位置。和前两个元素类似，私钥位置和私钥密码指定了一个私钥的路径（默认是/home/hudson/.ssh/id_dsa）以及如果需要的话，一个密钥 –>
57. <!–将来passphrase和password元素可能会被提取到外部，但目前它们必须在settings.xml文件以纯文本的形式声明。  –>
58. <privateKey>${usr.home}/.ssh/id_dsa</privateKey>
59. <!–鉴权时使用的私钥密码。 –>
60. <passphrase>some_passphrase</passphrase>
61. <!–文件被创建时的权限。如果在部署的时候会创建一个仓库文件或者目录，这时候就可以使用权限（permission）。–>
62. <!–这两个元素合法的值是一个三位数字，其对应了unix文件系统的权限，如664，或者775。  –>
63. <filePermissions>664</filePermissions>
64. <!–目录被创建时的权限。  –>
65. <directoryPermissions>775</directoryPermissions>
66. <!–传输层额外的配置项  –>
67. <configuration></configuration>
68. </server>
69. </servers>
70. <!–为仓库列表配置的下载镜像列表。  –>
71. <mirrors>
72. <!–给定仓库的下载镜像。  –>
73. <mirror>
74. <!–该镜像的唯一标识符。id用来区分不同的mirror元素。  –>
75. <id>planetmirror.com</id>
76. <!–镜像名称  –>
77. <name>PlanetMirror Australia</name>
78. <!–该镜像的URL。构建系统会优先考虑使用该URL，而非使用默认的服务器URL。  –>
79. <url>http://downloads.planetmirror.com/pub/maven2</url>
80. <!–被镜像的服务器的id。例如，如果我们要设置了一个Maven中央仓库（http://repo1.maven.org/maven2）的镜像，–>
81. <!–就需要将该元素设置成central。这必须和中央仓库的id central完全一致。 –>
82. <mirrorOf>central</mirrorOf>
83. </mirror>
84. </mirrors>
85. <!–根据环境参数来调整构建配置的列表。settings.xml中的profile元素是pom.xml中profile元素的裁剪版本。–>
86. <!–它包含了id，activation, repositories, pluginRepositories和 properties元素。–>
87. <!–这里的profile元素只包含这五个子元素是因为这里只关心构建系统这个整体（这正是settings.xml文件的角色定位），而非单独的项目对象模型设置。–>
88. <!–如果一个settings中的profile被激活，它的值会覆盖任何其它定义在POM中或者profile.xml中的带有相同id的profile。  –>
89. <profiles>
90. <!–根据环境参数来调整的构件的配置 –>
91. <profile>
92. <!–该配置的唯一标识符。  –>
93. <id>test</id>
94. <!–自动触发profile的条件逻辑。Activation是profile的开启钥匙。–>
95. <!–如POM中的profile一样，profile的力量来自于它能够在某些特定的环境中自动使用某些特定的值；这些环境通过activation元素指定。–>
96. <!–activation元素并不是激活profile的唯一方式。settings.xml文件中的activeProfile元素可以包含profile的id。–>
97. <!–profile也可以通过在命令行，使用-P标记和逗号分隔的列表来显式的激活（如，-P test）。 –>
98. <activation>
99. <!–profile默认是否激活的标识 –>
100. <activeByDefault>false</activeByDefault>
101. <!–activation有一个内建的java版本检测，如果检测到jdk版本与期待的一样，profile被激活。 –>
102. <jdk>1.7</jdk>
103. <!–当匹配的操作系统属性被检测到，profile被激活。os元素可以定义一些操作系统相关的属性。 –>
104. <os>
105. <!–激活profile的操作系统的名字  –>
106. <name>Windows XP</name>
107. <!–激活profile的操作系统所属家族(如 ‘windows’)   –>
108. <family>Windows</family>
109. <!–激活profile的操作系统体系结构   –>
110. <arch>x86</arch>
111. <!–激活profile的操作系统版本 –>
112. <version>5.1.2600</version>
113. </os>
114. <!–如果Maven检测到某一个属性（其值可以在POM中通过${名称}引用），其拥有对应的名称和值，Profile就会被激活。–>
115. <!–如果值字段是空的，那么存在属性名称字段就会激活profile，否则按区分大小写方式匹配属性值字段 –>
116. <property>
117. <!–激活profile的属性的名称 –>
118. <name>mavenVersion</name>
119. <!–激活profile的属性的值  –>
120. <value>2.0.3</value>
121. </property>
122. <!–提供一个文件名，通过检测该文件的存在或不存在来激活profile。missing检查文件是否存在，如果不存在则激活profile。–>
123. <!–另一方面，exists则会检查文件是否存在，如果存在则激活profile。 –>
124. <file>
125. <!–如果指定的文件存在，则激活profile。  –>
126. <exists>/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/</exists>
127. <!–如果指定的文件不存在，则激活profile。 –>
128. <missing>/usr/local/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/</missing>
129. </file>
130. </activation>
131. <!–对应profile的扩展属性列表。Maven属性和Ant中的属性一样，可以用来存放一些值。这些值可以在POM中的任何地方使用标记${X}来使用，这里X是指属性的名称。–>
132. <!–属性有五种不同的形式，并且都能在settings.xml文件中访问。   –>
133. <!–1. env.X: 在一个变量前加上”env.”的前缀，会返回一个shell环境变量。例如,”env.PATH”指代了$path环境变量（在Windows上是%PATH%）。  –>
134. <!–2. project.x：指代了POM中对应的元素值。      –>
135. <!–3. settings.x: 指代了settings.xml中对应元素的值。   –>
136. <!–4. Java System Properties: 所有可通过java.lang.System.getProperties()访问的属性都能在POM中使用该形式访问，   –>
137. <!–   如/usr/lib/jvm/java-1.6.0-openjdk-1.6.0.0/jre。      –>
138. <!–5. x: 在<properties/>元素中，或者外部文件中设置，以${someVar}的形式使用。  –>
139. <properties>
140. <!– 如果这个profile被激活，那么属性${user.install}就可以被访问了 –>
141. <user.install>usr/local/winner/jobs/maven-guide</user.install>
142. </properties>
143. <!–远程仓库列表，它是Maven用来填充构建系统本地仓库所使用的一组远程项目。  –>
144. <repositories>
145. <!–包含需要连接到远程仓库的信息  –>
146. <repository>
147. <!–远程仓库唯一标识 –>
148. <id>codehausSnapshots</id>
149. <!–远程仓库名称  –>
150. <name>Codehaus Snapshots</name>
151. <!–如何处理远程仓库里发布版本的下载 –>
152. <releases>
153. <!–true或者false表示该仓库是否为下载某种类型构件（发布版，快照版）开启。   –>
154. <enabled>false</enabled>
155. <!–该元素指定更新发生的频率。Maven会比较本地POM和远程POM的时间戳。这里的选项是：–>
156. <!–always（一直），daily（默认，每日），interval：X（这里X是以分钟为单位的时间间隔），或者never（从不）。  –>
157. <updatePolicy>always</updatePolicy>
158. <!–当Maven验证构件校验文件失败时该怎么做:–>
159. <!–ignore（忽略），fail（失败），或者warn（警告）。 –>
160. <checksumPolicy>warn</checksumPolicy>
161. </releases>
162. <!–如何处理远程仓库里快照版本的下载。有了releases和snapshots这两组配置，POM就可以在每个单独的仓库中，为每种类型的构件采取不同的策略。–>
163. <!–例如，可能有人会决定只为开发目的开启对快照版本下载的支持。参见repositories/repository/releases元素 –>
164. <snapshots>
165. <enabled />
166. <updatePolicy />
167. <checksumPolicy />
168. </snapshots>
169. <!–远程仓库URL，按protocol://hostname/path形式  –>
170. <url>http://snapshots.maven.codehaus.org/maven2</url>
171. <!–用于定位和排序构件的仓库布局类型-可以是default（默认）或者legacy（遗留）。–>
172. <!–Maven 2为其仓库提供了一个默认的布局；然而，Maven 1.x有一种不同的布局。我们可以使用该元素指定布局是default（默认）还是legacy（遗留）。  –>
173. <layout>default</layout>
174. </repository>
175. </repositories>
176. <!–发现插件的远程仓库列表。仓库是两种主要构件的家。第一种构件被用作其它构件的依赖。这是中央仓库中存储的大部分构件类型。另外一种构件类型是插件。–>
177. <!–Maven插件是一种特殊类型的构件。由于这个原因，插件仓库独立于其它仓库。pluginRepositories元素的结构和repositories元素的结构类似。–>
178. <!–每个pluginRepository元素指定一个Maven可以用来寻找新插件的远程地址。 –>
179. <pluginRepositories>
180. <!–包含需要连接到远程插件仓库的信息.参见profiles/profile/repositories/repository元素的说明 –>
181. <pluginRepository>
182. <releases>
183. <enabled />
184. <updatePolicy />
185. <checksumPolicy />
186. </releases>
187. <snapshots>
188. <enabled />
189. <updatePolicy />
190. <checksumPolicy />
191. </snapshots>
192. <id />
193. <name />
194. <url />
195. <layout />
196. </pluginRepository>
197. </pluginRepositories>
198. <!–手动激活profiles的列表，按照profile被应用的顺序定义activeProfile。 该元素包含了一组activeProfile元素，每个activeProfile都含有一个profile id。–>
199. <!–任何在activeProfile中定义的profile id，不论环境设置如何，其对应的 profile都会被激活。–>
200. <!–如果没有匹配的profile，则什么都不会发生。例如，env-test是一个activeProfile，则在pom.xml（或者profile.xml）中对应id的profile会被激活。–>
201. <!–如果运行过程中找不到这样一个profile，Maven则会像往常一样运行。  –>
202. <activeProfiles>
203. <activeProfile>env-test</activeProfile>
204. </activeProfiles>
205. </profile>
206. </profiles>
207. </settings>

上面的配置文件对各个节点的含义及作用都有注解。实际应用中，经常使用的是<localRepository>、<servers>、<mirrors>、<profiles>有限几个节点，其他节点使用默认值足够应对大部分的应用场景。

<profile>节点

在仓库的配置一节中，已经对setting.xml中的常用节点做了详细的说明。在这里需要特别介绍一下的是<profile>节点的配置，profile是maven的一个重要特性。

<profile>节点包含了激活(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 – 检测到操作系统之后显示的信息

2.   jdk

检查jdk版本，可以用区间表示。

3.   property

检查属性值，本节点可以包含name和value两个子节点。

4.   file

检查文件相关内容，包含两个子节点：exists和missing，用于分别检查文件存在和不存在两种情况。

如果settings中的profile被激活，那么它的值将覆盖POM或者profiles.xml中的任何相等ID的profiles。

如果想要某个profile默认处于激活状态，可以在<activeProfiles>中将该profile的id放进去。这样，不论环境设置如何，其对应的 profile都会被激活。