maven仓库配置及搜索顺序

vlambda
2022-05-03

maven仓库配置及搜索顺序

写在前面

今天在构建 IBPMS（Java Business Process Management，业务流程管理）demo 时，出现依赖的包无法下载，运行环境时公网内网环境，趁此梳理一下 maven 仓库的配置方式，并解一下自己的疑惑。

maven 仓库配置方式

maven setting.xml 文件配置

<settings> <mirrors>  <mirror>  <id>tbmirror-all</id>  <mirrorOf>*</mirrorOf>  <name>taobao mirror</name> <url>http://mvnrepo.abc.com/mvn/repository</url> </mirror> </mirrors>    <profiles> <profile>  <id>test</id>  <repositories>  <repository>  <id>central</id>  <url>http://mvnrepo.abc.com/mvn/repository</url>  </repository>  </repositories>   <!-- maven插件的仓库从这里下载 --> <pluginRepositories>  <pluginRepository>  <id>central</id>  <url>http://mvnrepo.abc.com/mvn/repository</url>  </pluginRepository>  </pluginRepositories>  </profile>  </profiles> 
 <pluginGroups> <pluginGroup>com.alibaba.org.apache.maven.plugins</pluginGroup> <pluginGroup>com.alibaba.maven.plugins</pluginGroup> </pluginGroups>  <activeProfiles>  <activeProfile>test</activeProfile>  </activeProfiles> </settings>

镜像 mirror

如果仓库 X 可以提供仓库 Y 存储的所有内容，那么就可以认为 X 是 Y 的一个镜像。换句话说，任何一个可以从仓库 Y 获得的构件，都能够从它的镜像中获取。举个例子，http://maven.net.cn/content/groups/public/ 是中央仓库 http://repo1.maven.org/maven2/ 在中国的镜像，由于地理位置的因素，该镜像能够提供比中央仓库更快的服务。因此，可以配置 Maven 使用该镜像来替代中央仓库，代码如下：

<settings> ... <mirrors> <mirror> <id>maven.net.cn</id> <name>one of the central mirrors in china</name> <url>http://maven.net.cn/content/groups/public/</url> <mirrorOf>central</mirrorOf> <!--central表示覆盖maven中央仓库的默认id，表示所有的仓库都到该配置的 url 去取> </mirror> </mirrors> ...</settings>

maven仓库配置及搜索顺序

从上图看，实际上 mirror 就相当于一个代理，它会拦截去指定的远程 repository 下载构件的请求，然后从 mirror 配置的仓库中中找出构件回送给客户端，配置mirror的目的一般是出于网速考虑。另外标签 mirrorOf 里面放置的是要被镜像的 Repository ID，下面列一些常用的配置（部分说明摘自《Maven实战》）：

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

应用 pom.xml 仓库配置方式

这里的配置与 maven setting 类似，不再多余解释，直接引用笔者的 demo 配置，如下：

<repositories> <repository> <id>jboss-public-repository-group</id> <name>JBoss Public Repository Group</name> <url>https://repository.jboss.org/nexus/content/groups/public/</url> <layout>default</layout> <releases> <updatePolicy>never</updatePolicy> </releases> <snapshots> <updatePolicy>daily</updatePolicy> </snapshots> </repository> </repositories>

maven 仓库搜索优先级

maven 仓库搜索路径

maven 仓库搜索需要分两种场景：

Case 1：如果没有配置 mirrorOf* 的镜像仓库，搜索路径按照下面顺序获取构件（jar）

查找本地仓库，如果没有则进入到下一步
在全局应用的私服仓库中（setting.xml文件的profile）寻找，如果没有则进入下一步
在应用自身的私服仓库中（应用pom.xml配置的repository）寻找，如果没有则进入下一步

Case 2：如果配置有 mirrorOf * 的镜像仓库，则忽略上述规则，只从此仓库获取jar包（详细参考下面示例）

场景分析

