maven配置文件（一）Settings配置

一、仓库

1、关系

我们依赖的外部服务是需要有地方进行存储的，而存储的地方就称之为仓库。其中仓库又分为本地仓库、中央仓库、镜像仓库、私服。

（1）本地仓库
当项目在本地编译或运行时，直接加载本地的依赖服务无疑是最快的。默认情况下，不管在Window还是Linux下，每个用户在自己用户目录下都有一个路径名为.m2/repository/的仓库目录。

而原始的本地仓库是为空的，因此maven需要知道一个网络上的仓库，在本地仓库不存在时前往下载网络上的仓库，也就是远程仓库。

（2）中央仓库
当maven未配置时，会默认请求maven的中央仓库，中央仓库包含了这个世界上绝大多数流行的开源java构件，以及源码、作者信息、SCM,信息、许可证信息等，每个月这里都会接受全世界java程序员大概1亿次的访问，它对全世界java开发者的贡献由此可见一斑。

但是由于最常见的例如网络原因等，国外的中央仓库使用起来并不顺利，因此就有了下载地址为国内的中央仓库，也就是镜像仓库。

（3）镜像仓库
总结来说，镜像仓库就是将国外的中心仓库复制一份到国内，这样一来下载速度以及访问速度都将很快。

（4）私服
一般来说中央仓库或者镜像仓库都能满足我们的需求，但是当我们在公司内合作开发代码时，可能因为系统保密性原因，有一些其他同事开发的外部依赖只希望能够被本公司的人使用，而如果上传到镜像仓库则保密性就不复存在了。因此私服最主要的功能时存储一些公司内部不希望被公开的依赖服务。

2、mirror和repository区别

（1）仓库repository：

简单点来说，repository就是个仓库。maven里有两种仓库，本地仓库和远程仓库。远程仓库相当于公共的仓库，大家都能看到。本地仓库是你本地的一个山寨版，只有你看的到，主要起缓存作用。当你向仓库请求插件或依赖的时候，会先检查本地仓库里是否有。如果有则直接返回，否则会向远程仓库请求，并做缓存。你也可以把你做的东西上传到本地仓库给你本地自己用，或上传到远程仓库，供大家使用。 internal repository是指在局域网内部搭建的repository，它跟central repository, jboss repository等的区别仅仅在于其URL是一个内部网址。

远程仓库可以在工程的pom.xml文件里指定。如果没指定，默认就会把下面这地方做远程仓库，即默认会到 http://repo1.maven.org/maven2 这个地方去请求插件和依赖包。

<repository>  
	<snapshots>  
        <enabled>false</enabled>  
    </snapshots>  
    <id>central</id>  
    <name>Maven Repository Switchboard</name>  
    <url>http://repo1.maven.org/maven2</url>  
</repository>

（2）镜像

镜像是仓库的镜子，保存了被镜像仓库的所有的内容,主要针对远程仓库而言。配置mirror的目的一般是出于网速考虑。如果仓库X可以提供仓库Y存储的所有内容，那么就可以认为X是Y的一个镜像。换句话说，任何一个可以从仓库Y获得的构件，都能够从它的镜像中获取。举个例子，http://maven.NET.cn/content/groups/public/ 是中央仓库 http://repo1.maven.org/maven2/ 在中国的镜像，由于地理位置的因素，该镜像往往能够提供比中央仓库更快的服务。

id的值为central，表示该配置为中央仓库的镜像，任何对于中央仓库的请求都会转至该镜像，用户也可以使用同样的方法配置其他仓库的镜像。

关于镜像的一个更为常见的用法是结合私服。由于私服可以代理任何外部的公共仓库(包括中央仓库)，因此，对于组织内部的Maven用户来说，使用一个私服地址就等于使用了所有需要的外部仓库，这可以将配置集中到私服，从而简化Maven本身的配置。在这种情况下，任何需要的构件都可以从私服获得，私服就是所有仓库的镜像。这时，可以配置这样的一个镜像，如例：

<settings>
    ...
    <mirrors>
        <mirror>
            <id>internal-repository</id>
            <name>Internal Repository Manager</name>
            <url>http://192.168.1.100/maven2</url>
            <mirrorOf>*</mirrorOf>
        </mirror>
    </mirrors>
    ...
</settings>

该例中的值为星号，表示该配置是所有Maven仓库的镜像，任何对于远程仓库的请求都会被转至http://192.168.1.100/maven2/。

如果该镜像仓库需要认证，则配置一个Id为internal-repository的即可。

