maven全局配置文件settings.xml详解

时间  2019-11-09
标签 maven 全局 配置文件 settings.xml settings xml 详解 栏目 Maven 繁體版
原文   原文链接

概要

settings.xml有什么用？

若是在Eclipse中使用过Maven插件，想必会有这个经验：配置settings.xml文件的路径。
Paste_Image.png
settings.xml文件是干什么的，为何要配置它呢？
从settings.xml的文件名就能够看出，它是用来设置maven参数的配置文件。而且，settings.xml是maven的全局配置文件。而pom.xml文件是所在项目的局部配置。
Settings.xml中包含相似本地仓储位置、修改远程仓储服务器、认证信息等配置。java

settings.xml文件位置

settings.xml文件通常存在于两个位置：
全局配置: ${M2_HOME}/conf/settings.xml
用户配置: \({user.home}/.m2/settings.xml note：用户配置优先于全局配置。\){user.home} 和和全部其余系统属性只能在3.0+版本上使用。请注意windows和Linux使用变量的区别。git

配置优先级

须要注意的是：局部配置优先于全局配置。
配置优先级从高到低：pom.xml> user settings > global settings
若是这些文件同时存在，在应用配置时，会合并它们的内容，若是有重复的配置，优先级高的配置会覆盖优先级低的。shell

settings.xml元素详解

顶级元素概览

下面列举了settings.xml中的顶级元素apache

<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
                          https://maven.apache.org/xsd/settings-1.0.0.xsd">
  <localRepository/>
  <interactiveMode/>
  <usePluginRegistry/>
  <offline/>
  <pluginGroups/>
  <servers/>
  <mirrors/>
  <proxies/>
  <profiles/>
  <activeProfiles/>
</settings>

LocalRepository

做用：该值表示构建系统本地仓库的路径。
其默认值：~/.m2/repository。windows

<localRepository>${user.home}/.m2/repository</localRepository>

InteractiveMode

做用：表示maven是否须要和用户交互以得到输入。
若是maven须要和用户交互以得到输入，则设置成true，反之则应为false。默认为true。安全

<interactiveMode>true</interactiveMode>

UsePluginRegistry

做用：maven是否须要使用plugin-registry.xml文件来管理插件版本。
若是须要让maven使用文件~/.m2/plugin-registry.xml来管理插件版本，则设为true。默认为false。服务器

<usePluginRegistry>false</usePluginRegistry>

Offline

做用：表示maven是否须要在离线模式下运行。
若是构建系统须要在离线模式下运行，则为true，默认为false。
当因为网络设置缘由或者安全因素，构建服务器不能链接远程仓库的时候，该配置就十分有用。网络

<offline>false</offline>

PluginGroups

做用：当插件的组织id（groupId）没有显式提供时，供搜寻插件组织Id（groupId）的列表。
该元素包含一个pluginGroup元素列表，每一个子元素包含了一个组织Id（groupId）。
当咱们使用某个插件，而且没有在命令行为其提供组织Id（groupId）的时候，Maven就会使用该列表。默认状况下该列表包含了org.apache.maven.plugins和org.codehaus.mojo。ssh

<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
                      https://maven.apache.org/xsd/settings-1.0.0.xsd">
  ...
  <pluginGroups>
    <!--plugin的组织Id（groupId） -->
    <pluginGroup>org.codehaus.mojo</pluginGroup>
  </pluginGroups>
  ...
</settings>

Servers

做用：通常，仓库的下载和部署是在pom.xml文件中的repositories和distributionManagement元素中定义的。然而，通常相似用户名、密码（有些仓库访问是须要安全认证的）等信息不该该在pom.xml文件中配置，这些信息能够配置在settings.xml中。maven

<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
                      https://maven.apache.org/xsd/settings-1.0.0.xsd">
  ...
  <!--配置服务端的一些设置。一些设置如安全证书不该该和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>
  ...
</settings>

Mirrors

做用：为仓库列表配置的下载镜像列表。

<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
                      https://maven.apache.org/xsd/settings-1.0.0.xsd">
  ...
  <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>
  ...
</settings>

Proxies

做用：用来配置不一样的代理。