以博主遇到的场景做分析，xmlpull.jar 包不在公司的远程仓库（http://mvnrepo.abc.com/mvn/repository）中，存在于远程仓库https://repository.jboss.org/nexus/content/groups/public，结合以下两种场景来说明问题。

场景一：以下配置能从远程仓库中正常拉取 xmlpull.jar 包
原因：按上述搜索顺序，先从在全局应用的私服仓库中（setting.xml文件的profile）寻找，没有找到，则从项目 pom.xml 配置的 repository 找到并下载成功。
maven setting.xml 配置如下

<settings> <mirrors>  <mirror>  <id>tbmirror-all</id>  <mirrorOf>central</mirrorOf> <!--这里的id配置本质上和什么也不配置没有什么区别--> <name>taobao mirror</name> <url>http://mvnrepo.abc.com/mvn/repository</url> </mirror> </mirrors>    <profiles> <profile>  <id>test</id>  <repositories>  <repository>  <id>central</id>  <url>http://mvnrepo.abc.com/mvn/repository</url>  </repository>  </repositories>   <!-- maven插件的仓库从这里下载 --> <pluginRepositories>  <pluginRepository>  <id>central</id>  <url>http://mvnrepo.abc.com/mvn/repository</url>  </pluginRepository>  </pluginRepositories>  </profile>  </profiles> 
 <pluginGroups> <pluginGroup>com.alibaba.org.apache.maven.plugins</pluginGroup> <pluginGroup>com.alibaba.maven.plugins</pluginGroup> </pluginGroups>  <activeProfiles>  <activeProfile>test</activeProfile>  </activeProfiles> </settings>

应用 pom.xml 仓库配置如下：

<repositories> <repository> <id>jboss-public-repository-group</id> <name>JBoss Public Repository Group</name> <url>https://repository.jboss.org/nexus/content/groups/public/</url> <layout>default</layout> <releases> <updatePolicy>never</updatePolicy> </releases> <snapshots> <updatePolicy>daily</updatePolicy> </snapshots> </repository> </repositories>

场景二：以下配置不能从远程仓库中拉取 xmlpull.jar 包，报错误信息：one of its dependencies could not be resolved: Could not find artifact xmlpull:xmlpull:jar:1.2.0 in tbmirror-all (http://mvnrepo.abc.com/mvn/repository)
原因：maven setting.xml 配置了 mirror*，只从公司私服上下载 xmlpull.jar 包，未找到则报错
maven setting.xml 配置如下：

<settings> <mirrors>  <mirror>  <id>tbmirror-all</id>  <mirrorOf>*</mirrorOf> <name>taobao mirror</name> <url>http://mvnrepo.abc.com/mvn/repository</url> </mirror> </mirrors>    <profiles> <profile>  <id>test</id>  <repositories>  <repository>  <id>central</id>  <url>http://mvnrepo.abc.com/mvn/repository</url>  </repository>  </repositories>   <!-- maven插件的仓库从这里下载 --> <pluginRepositories>  <pluginRepository>  <id>central</id>  <url>http://mvnrepo.abc.com/mvn/repository</url>  </pluginRepository>  </pluginRepositories>  </profile>  </profiles> 
 <pluginGroups> <pluginGroup>com.alibaba.org.apache.maven.plugins</pluginGroup> <pluginGroup>com.alibaba.maven.plugins</pluginGroup> </pluginGroups>  <activeProfiles>  <activeProfile>test</activeProfile>  </activeProfiles> </settings>

应用 pom.xml 仓库配置如下：

<repositories> <repository> <id>jboss-public-repository-group</id> <name>JBoss Public Repository Group</name> <url>https://repository.jboss.org/nexus/content/groups/public/</url> <layout>default</layout> <releases> <updatePolicy>never</updatePolicy> </releases> <snapshots> <updatePolicy>daily</updatePolicy> </snapshots> </repository> </repositories>