通过测试和代码告诉你Maven是如何使用mirror和repository的

我以前用maven的时候用的都是默认的配置，自己没有修改过。。虽然许多时候下载很慢，也没有深入了解过maven的配置。。

不过最近一段时间遇到了很多问题，把官方关于settings和pom的结构的文档看了一遍，收获不小。

我遇到问题的主要原因是因为我在不知道配置含义的条件下，按照《开源中国 Maven 库使用帮助》修改了配置，速度提升非常明显。但是该帮助有一个最大的问题。看下面的配置：

<mirror>
	<id>nexus-osc</id>
	<mirrorOf>*</mirrorOf>
	<name>Nexus osc</name>
	<url>http://maven.oschina.net/content/groups/public/</url>
</mirror>

请注意这里的mirrorOf，关于mirrorOf的作用请看： http://my.oschina.net/flags/blog/209827

这里配置为*（星号）后，会导致所有的仓库都会通过osc的这个源去访问jar，由于osc现在的maven仓库和中央仓库一样，但是不包含第三方的仓库，因而第三方仓库都会出错，都会从osc的主仓库去查找，肯定找不到，因而maven会构建失败或者各种问题。

虽然osc还不是maven的一个官方镜像，但是完全可以将mirrorOf设置为central，central是maven中央仓库的id。只有修改为central之后，才能完全兼容所有情况，其他配置的repository才能起到作用（测试过，大家可以试试*星号和central）。

mirrorOf配置*（星号）的时候，一般都是针对自己私有库的时候（私有库和其他仓库配置）。而且如果存在多个mirror，一定要把*（星号）的放到最下面。

为了更深入的了解maven和mirror、repository的关系，粗略看了maven的源码，代码如下：

@Deprecated
public ArtifactRepository getMirrorRepository(ArtifactRepository repository) {
    Mirror mirror = mirrorSelector.getMirror(repository, legacySupport.getSession().getSettings().getMirrors());
    if (mirror != null) {
        String id = mirror.getId();
        if (id == null) {
            // TODO: this should be illegal in settings.xml
            id = repository.getId();
        }
        log.debug("Using mirror: " + mirror.getUrl() + " (id: " + id + ")");
        repository = artifactRepositoryFactory.createArtifactRepository(id, mirror.getUrl(),
                repository.getLayout(), repository.getSnapshots(),
                repository.getReleases());
    }
    return repository;
}

maven首先会去查找repository对应的镜像（查找逻辑看后面的代码），如果在settings里面找不到对应的mirror，就会返回传入的repository，也就是说，如果仓库没有对应的镜像（mirror），那么就会直接用repository的url去获取。

如果找到了mirror，就会执行artifactRepositoryFactory.createArtifactRepository(...)方法，这个方法用mirror去构造一个新的repository，会使用mirror配置的url去查找。

系统中定义了一个全匹配*和外部全匹配external:*

private static final String WILDCARD = "*";
private static final String EXTERNAL_WILDCARD = "external:*";

maven查找mirror的逻辑代码如下：

public Mirror getMirror(ArtifactRepository repository, List<Mirror> mirrors) {
    String repoId = repository.getId();
    if (repoId != null && mirrors != null) {
        for (Mirror mirror : mirrors) {
            if (repoId.equals(mirror.getMirrorOf()) && matchesLayout(repository, mirror)) {
                return mirror;
            }
        }
        for (Mirror mirror : mirrors) {
            if (matchPattern(repository, mirror.getMirrorOf()) && matchesLayout(repository, mirror)) {
                return mirror;
            }
        }
    }
    return null;
}

从代码可以看到，首先查找mirrorOf和repository的id一样并且Layout一致的镜像，由于layout很少配置，所以这里是第一条规则：

1.首先匹配mirrorOf和仓库id一样的镜像。

从第二个for循环可以看到这里使用规则来进行匹配，规则匹配代码：

static boolean matchPattern(ArtifactRepository originalRepository, String pattern) {
    boolean result = false;
    String originalId = originalRepository.getId();
    //首先匹配*号，如果mirrorOf是*号，就用当前的镜像
    //或者如果当前的mirrorOf和repository的id一样也返回(这在前面的for循环处理过，所以这种情况基本不会出现)
    if (WILDCARD.equals(pattern) || pattern.equals(originalId)) {
        result = true;
    } else {
        //其次mirrorOf支持多个用逗号隔开,这里先拆分,逐个循环
        String[] repos = pattern.split(",");
        for (String repo : repos) {
            //repo支持!(感叹号)来屏蔽一个repository的Id，这里先判断如果是排除的，就return false
            if (repo.length() > 1 && repo.startsWith("!")) {
                if (repo.substring(1).equals(originalId)) {
                    // explicitly exclude. Set result and stop processing.
                    result = false;
                    break;
                }
            }
            //逗号隔开中的一个值和repository的id一样就返回true
            else if (repo.equals(originalId)) {
                result = true;
                break;
            }
            //检查外部匹配external:*
            else if (EXTERNAL_WILDCARD.equals(repo) && isExternalRepo(originalRepository)) {
                result = true;
            }
            //最后检查*匹配
            else if (WILDCARD.equals(repo)) {
                result = true;
            }
        }
    }
    return result;
}

由于代码比较长，因而写成代码注释了，代码很容易理解，可以参考注释。

从这段代码可以得到如下规则：

2.如果mirrorOf是*（星号）或者和repo的id一样就使用该mirror

3.对于mirrorOf多个或一个的情况，从第一个开始判断

    3.1如果是一个排除选项，就不使用这个mirror

    3.2如果正好和repo的id一样就使用这个mirror

    3.3判断是否外部匹配（这里还有一个isExternalRepo方法，判断是否为本地库），如果不是本地仓库，就用该mirror

    3.4判断是否为*（星号），如果是，就用该镜像。

除了1,2,3（1~4）几条规则外，还需要注意最外层的循环，首先会从settings配置的第一个mirror开始循环，其次从mirrorOf逗号隔开的内容循环。

通过以上测试和了解代码，终于弄明白maven如何处理mirror和repository关系。也希望对此不明白的人有所帮助。

最后个人希望osc可以修改 开源中国 Maven 库使用帮助：http://maven.oschina.net/help.html 让更多的人能真正了解配置的含义，或者尽量减少初学者可能遇到的类似问题。