<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
                      https://maven.apache.org/xsd/settings-1.0.0.xsd">
  ...
  <proxies>
    <!--代理元素包含配置代理时须要的信息 -->
    <proxy>
      <!--代理的惟必定义符，用来区分不一样的代理元素。 -->
      <id>myproxy</id>
      <!--该代理是不是激活的那个。true则激活代理。当咱们声明了一组代理，而某个时候只须要激活一个代理的时候，该元素就能够派上用处。 -->
      <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>

Profiles

做用：根据环境参数来调整构建配置的列表。
settings.xml中的profile元素是pom.xml中profile元素的裁剪版本。
它包含了id、activation、repositories、pluginRepositories和 properties元素。这里的profile元素只包含这五个子元素是由于这里只关心构建系统这个总体（这正是settings.xml文件的角色定位），而非单独的项目对象模型设置。若是一个settings.xml中的profile被激活，它的值会覆盖任何其它定义在pom.xml中带有相同id的profile。

<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
                      https://maven.apache.org/xsd/settings-1.0.0.xsd">
  ...
  <profiles>
    <profile>
      <!-- profile的惟一标识 -->
      <id>test</id>
      <!-- 自动触发profile的条件逻辑 -->
      <activation />
      <!-- 扩展属性列表 -->
      <properties />
      <!-- 远程仓库列表 -->
      <repositories />
      <!-- 插件仓库列表 -->
      <pluginRepositories />
    </profile>
  </profiles>
  ...
</settings>

Activation

做用：自动触发profile的条件逻辑。
如pom.xml中的profile同样，profile的做用在于它可以在某些特定的环境中自动使用某些特定的值；这些环境经过activation元素指定。
activation元素并非激活profile的惟一方式。settings.xml文件中的activeProfile元素能够包含profile的id。profile也能够经过在命令行，使用-P标记和逗号分隔的列表来显式的激活（如，-P test）。

<activation>
  <!--profile默认是否激活的标识 -->
  <activeByDefault>false</activeByDefault>
  <!--当匹配的jdk被检测到，profile被激活。例如，1.4激活JDK1.4，1.4.0_2，而!1.4激活全部版本不是以1.4开头的JDK。 -->
  <jdk>1.5</jdk>
  <!--当匹配的操做系统属性被检测到，profile被激活。os元素能够定义一些操做系统相关的属性。 -->
  <os>
    <!--激活profile的操做系统的名字 -->
    <name>Windows XP</name>
    <!--激活profile的操做系统所属家族(如 'windows') -->
    <family>Windows</family>
    <!--激活profile的操做系统体系结构 -->
    <arch>x86</arch>
    <!--激活profile的操做系统版本 -->
    <version>5.1.2600</version>
  </os>
  <!--若是Maven检测到某一个属性（其值能够在POM中经过${name}引用），其拥有对应的name = 值，Profile就会被激活。若是值字段是空的，那么存在属性名称字段就会激活profile，不然按区分大小写方式匹配属性值字段 -->
  <property>
    <!--激活profile的属性的名称 -->
    <name>mavenVersion</name>
    <!--激活profile的属性的值 -->
    <value>2.0.3</value>
  </property>
  <!--提供一个文件名，经过检测该文件的存在或不存在来激活profile。missing检查文件是否存在，若是不存在则激活profile。另外一方面，exists则会检查文件是否存在，若是存在则激活profile。 -->
  <file>
    <!--若是指定的文件存在，则激活profile。 -->
    <exists>${basedir}/file2.properties</exists>
    <!--若是指定的文件不存在，则激活profile。 -->
    <missing>${basedir}/file1.properties</missing>
  </file>
</activation>

注：在maven工程的pom.xml所在目录下执行mvn help:active-profiles命令能够查看中央仓储的profile是否在工程中生效。

properties

做用：对应profile的扩展属性列表。
maven属性和ant中的属性同样，能够用来存放一些值。这些值能够在pom.xml中的任何地方使用标记${X}来使用，这里X是指属性的名称。属性有五种不一样的形式，而且都能在settings.xml文件中访问。

<!-- 
  1. env.X: 在一个变量前加上"env."的前缀，会返回一个shell环境变量。例如,"env.PATH"指代了$path环境变量（在Windows上是%PATH%）。 
  2. project.x：指代了POM中对应的元素值。例如: <project><version>1.0</version></project>经过${project.version}得到version的值。 
  3. settings.x: 指代了settings.xml中对应元素的值。例如：<settings><offline>false</offline></settings>经过 ${settings.offline}得到offline的值。 
  4. Java System Properties: 全部可经过java.lang.System.getProperties()访问的属性都能在POM中使用该形式访问，例如 ${java.home}。 
  5. x: 在<properties/>元素中，或者外部文件中设置，以${someVar}的形式使用。
 -->
