之前也一直使用Maven进行项目构建,但仅限于简单使用,并没有进行系统的学习。本文仅为Maven的配置文件setting.xml的简单说明,以做备忘。
Setting.xml配置文件的标签说明
默认情况下maven的setting.xml文件会包含如下内容,其中“...”代表此标签下有子标签。
<?xml version="1.0" encoding="UTF-8"?>
<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>/path/to/local/repo</localRepository> <!-- 指定本地仓库路径 -->
<interactiveMode>true</interactiveMode> <!-- 是否开启交互模式 -->
<offline>false</offline> <!-- 是否离线模式运行 -->
<pluginGroups>...</pluginGroups> <!-- 定义pluginGroup元素 -->
<proxies>...</proxies> <!-- 定义proxy元素 -->
<servers>...</servers> <!-- 定义server元素 -->
<mirrors>...</mirrors> <!-- 定义mirror元素 -->
<profiles>...</profiles> <!-- 定义profile元素 -->
<activeProfiles>...</activeProfiles> <!-- 定义activeProfile元素 -->
</settings>
localRepository标签
此标签用于指定本地仓库的路径,本地仓库中会存放项目中所依赖的Lib库。默认本地的仓库路径为${user.home}/.m2/repository
,
Windows为C:\Users\{USERNAME}\.m2\repository
MAC为/Users/{USERNAME}/.m2/repository
Linux为/home/{USERNAME}/.m2/repository
一般可以将此配置修改为非系统且存储空间比较大的磁盘,避免占用系统盘空间,重装系统也会导致数据丢失。
interactiveMode标签
是否需要和用户交互以获得输入。如果Maven需要和用户交互以获得输入,则设置成true,反之则应为false,默认为true。
还没有具体使用和示例 @TODO
offline标签
是否离线,默认是false。在Maven进行项目编译和部署等操作时是否允许Maven进行联网来下载所需要的信息,对不能连接到远程仓库的情况比较实用。
pluginGroups标签
此标签下可以有多个pluginGroup,每个pluginGroup里需要指定一个groupId。pluginGroups默认自动包含org.apache.maven.plugins
和org.codehaus.mojo
。此配置可以用于简化命令行输入,例如:
<pluginGroups>
<pluginGroup>org.mortbay.jetty</pluginGroup>
</pluginGroups>
我们可以直接输入mvn jetty:run
代替mvn org.mortbay.jetty:jetty-maven-plugin:run
proxies标签
此标签下可以定义多个proxy子元素,用于指定Maven在进行联网时需要使用的代理。当设置了多个代理的时候active为true的代理将会被使用,多个proxy的active都设置为true时,第一个会被使用。示例:
<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>
servers标签
此标签下可以定义多个server子元素,用于存放连接到某个需要验证的远程服务器时的验证信息。有username/password和privateKey/passphrase两种方式。示例:
<server>
<id>server001</id> <!-- 与repository/mirror匹配的ID -->
<username>my_login</username> <!-- 验证的用户名 -->
<password>my_password</password> <!-- 验证的用户密码 -->
<privateKey>${user.home}/.ssh/id_dsa</privateKey> <!-- 验证的私钥 -->
<passphrase>some_passphrase</passphrase> <!-- 验证的私钥密码 -->
<filePermissions>664</filePermissions> <!-- 当部署时创建的文件的权限 -->
<directoryPermissions>775</directoryPermissions> <!-- 当部署时创建的文件夹的权限 -->
<configuration></configuration> <!-- -->
</server>
- id,和repository/mirror中指定的id相匹配,即指定某个repository/mirror使用此验证方式;
- username和username 验证用的账号和密码,密码可进行加密,详见:Password Encryption
- privateKey和privateKey,功能和前两个类似,privateKey中指定私钥的位置,默认
${user.home}/.ssh/id_dsa
,使用此方式时,必须保证删掉password - filePermissions和directoryPermissions,当部署系统时创建的文件和文件夹的权限
mirrors标签
指定多个远程仓库的镜像,mirror用以缓解远程仓库的压力,把对远程仓库的请求转换到对其镜像地址,比如国内的aliyun,oschina,自己用nexus搭建的仓库等。
<mirror>
<id>planetmirror.com</id> <!-- mirror的id -->
<name>PlanetMirror Australia</name><!-- mirror的名字 -->
<url>http://downloads.planetmirror.com/pub/maven2</url><!-- mirror的地址 -->
<mirrorOf>central</mirrorOf><!-- 关联的仓库 -->
</mirror>
- id,mirror的唯一ID
- name,用于友好的mirror名称,方便识别mirror
- url,mirror的地址,maven会使用这个地址代替原有仓库地址访问资源
- mirrorOf,所关联仓库的ID。同时关联多个时,用逗号隔开;
*
表示关联所有的仓库;排除某一个仓库时,可以使用*,!repositoryId
。
* = everything
external:* = everything not on the localhost and not file based.
repo,repo1 = repo or repo1
*,!repo1 = everything except repo1
profiles标签
指定多个profile。profile元素由activation、repositories、pluginRepositories和properties四个元素组成。当一个profile在settings.xml中是处于活动状态并且在pom.xml中定义了一个相同id的profile时,settings.xml中的profile会覆盖pom.xml中的profile。
<profile>
<id>test</id>
<activation> <!-- profile激活条件 -->
<activeByDefault>false</activeByDefault>
<jdk>1.5</jdk> <!-- 当JDK版本满足时激活 -->
<os> <!-- 当系统满足如下条件时激活 -->
<name>Windows XP</name>
<family>Windows</family>
<arch>x86</arch>
<version>5.1.2600</version>
</os>
<property> <!-- 当name的value为XXX时激活 -->
<name>mavenVersion</name>
<value>2.0.3</value>
</property>
<file> <!-- 当文件存在,不存在时激活 -->
<exists>${basedir}/file2.properties</exists>
<missing>${basedir}/file1.properties</missing>
</file>
</activation>
<properties> <!-- 定义属性键值对 -->
<user.install>${user.home}/our-project</user.install>
</properties>
<repositories> <!-- 指定远程仓库 -->
<repository>
<id>codehausSnapshots</id>
<name>Codehaus Snapshots</name>
<releases>
<enabled>false</enabled>
<updatePolicy>always</updatePolicy>
<checksumPolicy>warn</checksumPolicy>
</releases>
<snapshots>
<enabled>true</enabled>
<updatePolicy>never</updatePolicy>
<checksumPolicy>fail</checksumPolicy>
</snapshots>
<url>http://snapshots.maven.codehaus.org/maven2</url>
<layout>default</layout>
</repository>
</repositories>
<pluginRepositories>
...
</pluginRepositories>
</profile>
- activation标签
用于指定profile的激活条件,activeByDefault指定当没有profile处于激活状态时是否激活此profile。如果需要满足多个JDK版本可参考maven-enforcer-plugin - properties标签
定义属性键值对的,当此profile是激活状态的时候,properties下面的属性都可以在pom.xml中使用。 - repositories标签
定义多个repository标签,指定远程仓库。当该profile是激活状态的时候,这里的远程仓库将作为当前pom的远程仓库。
releases、snapshots:限制类型
enabled:表示这个仓库是否允许这种类型
updatePolicy:更新策略,表示多久尝试更新一次。可选值有always、daily、interval:X(X的单位为分)和never,默认daily。
checksumPolicy:Maven在部署项目到仓库的时候会连同校验文件一起提交,checksumPolicy指定当这个校验文件缺失或不正确的时候该如何处理,可选项有ignore、fail和warn。 - pluginRepositories标签
和repositories类似,pluginRepositories是用来指定插件仓库的。
activeProfiles标签
<activeProfiles>
<activeProfile>env-test</activeProfile>
</activeProfiles>
包含多个activeProfile元素,指定处于活跃状态的profile。