Maven的settings.xml文件结构之Servers，Mirror和Repository

小咪咪 2023-07-07 08:41 9阅读 0赞

# 一个Setting.xml模板解析 #

在maven的配置文件settings.xml中，有Servers节点，Mirror节点和Repository节点，一个典型的settings.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>E:/java/apache-maven-3.3.9/repository</localRepository>
        
        
        
        
        
        <pluginGroups>
            
        </pluginGroups>
        
        <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>
        
        <servers>
            
            <server>
                
                <id>frame-releases</id>
                
                <username>admin</username>
                
                <password>admin123</password>
            </server>
            <server>
                <id>siteServer</id>
                
                <privateKey>/path/to/private/key</privateKey>
                
                <passphrase>optional; leave empty if not used.</passphrase>
                
                <filePermissions>664</filePermissions>
                
                <directoryPermissions>775</directoryPermissions>
            </server>
        </servers>
        
        <mirrors>
            <mirror>
                
                <id>mirrorId</id>
                
                <mirrorOf>repositoryId</mirrorOf>
                
                <name>Human Readable Name for this Mirror.</name>
                
                <url>http://196.160.1.211:8081/nexus/content/groups/public/</url>
            </mirror>
        </mirrors>
        
        <profiles>
            
            <profile>
                
                <id>jdk-1.4</id>
                
                <activation>
                    
                    <activeByDefault>false</activeByDefault>
                    
                    <jdk>1.5</jdk>
                    
                    <os>
                        
                        <name>Windows XP</name>
                        
                        <family>Windows</family>
                        
                        <arch>x86</arch>
                        
                        <version>5.1.2600</version>
                    </os>
                    
                    <property>
                        
                        <name>mavenVersion</name>
                        
                        <value>2.0.3</value>
                    </property>
                    
                    <file>
                        
                        <exists>${basedir}/file2.properties</exists>
                        
                        <missing>${basedir}/file1.properties</missing>
                    </file>
                </activation>
                
                <repositories>
                    <repository>
                        <id>jdk14</id>
                        <name>Repository for JDK 1.4 builds</name>
                        <url>http://www.myhost.com/maven/jdk14</url>
                        <layout>default</layout>
                        <snapshotPolicy>always</snapshotPolicy>
                    </repository>
                </repositories>
            </profile>
            <profile>
                <id>env-dev</id>
                <activation>
                    <property>
                        <name>target-env</name>
                        <value>dev</value>
                    </property>
                </activation>
                <properties>
                    <tomcatPath>/path/to/tomcat/instance</tomcatPath>
                </properties>
            </profile>
            <profile>
                <id>nexusProfile</id>
                
                <repositories>
                    
                    <repository>
                        
                        <id>nexusProfile</id>
                        
                        <name>nexus repository</name>
                        
                        <layout>default</layout>
                        
                        <url>http://196.160.1.211:8081/nexus/content/groups/public/</url>
                        
                        <releases>
                            
                            <enabled>true</enabled>
                            
                            <updatePolicy>always</updatePolicy>
                            
                            <checksumPolicy>warn</checksumPolicy>
                        </releases>
                        
                        <snapshots>
                            <enabled>true</enabled>
                        </snapshots>
                    </repository>
                </repositories>
            </profile>
            <profile>
                <id>centralProfile</id>
                <repositories>
                    <repository>
                        <id>central</id>
                        <name>Central Repository</name>
                        
                        <url>https://repo.maven.apache.org/maven2</url>
                        <layout>default</layout>
                        <snapshots>
                            <enabled>true</enabled>
                        </snapshots>
                    </repository>
                </repositories>
            </profile>
        </profiles>
        
        <activeProfile>nexusProfile</activeProfile>
        <activeProfile>centralProfile</activeProfile>
    </settings>

pom.xml中的配置

<distributionManagement>
        <repository>
            
            <id>frame-releases</id>
            <name>frame-releases</name>
            <url>http://localhost:8081/nexus/content/repositories/releases/</url>
        </repository>
        <snapshotRepository>
            <id>frame-snapshots</id>
            <name>frame Snapshots Repository</name>
            <url>http://localhost:8081/nexus/content/repositories/snapshots/</url>
        </snapshotRepository>
    </distributionManagement>

# Servers，Mirror和Repository的关系 #

## Servers ##

一个典型的Servers如下所示

<servers>
        <server>
            <id>server001</id>
            <username>my_login</username>
            <password>my_password</password>
            <filePermissions>664</filePermissions>
            <directoryPermissions>775</directoryPermissions>
            <configuration></configuration>
        </server>
        <server>
            <id>server002</id>
            <privateKey>${user.home}/.ssh/id_dsa</privateKey>
            <passphrase>some_passphrase</passphrase>
            <filePermissions>664</filePermissions>
            <directoryPermissions>775</directoryPermissions>
            <configuration></configuration>
        </server>
    </servers>