二、全局settings、用户setting、pom的区别：

（1）全局 settings.xml 是 maven 的全局配置文件，一般位于${maven.home}/conf/settings.xml，即maven文件夹下的conf中。

（2）用户 setting是maven的用户配置文件，一般位于${user.home}/.m2/settings.xml，即每位用户都有一份配置文件。

（3）pom.xml 文件是项目配置文件，一般位于项目根目录下或子目录下。

配置优先级从高到低：pom.xml > 本地 settings > 全局 settings，如果这些文件同时存在，在应用配置时，会合并它们的内容，如果有重复的配置，优先级高的配置会覆盖优先级低的。

一般我们只需关注全局settings和pom即可。

三、全局settings配置文件

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
                          https://maven.apache.org/xsd/settings-1.0.0.xsd">
	
    <!-- 该值表示构建系统本地仓库的路径，默认值：~/.m2/repository，如：<localRepository>D:\repo</localRepository> -->
  	<localRepository/>
    
    <!--
		作用：表示maven是否需要和用户交互以获得输入
		如果maven需要和用户交互以获得输入，则设置成true，反之则应为false。默认为true。
	-->
  	<interactiveMode/>
    
    <!--
		作用：maven是否需要使用plugin-registry.xml文件来管理插件版本。
		如果需要让maven使用文件~/.m2/plugin-registry.xml来管理插件版本，则设为true。默认为false。
	-->
  	<usePluginRegistry/>
    
    <!--
		作用：表示maven是否需要在离线模式下运行。
		如果构建系统需要在离线模式下运行，则为true，默认为false。
		当由于网络设置原因或者安全因素，构建服务器不能连接远程仓库的时候，该配置就十分有用。
	-->
  	<offline/>
    
    <!--
		作用：当插件的组织id（groupId）没有显式提供时，供搜寻插件组织Id（groupId）的列表。
		该元素包含一个pluginGroup元素列表，每个子元素包含了一个组织Id（groupId）。
		当我们使用某个插件，并且没有在命令行为其提供组织Id（groupId）的时候，Maven就会使用该列表。
		默认情况下该列表包含了org.apache.maven.plugins和org.codehaus.mojo。
	<pluginGroups>
    	<pluginGroup>plugin的组织Id（groupId）:org.codehaus.mojo</pluginGroup>
  	</pluginGroups>
	-->    
  	<pluginGroups/>

    <!-- 下面几个标签详细介绍 -->
  	<servers/>
  	<mirrors/>
  	<proxies/>
  	<profiles/>
  	<activeProfiles/>
</settings>

2、servers 标签

2.1、作用：

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

2.2、使用

<servers>
    <server>
        <!-- server的id，不是用户登录的id，该id与distributionManagement中repository元素的id相匹配 -->
        <id>serverId</id>
        
        <!-- 鉴权用户名和鉴权密码表示服务器认证所需要的登录名和密码 -->
        <username>username</username>
        <password>password</password>
        
        <!-- 鉴权时使用的私钥位置 -->
        <privateKey>${usr.home}/.ssh/id_dsa</privateKey>
        <!-- 鉴权时使用的私钥密码 -->
      	<passphrase>passphrase</passphrase>
        
        <!-- 文件被创建时的权限 -->
      	<filePermissions>664</filePermissions>
      	<!-- 目录被创建时的权限 -->
      	<directoryPermissions>775</directoryPermissions>
    </server>
</servers>

2.3、demo：

（1）pom配置：

<repositories>
		<repository>
			<id>mvn-releases</id>
			<name>group Releases Repository</name>
			<url>https://xxx.xx/</url>
			<releases>
				<enabled>true</enabled>
			</releases>
			<snapshots>
				<enabled>false</enabled>
			</snapshots>
		</repository>
		<repository>
			<id>mvn-snapshots</id>
			<name>your company edu Snapshots Repository</name>
			<url>https://xxx.xx/</url>
			<releases>
				<enabled>false</enabled>
			</releases>
			<snapshots>
				<enabled>true</enabled>
			</snapshots>
		</repository>
		<repository>
			<id>mvn-repo</id>
			<name>mvn-repo</name>
			<url>https://depend.your company.com/artifactory/mvn-repo/</url>
		</repository>
	</repositories>

	<distributionManagement>
		<repository>
			<id>mvn-releases</id>
			<name>your company edu Releases Repository</name>
			<url>https://xxx.xx/</url>
		</repository>

		<snapshotRepository>
			<id>mvn-snapshots</id>
			<name>your company edu Snapshots Repository</name>
			<url>https://xxx.xx/</url>
		</snapshotRepository>
	</distributionManagement>

