Maven-配置文件settings.xml详解

本篇文章主要对maven中setting.xml配置文件进行解释

1.声明规范

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

2.localRepository

<!-- 本地仓库的路径。默认值为${user.home}/.m2/repository -->  
<localRepository>/opt/repository</localRepository>

3.interactiveMode

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

4.offline

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

5.pluginGroups

<!--当插件的组织Id（groupId）没有显式提供时，供搜寻插件组织Id（groupId）的列表。该元素包含一个pluginGroup元素列表，每个子元素包含了一个组织Id（groupId）。当我们使用某个插件，并且没有在命令行为其提供组织Id（groupId）的时候，Maven就会使用该列表。默认情况下该列表包含了org.apache.maven.plugins和org.codehaus.mojo -->
<pluginGroups>
  <!--plugin的组织Id（groupId） -->
  <pluginGroup>org.codehaus.mojo</pluginGroup>
</pluginGroups>

6.proxies

<!--用来配置不同的代理，多代理profiles 可以应对笔记本或移动设备的工作环境：通过简单的设置profile id就可以很容易的更换整个代理配置。 -->
<proxies>
  <!--代理元素包含配置代理时需要的信息-->
  <proxy>
   <!--代理的唯一定义符，用来区分不同的代理元素。-->
   <id>myproxy</id>
   <!--该代理是否是激活的那个。true则激活代理。当我们声明了一组代理，而某个时候只需要激活一个代理的时候，该元素就可以派上用处。 -->
   <active>true</active>
   <!--代理的协议。 协议://主机名:端口，分隔成离散的元素以方便配置。-->
   <protocol>http</protocol>
   <!--代理的用户名，用户名和密码表示代理服务器认证的登录名和密码。 -->
   <username>proxyuser</username>
   <!--代理的密码，用户名和密码表示代理服务器认证的登录名和密码。 -->
   <password>somepassword</password>
   <!--代理的主机名。协议://主机名:端口，分隔成离散的元素以方便配置。  -->
   <host>proxy.somewhere.com</host>
   <!--代理的端口。协议://主机名:端口，分隔成离散的元素以方便配置。 -->
   <port>8080</port>
   <!--不该被代理的主机名列表。该列表的分隔符由代理服务器指定；例子中使用了竖线分隔符，使用逗号分隔也很常见。-->
   <nonProxyHosts>*.google.com|ibiblio.org</nonProxyHosts>
  </proxy>
</proxies>

7.servers

<!--配置服务端的一些设置。一些设置如安全证书不应该和pom.xml一起分发。这种类型的信息应该存在于构建服务器上的settings.xml文件中。-->
<servers>
  <!--服务器元素包含配置服务器时需要的信息 -->
  <server>
   <!--这是server的id（注意不是用户登陆的id），该id与distributionManagement中repository元素的id相匹配。-->
   <id>server001</id>
   <!--鉴权用户名。鉴权用户名和鉴权密码表示服务器认证所需要的登录名和密码。 -->
   <username>my_login</username>
   <!--鉴权密码 。鉴权用户名和鉴权密码表示服务器认证所需要的登录名和密码。密码加密功能已被添加到2.1.0 +。详情请访问密码加密页面-->
   <password>my_password</password>
   <!--鉴权时使用的私钥位置。和前两个元素类似，私钥位置和私钥密码指定了一个私钥的路径（默认是${user.home}/.ssh/id_dsa）以及如果需要的话，一个密语。将来passphrase和password元素可能会被提取到外部，但目前它们必须在settings.xml文件以纯文本的形式声明。 -->
   <privateKey>${usr.home}/.ssh/id_dsa</privateKey>
   <!--鉴权时使用的私钥密码。-->
   <passphrase>some_passphrase</passphrase>
   <!--文件被创建时的权限。如果在部署的时候会创建一个仓库文件或者目录，这时候就可以使用权限（permission）。这两个元素合法的值是一个三位数字，其对应了unix文件系统的权限，如664，或者775。 -->
   <filePermissions>664</filePermissions>
   <!--目录被创建时的权限。 -->
   <directoryPermissions>775</directoryPermissions>
  </server>
</servers>

8.mirrors

