Maven之settings配置详细分析

前面提到了settings.xml有两个地方，一个是maven自带的在maven的conf目录下。
还有一个是用户自己定义的一般和自定义本地仓库放在同一个目录中。
我放的地址是D:\Java\maven\settings.xml
两个settings，前者又被叫做全局配置，后者被称为用户配置。如果两者都存在，它们的内容将被合并，并且用户范围的settings.xml优先。
如果我们偶尔需要创建用户范围的settings，可以简单的copy Maven安装路径下的settings到目录D:\Java\maven。
Maven默认的settings.xml是一个包含了注释和例子的模板，我们可以快速的修改它来达到要求。


下面是settings的所有子节点的一个总体概览：
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
              http://maven.apache.org/xsd/settings-1.0.0.xsd">
      <localRepository/>
      <interactiveMode/>
      <usePluginRegistry/>
      <offline/>
      <pluginGroups/>
      <servers/>
      <mirrors/>
      <proxies/>
      <profiles/>
      <activeProfiles/>
</settings>


下面仔细描述一下个节点的作用
1. <localRepository/>
修改<localRepository>D:/Java/maven/repository</localRepository>
来指定本地仓库路径。有了本地仓库，以后项目依赖会先从本地仓库中查找，
如果没有就会从网络中的中央仓库中下载到本地仓库中。
默认的值是${user.home}/.m2/repository。


2. <interactiveMode/>
<interactiveMode>true</interactiveMode> 
如果Maven要试图与用户交互来得到输入就设置为true，否则就设置为false
默认为 true ，当需要输入参数时 Maven 会提示用户输入参数，如果设置为 false ，
则在遇到有输入参数时不会提示用户， Maven 会自己生成一些参数，这样可能会出错，一般不需要改变默认设置。


3. <usePluginRegistry/>
<usePluginRegistry>false</usePluginRegistry>
Maven是否需要使用plugin-registry.xml文件来管理插件版本。
如果需要让Maven使用文件~/.m2/plugin-registry.xml来管理插件版本，则设为true。默认为false。


4. <offline/>
<offline>false</offline>
表示Maven是否需要在离线模式下运行。如果构建系统需要在离线模式下运行，则为true，默认为false。
这可能会对已有的本地储藏室中的自定义 .jar 文件产生影响，默认为 false ，一般不需要改。
但当由于网络设置原因或者安全因素，构建服务器不能连接远程仓库的时候，该配置就十分有用。


5. <pluginGroups/>
这个元素包含了一系列pluginGroup元素，每个又包含了一个groupId。
当一个plugin被使用，而它的groupId没有被提供的时候，这个列表将被搜索。
这个列表自动的包含了org.apache.maven.plugins和org.codehaus.mojo。
<pluginGroups>
<pluginGroup>org.mortbay.jetty</pluginGroup>
</pluginGroups>
有了上面的配置，Maven命令行可以使用简单的命令执行org.morbay.jetty:jetty-maven-plugin:run，如下
mvn jetty run


6. <servers/>
配置服务端的一些设置。在POM中的 distributionManagement元素定义了开发库。然而，特定的username和pwd不能使用于pom.xml，所以通过此配置来保存server信息。
还有一些设置如安全证书不应该和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> 
id:server 的id(不是登录进来的user),用于distributionManagement/repository/mirror中的id元素相匹配，比较重要。
username, password:用于登陆此服务器的用户名和密码
privateKey, passphrase：与前两个元素一样，这两个成对出现，分别指向了一个私钥(默认的是${user.home}/.ssh/id_dsa)和一个passphrase。
passphrase和password元素可能在将来被客观化，但是现在必须以文本形式在settings.xml中设置。
filePermissions, directoryPermissions：当一个仓库文件或者目录在部署阶段被创建的时候，就必须用到权限许可。
他们合法的值是三个数字，就像*nix中的文件权限，例如：664，775.


7. <mirrors/>
表示镜像库，指定库的镜像，用于增加其他库。
则相当于一个代理，它会拦截去指定的远程repository下载构件的请求，然后从自己这里找出构件回送给客户端。配置mirror的目的一般是出于网速考虑。 
不过，很多internal repository搭建工具往往也提供mirror服务，比如Nexus就可以让同一个URL,既用作internal repository，又使它成为所有repository的mirror。
<mirrors>
    <mirror>
      <id>planetmirror.com</id>
      <name>PlanetMirror Australia</name>
      <url>http://downloads.planetmirror.com/pub/maven2</url>
      <mirrorOf>central</mirrorOf>
    </mirror>
