maven 的 settings.xml 配置详解

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">

    <!-- 本地仓库配置，默认为 ${user.home}/.m2/repository -->
    <localRepository>D:\maven\repository</localRepository>

    <!-- 在pluginGroups元素下面可以定义一系列的pluginGroup元素。
    	表示当通过plugin的前缀来解析plugin的时候到哪里寻找。
        pluginGroup元素指定的是plugin的groupId。默认情况下，Maven会自动把org.apache.maven.plugins
        和 org.codehaus.mojo 添加到pluginGroups下。-->
    <pluginGroups></pluginGroups>

    <!--    这个属性表示在Maven进行项目编译和部署等操作时是否允许Maven进行联网来下载所需要的信息。
        如果构建系统需要在离线模式下运行，则为true，默认为false。
        当由于网络设置原因或者安全因素，构建服务器不能连接远程仓库的时候，可使用该配置该配置。-->
    <offline>false</offline>

    <!--    用来配置不同的代理。-->
    <proxies>
        <!--代理元素包含配置代理时需要的信息 -->
        <proxy>
            <!--代理的唯一定义符，用来区分不同的代理元素。 -->
            <!-- <id>my_proxy</id> -->
            <!--该代理是否是激活。true则激活代理，当声明了多组代理，
            	而只需要激活一个代理的时候，使用该元素控制。 -->
            <!-- <active>true</active> -->
            <!--代理的协议。 协议://主机名:端口，分隔成离散的元素以方便配置。 -->
            <!-- <protocol>http</protocol> -->
            <!--代理的主机名。协议://主机名:端口，分隔成离散的元素以方便配置。 -->
            <!-- <host>proxy.somewhere.com</host> -->
            <!--代理的端口。协议://主机名:端口，分隔成离散的元素以方便配置。 -->
            <!-- <port>8080</port> -->
            <!--代理的用户名，用户名和密码表示代理服务器认证的登录名和密码。 -->
            <!-- <username>proxy_user</username> -->
            <!--代理的密码，用户名和密码表示代理服务器认证的登录名和密码。 -->
            <!-- <password>some_password</password> -->
            <!--不该被代理的主机名列表。该列表的分隔符由代理服务器指定；如竖线，或逗号分隔。 -->
            <!-- <nonProxyHosts>*.google.com|ibiblio.org</nonProxyHosts> -->
        </proxy>
    </proxies>

    <!--  当仓库需要认证时，需要配置，server的id需要与repositories保持一致生效。

            一般，仓库的下载和部署是在pom.xml文件中的repositories 和 distributionManagement 元素中定义的。
            然而，一般类似用户名、密码（有些仓库访问是需要安全认证的）等信息不应该在pom.xml文件中配置，
            这些信息可以配置在 settings.xml 中。
    -->
    <servers>
        <server>
            <!--这是server的id（注意不是用户登陆的id），
            	该id与distributionManagement中repository元素的id相匹配。 -->
            <id>nexus</id>
            <!--鉴权用户名。鉴权用户名和鉴权密码表示服务器认证所需要的登录名和密码。 -->
            <username>admin</username>
            <!--鉴权密码 。鉴权用户名和鉴权密码表示服务器认证所需要的登录名和密码。密码加密功能已被添加到2.1.0 +。
            	详情请访问密码加密页面 -->
            <password>admin123</password>

            <!-- 鉴权时使用的私钥位置。和前两个元素类似，私钥位置和私钥密码指定了一个私钥的路径
                （默认是${user.home}/.ssh/id_dsa）以及如果需要的话，一个密语。
                将来passphrase和password元素可能会被提取到外部，但目前它们必须在settings.xml文件以纯文本的形式声明。
            -->
<!--            <privateKey>${usr.home}/.ssh/id_dsa</privateKey>-->

            <!--鉴权时使用的私钥密码。 -->
<!--            <passphrase>some_passphrase</passphrase>-->

            <!--文件被创建时的权限。如果在部署的时候会创建一个仓库文件或者目录，这时候就可以使用权限（permission）。
                这两个元素合法的值是一个三位数字，其对应了unix文件系统的权限，如664，或者775。 -->
<!--            <filePermissions>664</filePermissions>-->

            <!--目录被创建时的权限。 -->