<!--为仓库列表配置的下载镜像列表 -->
<mirrors>
  <!--给定仓库的下载镜像。 -->
  <mirror>
   <!--该镜像的唯一标识符。id用来区分不同的mirror元素。 -->
   <id>planetmirror.com</id>
   <!--镜像名称 -->
   <name>PlanetMirror Australia</name>
   <!--该镜像的URL。构建系统会优先考虑使用该URL，而非使用默认的服务器URL。 -->
   <url>http://downloads.planetmirror.com/pub/maven2</url>
   <!--被镜像的服务器的id。例如，如果我们要设置了一个Maven中央仓库（http://repo.maven.apache.org/maven2/）的镜像，就需要将该元素设置成central。这必须和中央仓库的id central完全一致。-->
   <mirrorOf>central</mirrorOf>
  </mirror>
</mirrors>

9.profiles

<!--
  | 构建方法的配置清单, maven 将根据不同环境参数来使用这些构建配置。
  | settings.xml 中的 profile 元素是 pom.xml 中 profile 元素的裁剪版本。
  | settings.xml 负责的是整体的构建过程, pom.xml 负责单独的项目对象构建过程。
  | settings.xml 只包含了id, activation, repositories, pluginRepositories 和 properties 元素。
  | 如果 settings 中的 profile 被激活, 它的值会覆盖任何其它定义在 pom.xml 中或 profile.xml 中的相同 id 的 profile。
  | 查看当前激活的 profile:
  |   mvn help:active-profiles
-->
<profiles>
  <profile>
    <!-- 该配置的唯一标识符 -->
    <id>profile_id</id>
    <!--
      | profile 的激活条件配置；
      | 其他激活方式: 
      | 1. 通过 settings.xml 文件中的 activeProfile 元素进行指定激活。
      | 2. 在命令行, 使用-P标记和逗号分隔的列表来显式的激活, 如: mvn clean package -P myProfile）。 
    -->
    <activation>
      <!-- 是否默认激活 -->
      <activeByDefault>false</activeByDefault>
      <!-- 内建的 java 版本检测 -->
      <jdk>1.8</jdk>
      <!-- 内建操作系统属性检测-->
      <os>
        <!-- 操作系统 -->
        <name>Windows XP</name>
        <!-- 操作系统家族 -->
        <family>Windows</family>
        <!-- 操作系统 -->
        <arch>x86</arch>
        <!-- 操作系统版本 -->
        <version>5.1.2600</version>
      </os>
      <!--
        | 如果Maven检测到某一个属性（其值可以在POM中通过${名称}引用）, 并且其拥有对应的名称和值, Profile就会被激活。
        | 如果值字段是空的, 那么存在属性名称字段就会激活profile, 否则按区分大小写方式匹配属性值字段
      -->
      <property>
        <!-- 属性名 -->
        <name>mavenVersion</name>
        <!-- 属性值 -->
        <value>2.0.3</value>
      </property>
      <!-- 根据文件存在/不存在激活profile -->
      <file>
        <!-- 如果指定的文件存在, 则激活profile -->
        <exists>/path/to/active_on_exists</exists>
        <!-- 如果指定的文件不存在, 则激活profile -->
        <missing>/path/to/active_on_missing</missing>
      </file>
    </activation>
    <!-- 
      | 扩展属性设置。扩展属性可以在 POM 中的任何地方通过 ${扩展属性名} 进行引用
      | 属性引用方式（包括扩展属性, 共 5 种属性可以引用）: 
        | env.x : 引用 shell 环境变量, 例如, "env.PATH"指代了 $path 环境变量（在 Linux / Windows 上是 %PATH% ）.
        | project.x : 引用 pom.xml（根元素就是 project） 中 xml 元素内容.例如 ${project.artifactId} 可以获取 pom.xml 中设置的 <artifactId /> 元素的内容
        | settings.x : 引用 setting.xml（根元素就是 setting） 中 xml 元素内容, 例如 ${settings.offline}
        | Java System Properties : 所有可通过 java.lang.System.getProperties() 访问的属性都能在通过 ${property_name} 访问, 例如 ${java.home}
        | x : 在 <properties/> 或者 外部文件 中设置的属性, 都可以 ${someVar} 的形式使用
    -->
    <properties>
      <!-- 在当前 profile 被激活时,  ${profile.property} 就可以被访问到了 -->
      <profile.property>this.property.is.accessible.when.current.profile.actived</profile.property>
    </properties>
  </profile>
</profiles>

10.activeProfiles

<!--
  手动激活profiles的列表，按照profile被应用的顺序定义activeProfile。 
  该元素包含了一组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>

转载于:https://my.oschina.net/u/3057088/blog/3078862