2、settings.xml

settings.xml

Maven有一个settings.xml配置文件,它是用来设置 Maven 参数的配置文件,settings.xml 中包含类似本地仓储位置、修改远程仓储服务器、认证信息等配置。

settings.xml 文件一般存在于两个位置:

settings.xml结构

<settings ...>
    <localRepository/>    <!--本地仓库路径-->
    <interactiveMode/>    <!--是否需要和用户交互,默认true,一般无需修改-->
    <usePluginRegistry/>  <!--是否通过pluginregistry.xml独立文件配置插件,默认false,一般直接配置到pom.xml-->
    <offline/>            <!--是否离线模式,默认false,如果不想联网,可以开启-->
    <pluginGroups/>       <!--配置如果插件groupid未提供时自动搜索,一般很少配置-->
    <servers/>            <!--配置远程仓库服务器需要的认证信息,如用户名和密码-->
    <mirrors/>            <!--为仓库列表配置镜像列表-->
    <proxies/>            <!--配置连接仓库的代理-->
    <profiles/>           <!--全局配置项目构建参数列表,一般通过它配置特定环境的定制化操作-->
    <activeProfiles/>     <!--手工激活profile,通过配置id选项完成激活-->
    <activation/>         <!--profile的扩展选项,指定某些条件下自动切换profile配置-->
    <properties/>         <!--在配置文件中声明扩展配置项-->
    <repositories/>       <!--配置远程仓库列表,用于多仓库配置-->
    <pluginRepositories/> <!--配置插件仓库列表-->
</settings>

localRepository

该值表示构建系统本地仓库的路径。其默认值:${user.home}/.m2/repository

interactiveMode

表示 Maven 是否需要和用户交互以获得输入,默认true,一般无需修改。

<interactiveMode>true</interactiveMode>

usePluginRegistry

表示Maven 是否需要使用plugin-registry.xml文件来管理插件版本。

如果需要让 Maven使用文件${user.home}/.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.pluginsorg.codehaus.mojo

<pluginGroups>
    <pluginGroup>org.apache.maven.plugins</pluginGroup>
    <pluginGroup>org.codehaus.mojo</pluginGroup>
</pluginGroups>

servers

仓库的下载和部署是在pom.xml文件中的repositoriesdistributionManagement元素中定义的。然而,一般类似用户名、密码(有些仓库访问是需要安全认证的)等信息不应该在pom.xml文件中配置,这些信息可以配置在settings.xml中。

<!--配置服务端的一些设置。一些设置如安全证书不应该和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>

mirrors

为仓库列表配置的下载镜像列表

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

proxies

用来配置连接仓库的代理

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

profiles

全局配置项目构建参数列表,一般通过它配置特定环境的定制化操作

settings.xml 中的 profile 元素是pom.xmlprofile 元素的裁剪版本。

这里的 profile 元素只包含idactivationrepositoriespluginRepositories properties五个子元素,是因为这里只关心构建系统这个整体(这正是settings.xml文件的角色定位),而非单独的项目对象模型设置。如果一个settings.xml中的 profile 被激活,它的值会覆盖任何其它定义在pom.xml中带有相同 id 的 profile。

<profiles>
    <profile>
        <id>test</id>          <!-- profile的唯一标识 -->
        <activation />         <!-- 自动触发profile的条件逻辑 -->
        <properties />         <!-- 扩展属性列表 -->
        <repositories />       <!-- 远程仓库列表 -->
        <pluginRepositories /> <!-- 插件仓库列表 -->
    </profile>
</profiles>
1、activation

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>
        <name>Windows XP</name>     <!--激活profile的操作系统的名字 -->
        <family>Windows</family>    <!--激活profile的操作系统所属家族(如windows、linux) -->
        <arch>x86</arch>            <!--激活profile的操作系统体系结构 -->
        <version>5.1.2600</version> <!--激活profile的操作系统版本 -->
    </os>

    <!--如果Maven检测到某一个属性(其值可以在POM中通过${name}引用),Profile就会被激活。
    如果值字段是空的,那么存在属性名称字段就会激活profile,否则按区分大小写方式匹配属性值字段 -->
    <property>
        <name>mavenVersion</name>  <!--激活profile的属性的名称 -->
        <value>2.0.3</value>       <!--激活profile的属性的值 -->
    </property>
    <!--提供一个文件名,通过检测该文件的存在或不存在来激活profile。
    missing检查文件是否存在,如果不存在则激活profile。
    exists则会检查文件是否存在,如果存在则激活profile。 -->
    <file>
        <exists>${basedir}/file2.properties</exists>   <!--如果指定的文件存在,则激活profile。 -->
        <missing>${basedir}/file1.properties</missing> <!--如果指定的文件不存在,则激活profile。 -->
    </file>
</activation>

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

2、properties

对应profile的扩展属性列表

<properties>
	<user.install>${user.home}/our-project</user.install>
</properties>
3、repository

远程仓库列表,它是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>
            <enabled />
            <updatePolicy />
            <checksumPolicy />
        </snapshots>
        <!--远程仓库URL -->
        <url>http://snapshots.maven.codehaus.org/maven2</url>
        <!--用于定位和排序构件的仓库布局类型-可以是default(默认)或者legacy(遗留)。Maven 2为其仓库提供了一个默认的布局;然而,Maven 1.x有一种不同的布局。我们可以使用该元素指定布局是default(默认)还是legacy(遗留)。 -->
        <layout>default</layout>
    </repository>
</repositories>
4、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,则什么都不会发生。

<activeProfiles>
    <!-- 要激活的profile id -->
    <activeProfile>test</activeProfile>
</activeProfiles>