<!--            <directoryPermissions>775</directoryPermissions>-->
        </server>
    </servers>

    <!--
    用于定义一系列的远程仓库的镜像。
        注意是镜像，而不是"分库"，只有当前一个mirror无法连接的时候，才会去找后一个，类似于备份和容灾。
        所以当第一个mirror中不存在a.jar的时候，并不会去第二个mirror中查找，甚至于，
        maven根本不会去其他的mirror地址查询。
        
        当有id为B,A,C的顺序的mirror在mirrors节点中，maven会根据字母排序来指定第一个，
        所以不管怎么排列，一定会找到A这个mirror来进行查找，当A无法连接，出现意外的情况下，才会去B查询。
     -->
    <mirrors>
        <mirror>
            <!-- 该镜像的唯一标识符。id用来区分不同的mirror元素。 -->
            <id>aliyunmaven</id>
            <!-- 被镜像的服务器的id。例如，如果我们要设置了一个Maven中央仓库
            	（http://repo.maven.apache.org/maven2/）的镜像，就需要将该元素设置成central。
                这必须和中央仓库的id central完全一致。 -->
            <mirrorOf>*</mirrorOf>
            <!-- 镜像名称 -->
            <name>阿里云公共仓库</name>
            <!-- 该镜像的URL。构建系统会优先考虑使用该URL，而非使用默认的服务器URL。 -->
            <url>https://maven.aliyun.com/repository/public</url>
        </mirror>

        <mirror>
            <id>nexus-163</id>
            <mirrorOf>*</mirrorOf>
            <name>网易 Nexus 163</name>
            <url>http://mirrors.163.com/maven/repository/maven-public/</url>
        </mirror>

        <mirror>
            <id>nexus-tencentyun</id>
            <mirrorOf>*</mirrorOf>
            <name>Nexus tencentyun</name>
            <url>http://mirrors.cloud.tencent.com/nexus/repository/maven-public/</url>
        </mirror>
    </mirrors>

    <!-- 根据环境参数来调整构建配置的列表。
        settings.xml 中的 profile 元素是 pom.xml 中 profile 元素的裁剪版本。
        它包含了id、activation、repositories、pluginRepositories 和 properties 元素。
        这里的profile元素只包含这五个子元素是因为这里只关心构建系统这个整体（这正是settings.xml文件的角色定位），
        而非单独的项目对象模型设置。
        
        如果一个settings.xml中的profile被激活，它的值会覆盖任何其它定义在pom.xml中带有相同id的profile。
        当所有的约束条件都满足的时候就会激活这个profile。
        
        使用默认激活方式时<activeByDefault>true</activeByDefault>，只有在没有指定其他profile激活时才会生效。
        激活的时候，若存在多个激活条件，多个条件是或的关系，即有一个条件满足就可以激活该profile。
    -->
    <profiles>
        <!-- java1.8版本 -->
        <profile>
            <!-- profile的唯一标识 -->
            <id>jdk-1.8</id>

            <!-- 自动触发profile的条件逻辑 -->
            <activation>

                <!-- 当其值为true的时候表示如果没有其他的profile处于激活状态的时候，该profile将自动被激活。-->
                <activeByDefault>true</activeByDefault>
                <jdk>1.8</jdk>
            </activation>

            <!-- 扩展属性列表 -->
            <!-- 用于定义属性键值对的。当该profile是激活状态的时候，properties下面指定的属性都可以在pom.xml中使用。 -->
            <!--如果Maven检测到某一个属性（其值可以在POM中通过${name}引用），
                其拥有对应的name = 值，Profile就会被激活。如果值字段是空的，那么存在属性名称字段就会激活profile，
                否则按区分大小写方式匹配属性值字段 -->
            <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>

        <profile>
            <id>nexus</id>

            <!-- 远程仓库列表 -->
            <!-- 用于定义远程仓库的，当该profile是激活状态的时候，这里面定义的远程仓库将作为当前pom的远程仓库。
                它是maven用来填充构建系统本地仓库所使用的一组远程仓库。 -->
            <repositories>
                <!--包含需要连接到远程仓库的信息 -->
                <repository>
                    <!--远程仓库唯一标识 -->
                    <id>maven-releases</id>
                    <!--远程仓库名称 -->
                    <name></name>
                    <url>http://maven-releases</url>

                    <!--如何处理远程仓库里发布版本的下载 -->
                    <releases>
                        <!--true或者false表示该仓库是否为下载某种类型构件（发布版，快照版）开启。 -->
                        <enabled>true</enabled>

                        <!--该元素指定更新发生的频率。Maven会比较本地POM和远程POM的时间戳。
                            这里的选项是：always（一直），daily（默认，每日），
                            interval：X（这里X是以分钟为单位的时间间隔），或者never（从不）。 -->
                        <updatePolicy>always</updatePolicy>

                        <!--当Maven验证构件校验文件失败时该怎么做-ignore（忽略），fail（失败），或者warn（警告）。 -->
                        <checksumPolicy>warn</checksumPolicy>
                    </releases>

                    <!--如何处理远程仓库里快照版本的下载。有了releases和snapshots这两组配置，POM就可以在每个单独的仓库中，
                        为每种类型的构件采取不同的策略。
                        例如，可能有人会决定只为开发目的开启对快照版本下载的支持。参见repositories/repository/releases元素 -->
                    <snapshots>
                        <enabled>true</enabled>
                    </snapshots>

                    <!--用于定位和排序构件的仓库布局类型-可以是default（默认）或者legacy（遗留）。
                        Maven 2为其仓库提供了一个默认的布局；然而，Maven 1.x有一种不同的布局。
                        我们可以使用该元素指定布局是default（默认）还是legacy（遗留）。 -->
                    <layout>default</layout>

                </repository>
                <repository>
                    <id>maven-snapshots</id>
                    <url>http://nexus-snapshots</url>
                    <releases>
                        <enabled>true</enabled>
                    </releases>
                    <snapshots>
                        <enabled>true</enabled>
                    </snapshots>
                </repository>
            </repositories>

            <!-- 插件仓库列表，maven插件的仓库从这里下载 -->
            <pluginRepositories>
                <pluginRepository>
                    <id>maven-releases</id>
                    <url>http://nexus-releases</url>
                    <releases>
                        <enabled>true</enabled>
                    </releases>
                    <snapshots>
                        <enabled>true</enabled>
                    </snapshots>
                </pluginRepository>
                <pluginRepository>
                    <id>maven-snapshots</id>
                    <url>http://maven-snapshots</url>
                    <releases>
                        <enabled>true</enabled>
                    </releases>
                    <snapshots>
                        <enabled>true</enabled>
                    </snapshots>
                </pluginRepository>
            </pluginRepositories>
        </profile>
    </profiles>

    <!-- 手动激活profiles的列表，按照profile被应用的顺序定义activeProfile。
        该元素包含了一组activeProfile元素，每个activeProfile都含有一个profile id。
        任何在activeProfile中定义的profile id，不论环境设置如何，其对应的 profile都会被激活。
        如果没有匹配的profile，则什么都不会发生。
        例如: env-test是一个activeProfile，则在pom.xml（或者profile.xml）中对应id的profile会被激活。
            如果运行过程中找不到这样一个profile，Maven则会像往常一样运行。-->
    <activeProfiles>
        <!-- 要激活的profile id -->
        <activeProfile>nexus</activeProfile>
    </activeProfiles>
</settings>

maven 拉取资源的优先顺序

<!--
      基本优先级顺序：本地仓库 > settings.xml的profile的仓库 > pom.xml的profile的仓库 > pom.xml的仓库 > 中央仓库
      
      如果仓库的id设置成"central"，则该仓库会覆盖maven默认的中央仓库配置
      （这种情况会影响基本优先级，例如在setting.xml中配置了一个仓库，且id为"central"，此时这个仓库覆盖了中央仓库，但是优先级变为小于pom.xml的profile的仓库， 大于pom.xml的仓库）。
      
      如果发现该仓库有镜像设置，则用镜像的地址代替，例如现在进行到要在respository A仓库中查找某个依赖，但A仓库配置了mirror，则会转到从A的mirror中查找该依赖，不会再从A中查找。
      
      如果最终下载不到需要的资源，maven则会报错。
-->