对于一个server，其：  
**id**：服务器的ID，Maven在连接一个库或者镜像的时候，通过id匹配要连接的服务器；  
**username, password**：连接服务器所需的认证信息；  
**privateKey, passphrase**：连接服务器所需的认证信息。privateKey默认位于$\{user.home\}/.ssh/id\_dsa；  
**filePermissions, directoryPermissions**：库中的文件访问权限和目录访问权限。该值的格式采用3位数字，兼容UNIX/Linux下格式；  
**configuration**：访问服务器辅助要传递的参数，通常不必要；

## Mirror节点 ##

<mirrors>  
      <mirror>  
        <id>UK</id>  
        <name>UK Central</name>  
        <url>http://uk.maven.org/maven2</url>  
        <mirrorOf>central</mirrorOf>  
      </mirror>  
    </mirrors>

mirror相当于一个拦截器，它会拦截maven对remote repository的相关请求，把请求里的remote repository地址，重定向到mirror里配置的地址。  
**没有配置mirror：**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMzI5MzM0MzI_size_16_color_FFFFFF_t_70]  
**配置了mirror**  
![image.png][]  
此时，B Repository被称为A Repository的镜像。  
`<mirrorOf></mirrorOf>`标签里面放置的是要被镜像的Repository ID  
为了满足一些复杂的需求，Maven还支持更高级的镜像配置：

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

## Repository（仓库） ##

Maven仓库主要有2种

1.  Remote Repository：相当于公共的仓库，大家都能访问到，一般可以用URL的形式访问
2.  Local Repository：存放在本地磁盘的一个文件夹，例如，windows上默认是C:\\Users\\｛用户名｝.m2\\repository目录  
    Remote Repository又主要有3种
3.  中央仓库：http://repo1.maven.org/maven2/
4.  私服：内网自建的maven repository，其URL是一个内部网址
5.  其他公共仓库：其他可以互联网公共访问maven repository，例如 jboss repository等

关系图如下  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMzI5MzM0MzI_size_16_color_FFFFFF_t_70 1]

## Mirror和Repository的关系 ##

例如， 有一个项目，需要在公司和住所都编码，并在项目pom.xml配置了A Maven库。在公司，是电信网络，访问A库很快，所以maven管理依赖和插件都从A库下载；在住所，是网通网络，访问A库很慢，但是访问B库很快。这时，只要在住所的setting.xml里配置如下

<mirrors>
        <mirror>
            <id>B</id>
            <name>B Central</name>
            <url>http://www.B.com/maven2</url>
            <mirrorOf>A</mirrorOf>
        </mirror>
    </mirrors>

让B库成为A 库的mirror，项目中配置的还是A库

即可不用更改项目pom.xml里对于A库的相关配置，就可以让项目去B库下载依赖。

## Repository和servers的关系 ##

1、在maven的工程中，pom中使用ditributionManagement标签私服地址。

<distributionManagement>
        <repository>
            <id>release-repository</id>
            <name>Release Repository</name>
            <url>http://www.myrepository.com/repositories/releases</url>
        </repository>
        <snapshotRepository>
            <id>snapshot-repository</id>
            <name>Snapshot Repository</name>
            <url>http://www.myrepository.com/repositories/snapshots</url>
        </snapshotRepository>
    </distributionManagement>

上面的例子，我们公司的私服地址是http://www.myrepository.com，配置了SNAPSHOT包的上传路径和RELEASE包的上传路径。

2、在maven的settings.xml中配置servers。

<servers>
        <server>
            <id>snapshot-repository</id>
            <username>snapshot</username>
            <password>123456</password>
        </server>
        <server>
            <id>release-repository</id>
            <username>release</username>
            <password>123456</password>
        </server>
    </servers>

需要注意的是两处的id需要相互匹配。  
帐号的权限都是私服配置的。上传到SNAPSHOT还是RELEASE是由项目的version决定的。

## 总结下三者的关系 ##

比如要使用B镜像代理pom.xml中的配置的A仓库则进行如下配置

<mirror>
        <id>B</id>
        <name>B Central</name>
        <url>http://www.B.com/maven2</url>
        <mirrorOf>A</mirrorOf>
    </mirror>

如果pom.xml中没有配置仓库，则使用的是默认的central，这也是为什么配置阿里云镜像采用的是如下配置

<mirror>
        <id>alimaven</id>
        <name>aliyun maven</name>
        <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
        <mirrorOf>central</mirrorOf>
    </mirror>

如果配置的仓库有用户名密码怎么办？

<server>
        <id>B</id>
        <username>my_login</username>
        <password>my_password</password>
    </server>

要求server的id与mirror id或者repository id相同，密码才能生效。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMzI5MzM0MzI_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20210204153833731.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMzI5MzM0MzI=,size_16,color_FFFFFF,t_70
[image.png]: https://imgconvert.csdnimg.cn/aHR0cDovL3d3dy5ieG9vbi5jb20vdXBsb2FkLzIwMjAvMi9pbWFnZS1jYjJhNjRlMTU3NDQ0Y2IwOWYyOWNkMDFiNDIzZDRiNS5wbmc?x-oss-process=image/format,png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMzI5MzM0MzI_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20210204154235160.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMzI5MzM0MzI=,size_16,color_FFFFFF,t_70