<properties>
  <user.install>${user.home}/our-project</user.install>
</properties>

注：若是该profile被激活，则能够在pom.xml中使用${user.install}。

Repositories

做用：远程仓库列表，它是maven用来填充构建系统本地仓库所使用的一组远程仓库。

<repositories>
  <!--包含须要链接到远程仓库的信息 -->
  <repository>
    <!--远程仓库惟一标识 -->
    <id>codehausSnapshots</id>
    <!--远程仓库名称 -->
    <name>Codehaus Snapshots</name>
    <!--如何处理远程仓库里发布版本的下载 -->
    <releases>
      <!--true或者false表示该仓库是否为下载某种类型构件（发布版，快照版）开启。 -->
      <enabled>false</enabled>
      <!--该元素指定更新发生的频率。Maven会比较本地POM和远程POM的时间戳。这里的选项是：always（一直），daily（默认，每日），interval：X（这里X是以分钟为单位的时间间隔），或者never（从不）。 -->
      <updatePolicy>always</updatePolicy>
      <!--当Maven验证构件校验文件失败时该怎么作-ignore（忽略），fail（失败），或者warn（警告）。 -->
      <checksumPolicy>warn</checksumPolicy>
    </releases>
    <!--如何处理远程仓库里快照版本的下载。有了releases和snapshots这两组配置，POM就能够在每一个单独的仓库中，为每种类型的构件采起不一样的策略。例如，可能有人会决定只为开发目的开启对快照版本下载的支持。参见repositories/repository/releases元素 -->
    <snapshots>
      <enabled />
      <updatePolicy />
      <checksumPolicy />
    </snapshots>
    <!--远程仓库URL，按protocol://hostname/path形式 -->
    <url>http://snapshots.maven.codehaus.org/maven2</url>
    <!--用于定位和排序构件的仓库布局类型-能够是default（默认）或者legacy（遗留）。Maven 2为其仓库提供了一个默认的布局；然而，Maven 1.x有一种不一样的布局。咱们可使用该元素指定布局是default（默认）仍是legacy（遗留）。 -->
    <layout>default</layout>
  </repository>
</repositories>

pluginRepositories

做用：发现插件的远程仓库列表。
和repository相似，只是repository是管理jar包依赖的仓库，pluginRepositories则是管理插件的仓库。
maven插件是一种特殊类型的构件。因为这个缘由，插件仓库独立于其它仓库。pluginRepositories元素的结构和repositories元素的结构相似。每一个pluginRepository元素指定一个Maven能够用来寻找新插件的远程地址。

<pluginRepositories>
  <!-- 包含须要链接到远程插件仓库的信息.参见profiles/profile/repositories/repository元素的说明 -->
  <pluginRepository>
    <releases>
      <enabled />
      <updatePolicy />
      <checksumPolicy />
    </releases>
    <snapshots>
      <enabled />
      <updatePolicy />
      <checksumPolicy />
    </snapshots>
    <id />
    <name />
    <url />
    <layout />
  </pluginRepository>
</pluginRepositories>

ActiveProfiles

做用：手动激活profiles的列表，按照profile被应用的顺序定义activeProfile。
该元素包含了一组activeProfile元素，每一个activeProfile都含有一个profile id。任何在activeProfile中定义的profile id，不论环境设置如何，其对应的 profile都会被激活。若是没有匹配的profile，则什么都不会发生。
例如，env-test是一个activeProfile，则在pom.xml（或者profile.xml）中对应id的profile会被激活。若是运行过程当中找不到这样一个profile，Maven则会像往常同样运行。

<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
                      https://maven.apache.org/xsd/settings-1.0.0.xsd">
  ...
  <activeProfiles>
    <!-- 要激活的profile id -->
    <activeProfile>env-test</activeProfile>
  </activeProfiles>
  ...
</settings>

至此，maven settings.xml中的标签都讲解完毕，但愿对你们有所帮助。

更多阅读

maven 在线笔记

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程