（2）全局settiing配置：

  <servers>
        <server>
            <id>mvn-repo</id>
            <username>zhangsan</username>
            <password>abcdefg</password>
        </server>
        <server>
            <id>mvn-snapshots</id>
            <username>zhahgsan</username>
            <password>abcdefg</password>
        </server>
        <server>
            <id>mvn-releases</id>
            <username>zhahgsan</username>
            <password>abcdefg</password>
        </server>
        <server>
            <id>mvn-mirror</id>
            <username>zhahgsan</username>
            <password>abcdefg</password>
         </server>
    </servers>

3、mirrors 标签

3.1、作用

用来配置相应的镜像仓库。如果仓库X可以提供仓库Y存储的所有内容，那么就可以认为X是Y的一个镜像。用过Maven的都知道，国外的中央仓库因为网络原因用起来太慢了，所以选择一个国内的镜像就很有必要，推荐国内的阿里云镜像。

3.2、使用

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

3.3、参数

（1）id与name：用来标识唯一的仓库；

（2）url：为镜像仓库地址

（3）mirrorOf：用来匹配当请求什么仓库依赖时使用该镜像。选项有：

<mirrorOf>*<mirrorOf>:匹配所有远程仓库。
<mirrorOf>external:*<mirrorOf>:匹配所有远程仓库，使用localhost的除外，使用file://协议的除外。也就是说，匹配所有不在本机上的远程仓库。
<mirrorOf>repo1,repo2<mirrorOf>:匹配仓库repo1h和repo2，使用逗号分隔多个远程仓库。
<mirrorOf>*,!repo1<mirrorOf>:匹配所有远程仓库，repo1除外，使用感叹号将仓库从匹配中排除。

注意事项：

（1）由于镜像仓库完全屏蔽了被镜像仓库，当镜像仓库不稳定或者停止服务的时候，Maven仍将无法访问被镜像仓库，因而将无法下载构件。

（2）maven 读取mirror 配置是从上往下读取的，因此谨慎配置<mirrorOf>*<mirrorOf>，因为如果第一个镜像仓库配置了如此标志，那么如果该仓库即使不存在对应依赖也不会向下游查询。

3.4、demo

 <mirrors>
        <mirror> 
            <id>mvn-mirror</id> 
            <mirrorOf>centra</mirrorOf> 
            <name>mvn-mirror</name> 
            <url>https://depend.yourcompany.com/artifactory/mvn-repo/</url>
        </mirror>
		<mirror>
			<id>alimaven</id>
			<mirrorOf>central</mirrorOf>
			<name>aliyun maven</name>
			<url>http://maven.aliyun.com/nexus/content/groups/public/</url>
		</mirror>
    </mirrors>

4、profiles标签

4.1、作用：

根据环境参数来调整构建配置的列表。

4.2、元素

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

（1）activation
作用：自动触发profile的条件逻辑。

如pom.xml中的profile一样，profile的作用在于它能够在某些特定的环境中自动使用某些特定的值；这些环境通过activation元素指定。

activation元素并不是激活profile的唯一方式。settings.xml文件中的activeProfile元素可以包含profile的id。profile也可以通过在命令行，使用-P标记和逗号分隔的列表来显式的激活（如，-P test）。注：在maven工程的pom.xml所在目录下执行mvn help:active-profiles命令可以查看中央仓储的profile是否在工程中生效。

（2）properties

demo：指定java版本号

<profile>
            <id>jdk-1.8</id>
            <activation>
                <activeByDefault>true</activeByDefault>
                <jdk>1.8</jdk>
            </activation>
            <properties>
                <maven.compiler.source>1.8</maven.compiler.source>
                <maven.compiler.target>1.8</maven.compiler.target>
                <maven.compiler.compilerVersion>1.8</maven.compiler.compilerVersion>
            </properties>
        </profile>

4.3、使用

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

4.4、demo

 <profiles>
     
        <profile>
            <id>mvn-repo</id>
            <repositories>
                <repository>
                    <id>mvn-repo</id>
                    <url>https://depend.yourcompany.com/artifactory/mvn-repo/</url>
                    <releases>
                        <enabled>true</enabled>
                        <updatePolicy>always</updatePolicy>
                    </releases>
                    <snapshots>
                        <enabled>true</enabled>
                        <updatePolicy>always</updatePolicy>
                    </snapshots>
                </repository>
            </repositories>
        </profile>
 
    </profiles>