</mirrors>
id，name：唯一的镜像标识和用户友好的镜像名称。id被用来区分mirror元素，并且当连接时候被用来获得相应的证书。
url：镜像基本的URL，构建系统敬将使用这个URL来连接仓库，而不是原来的仓库URL。
mirrorOf：镜像所包含的仓库的Id。例如，指向官方的中央库Maven central仓库的镜像(http://repo1.maven.org/maven2/)，设置这个元素为central。
更多的高级映射例如repo1,repo2 或者*,!inhouse都是可以的。没必要一定和mirror的id相匹配。

高级的镜像配置： 
1.<mirrorOf>*</mirrorOf> 
匹配所有远程仓库。 这样所有pom中定义的仓库都不生效
2.<mirrorOf>external:*</mirrorOf> 
匹配所有远程仓库，使用localhost的除外，使用file://协议的除外。也就是说，匹配所有不在本机上的远程仓库。 
3.<mirrorOf>repo1,repo2</mirrorOf> 
匹配仓库repo1和repo2，使用逗号分隔多个远程仓库。 
4.<mirrorOf>*,!repo1</miiroOf> 
匹配所有远程仓库，repo1除外，使用感叹号将仓库从匹配中排除。 


8. <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的唯一标识，用来区别proxy元素。
active：当proxy被激活的时候为true。当申明的代理很多的时候，这个很有用，但是同一时间仅有一个被激活。
protocol, host, port:代理地址protocol://host:port的分散形式。
username, password：用户名和密码 提供连接proxy服务器时的认证。
nonProxyHosts: 这里列出了不需要使用代理的hosts。列表的分隔符是proxy服务器想要的类型。上面例子使用了pipe分隔符，逗号分隔符也比较通用。


9. <profiles/>
类似于pom.xml中的profile元素它包含了id，激活(activation)，仓库(repositories)，插件仓库(pluginRepositories)和属性(properties)元素。
profile元素仅包含这五个元素是因为他们涉及到整个的构建系统，而不是个别的POM配置。
如果settings中的profile被激活，那么它的值将重载POM或者profiles.xml中的任何相等ID的profiles。

id profile的id标示。

activation（激活功能与activeProfiles一样，用来激活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>${basedir}/file2.properties</exists>
                <missing>${basedir}/file1.properties</missing>
            </file>
        </activation>
    </profile>
</profiles>
如果以上条件有达到的，则profile就会被激活。
jdk：在jdk元素中，activation有一个内建的，java版本检测。如果检测到jdk版本与期待的一样，那么就激活。在上面的例子中，1.5.0_06是满足的。
os：os元素可以定义一些上面所示的操作系统特定的属性。
property：如果Maven检测到相应的名值对的属性，那么，这个profile将被激活。
file：如果给定的文件存在，或者不存在那么将激活这个profile。

properites（属性）
Maven的属性是值占位符，就像Ant中的属性。如果X是一个属性的话，那么它的值在POM中可以使用${X}来进行任意地方的访问。他们来自于五种不同的风格，所有都可以从settings.xml文件中访问到。
1.env.X：使用"env."前缀将会返回当前的环境变量。例如${env.PATH}就是使用了$path环境变量。
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系统属性：所有通过java.lang.System.getProperties()来访问的属性都可以像POM中的属性一样访问，例如：${java.home}
5.X：返回用户自己定义的属性，值可以这样访问${someVar}

repositories（仓库）
仓库是Maven用来构筑构建系统的本地仓库的远程项目集合。它来自于被Maven叫做插件和依赖的本地仓库。不同的远程仓库包含不同的项目，当profile被激活，他们就会需找匹配的release或者snapshot构件。
  <repositories>
        <repository>
            <id>repo-local</id>
            <name>Internal Repository</name>
            <url>http://192.168.0.2:8082/repo-local</url>
            <releases>
                <enabled>true</enabled>
                <updatePolicy>never</updatePolicy>
                <checksumPolicy>warn</checksumPolicy>
            </releases>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
            <layout>default</layout>
        </repository>
    </repositories>
releases, snapshots:每个产品的版本的Release或者snapshot。Release是真正使用的版本，snapshot属于开发阶段的版本。
enable：true或者false，来标记仓库是否为各自的类型激活(release 或者 snapshot)。
updatePolicy：这个元素指明了更新的频率。Maven会比较本地POM与远程的时间戳。可选的项目为：always，daily，interval:X，nerver。
checksumPolicy：当Maven向仓库部署文件的时候，它也部署了相应的校验和文件。可选的为：ignore，fail，warn，或者不正确的校验和。
layout：在上面描述仓库的时候，我们提到他们有统一的布局。这完全正确。使用这个来表明它是default还是legacy。

plugin repositories(插件仓库)
<pluginRepositories>
<pluginRepository>
<id>repo-local</id>
<name>Internal 开发库</name>
<url>http://192.168.0.2:8082/repo-local</url>
<releases>
<enabled>true</enabled>
<updatePolicy>never</updatePolicy>
<checksumPolicy>warn</checksumPolicy>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
<layout>default</layout>
</pluginRepository>
</pluginRepositories>
各属性参照repositories（仓库）


10. <activeProfiles/>
  <activeProfiles>
    <activeProfile>env-test</activeProfile> 
  </activeProfiles>
它包含一系列的activeProfile元素，每个都有一个profile id的值，任何profile id被定义到activeProfile的profile将被激活，
不管其他的环境设置怎么样。如果没有匹配的profile被找到，那么就什么事情也不做。例如：如果env-test是一个activeProfile，

一个在pom.xml或者profile.xml中的具有相应id的profile将被激活。如果没有这样的profile被找到，就什么事也不做，一切照常。

(PS：以上内容部分为原创，部分为摘抄)。