一、简介
settings.xml对于maven来说相当于全局性的配置,用于所有的项目,当Maven运行过程中的各种配置,例如pom.xml,不想绑定到一个固定的project或者要分配给用户时,我们使用settings.xml中的settings元素来确定这些配置。这包含了本地仓库位置,远程仓库服务器以及认证信息等。
settings.xml存在于两个地方:
1.安装的地方:$M2_HOME/conf/settings.xml
2.用户的目录:${user.home}/.m2/settings.xml
前者又被叫做全局配置,后者被称为用户配置。如果两者都存在,它们的内容将被合并,并且用户范围的配置优先。
平时配置时优先选择用户目录的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>
二、简单值
localRepository:这个值是构建系统的本地仓库的路径。默认的值是${user.home}/.m2/repository.如果一个系统想让所有登陆的用户都用同一个本地仓库的话,这个值是极其有用的。
interactiveMode:如果Maven要试图与用户交互来得到输入就设置为true,否则就设置为false,默认为true。
usePluginRegistry:如果Maven使用${user.home}/.m2/plugin-registry.xml来管理plugin的版本,就设置为true,默认为false。
offline:如果构建系统要在离线模式下工作,设置为true,默认为false。如果构建服务器因为网络故障或者安全问题不能与远程仓库相连,那么这个设置是非常有用的。
三、PluginGroups(插件组)
这个元素包含了一系列pluginGroup元素,每个又包含了一个groupId。当一个plugin被使用,而它的groupId没有被提供的时候,这个列表将被搜索。这个列表自动的包含了org.apache.maven.plugins和org.codehaus.mojo。
<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">
...
<pluginGroups>
<pluginGroup>org.mortbay.jetty</pluginGroup>
</pluginGroups>
...
</settings>
四、Servers(服务器)
- 定义jar包下载的Maven仓库
- 定义部署服务器
<servers>
<server>
<id>tomcat</id>
<username>bruce</username>
<password>password</password>
</server>
<server>
<id>shiyue</id>
<username>admin</username>
<password>password</password>
</server>
</servers>
tomcat: 部署服务器
shiyue: Mave私服
五、Mirrors(镜像)
指定仓库的地址,则默认从指定的镜像下载jar包及插件
mirror可以拦截对远程仓库的请求,改变对目标仓库的下载地址。 mirror就是镜像,主要提供一个方便地切换远程仓库地址的途径。
id:唯一标识,用于区分不同的mirror;name:自定义奖项的名字;mirrorOf拦截规则,不同id的mirror的该值不能一样否则只能使用第一个
<mirrors>
<mirror>
<id>mirrorId</id>
<mirrorOf>*</mirrorOf>
<name>Human Readable Name for this Mirror.</name>
<url>http://host:port/nexus-2.1.2/content/groups/public</url>
</mirror>
</mirrors>
镜像拦截规则
规则 | 说明 |
<mirrorOf>*</mirrorOf> | 匹配所有远程仓库 |
<mirrorOf>external:*</mirrorOf> | 匹配所有远程仓库,使用localhost的除外,使用file://协议的除外。也就是说,匹配所有不在本机上的远程仓库。 |
<mirrorOf>repo1,repo2</mirrorOf> | 匹配仓库repo1和repo2,使用逗号分隔多个远程仓库 |
<mirrorOf>*,!repo1</miiroOf> | 匹配所有远程仓库,repo1除外,使用感叹号将仓库从匹配中排除。 |
六、Proxies(代理)
有时候你所在的公司基于安全因素考虑,要求你使用通过安全认证的代理访问因特网。这时就需要为Maven配置HTTP代理。
<proxies>
<proxy>
<id>optional</id>
<active>true</active>
<protocol>http</protocol>
<username>proxyuser</username>
<password>proxypass</password>
<host>proxy.host.net</host>
<port>80</port>
<nonProxyHosts>local.net|some.host.com</nonProxyHosts>
</proxy>
</proxies>
七、Profiles
元素用于定义一组可选的构建配置。例如,您可以定义一个名为development的Profile,其中包含针对开发环境的特定配置,以及一个名为production的Profile,其中包含针对生产环境的特定配置。
主要包括activation,repositories,pluginRepositories 和properties元素
repositories指定不同的仓库,根据环境进行激活使用那个仓库下载jar包,properties指定根据环境赋不同的值,activation用于指定默认激活的元素
<settings>
<profiles>
<profile>
<id>development</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<environment>dev</environment>
</properties>
</profile>
<profile>
<id>production</id>
<properties>
<environment>prod</environment>
</properties>
</profile>
</profiles>
</settings>
上面的配置中,development Profile被设置为默认激活的Profile,production Profile则不是。此外,development Profile定义了一个名为environment的属性,其值为dev,而production Profile定义了一个名为environment的属性,其值为prod。在POM文件中,您可以使用${environment}占位符来引用该属性的值
<profiles>
<profile>
<id>dev_evn</id>
<properties>
<db.driver>com.mysql.jdbc.Driver</db.driver>
<db.url>jdbc:mysql://localhost:3306/test</db.url>
<db.username>root</db.username>
<db.password>root</db.password>
</properties>
</profile>
<profile>
<id>test_evn</id>
<properties>
<db.driver>com.mysql.jdbc.Driver</db.driver>
<db.url>jdbc:mysql://localhost:3306/test_db</db.url>
<db.username>root</db.username>
<db.password>root</db.password>
</properties>
</profile>
</profiles>
在两个不同的 profile 中,配置了同样的属性,不一样的值。在开发时可以用 mvn 命令后面添加“-Pdev_evn”激活“dev_evn profile”。
激活profile的方式
mvn 命令行中添加参数“-P”,指定要激活的 profile 的 id。如果一次要激活多个 profile,可以用逗号分开一起激活。
mvn clean install -Pdev_env,test_evn
Settings 文件显示激活
如果希望某个 profile 默认一直处于激活状态,可以在 settings.xml 中配置 activeProfiles 元素,指定某个 profile 为默认激活状态
<settings>
...
<activeProfiles>
<activeProfile>dev_evn</activeProfile>
</activeProfiles>
...
</settings>
系统属性激活
可以配置当某个系统属性存在时激活 profile
<profiles>
<profile>
...
<activation>
<property>
<name>profileProperty</name>
</property>
</activation>
</profile>
</profiles>
配置某个属性的值是什么时候激活
<profiles>
<profile>
...
<activation>
<property>
<name>profileProperty</name>
<value>dev</value>
</property>
</activation>
</profile>
</profiles>
这样就可以在 mvn 中用“-D”参数来指定激活,例如:
Mvn clean install -DprofileProperty=dev
操作系统环境激活
用户可以通过配置指定不同操作系统的信息,实现不同操作系统做不同的构建
<profiles>
<profile>
<activation>
<os>
<name>Window XP</name>
<family>Windows</family>
<arch>x86</arch>
<version>5.1.2600</version>
</os>
</activation>
</profile>
</profiles>
family 的值是 Windows、UNIX 或 Mac。name 为操作系统名称。arch为操作系统的架构。version为操作系统的版本。具体的值可以通过查看环境中的系统属性“os.name”“os.arch”和“os.version”获取。
文件存在与否激活
当然,也可以通过配置判断某个文件存在与否来决定是否激活 profile,样例配置代码如下:
<profiles>
<profile>
<activation>
<file>
<missing>t1.properties</missing>
<exists>t2.properties</exists>
</file>
</activation>
</profile>
</profiles>
默认激活
还可以配置一个默认的激活 profile
<profiles>
<profile>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
</profile>
</profiles>
需要注意的是,如果 pom 中有任何一个 profile 通过其他方式被激活的话,所有配置成默认激活的 profile 都会自动失效。
可以使用如下命令查看当前激活的 profile。
Mvn help:active-profiles
也可以使用如下命令查看所有的 profile
Mvn help:all-profiles
根据 profile 配置的位置不同,可以将 profile 分成如下几种。
1)pom.xml
pom.xml 中声明的 profile 只对当前项目有效。
2)用户 settings.xml
在用户目录下的“.m2/settings.xml”中的 profile,对本机上的该用户的所有 Maven 项目有效。
3)全局 settings.xml
在 Maven 安装目录下 conf/settings.xml 中配置的 profile,对本机上所有项目都有效。
八、activeProfiles
activeProfiles包含一组activeProfile元素,值为profile的id,如果设为true,那么将启用该profile配置。
<activeProfiles>
<activeProfile>development</activeProfile>
</activeProfiles>