java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > Maven settings.xml

Maven配置文件settings.xml的实现

作者:Slow菜鸟

Maven是一个用于构建和管理Java项目的强大工具,它依赖于设置文件来配置和管理其行为,其中最重要的之一便是settings.xml文件,本文主要介绍了Maven配置文件settings.xml的实现,具有一定的参考价值,感兴趣的可以了解一下

Maven是一个用于构建和管理Java项目的强大工具,它依赖于设置文件来配置和管理其行为。其中最重要的之一便是settings.xml文件。settings.xml文件是Maven的配置文件之一,用于定义Maven的全局设置、仓库、代理、插件、配置和个人用户信息等。这个文件通常存储在Maven安装目录的conf文件夹下。

让我们深入了解settings.xml文件的结构和功能。

setting文件位置

Maven使用setting.xml文件来配置它本身的行为。这个文件通常位于Maven的conf目录下。

maven多仓库查找依赖的顺序大致如下:

1.本地仓库
2.项目profile仓库,通过 pom.xml 中的 project.profiles.profile.repositories.repository 配置
3.项目仓库,通过 pom.xml 中的 project.repositories.repository 配置
4.全局profile仓库,通过 settings.xml 中的 settings.repositories.repository 配置
5.镜像仓库,通过 sttings.xml 中的 settings.mirrors.mirror 配置
6.中央仓库,这是默认的仓库

基本配置选项

基本结构
settings.xml文件使用XML格式,其结构包含了Maven的全局设置以及个人或项目特定的配置。下面是一个典型的settings.xml文件的简化版本:

<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>D:\IDEA\my-idea-repository</localRepository>

    <!-- 镜像设置,用于指定中央仓库的镜像,以提高依赖项下载的速度 -->
    <mirrors>
        <!-- 阿里私服 -->
        <mirror>
            <id>alimaven</id>
            <mirrorOf>central</mirrorOf>
            <name>aliyun maven</name>
            <url>http://maven.aliyun.com/nexus/content/repositories/central/</url>
        </mirror>

        <!-- 中央仓库1 -->
        <mirror>
            <id>repo1</id>
            <mirrorOf>central</mirrorOf>
            <name>Human Readable Name for this Mirror.</name>
            <url>http://repo1.maven.org/maven2/</url>
        </mirror>

        <!-- 中央仓库2 -->
        <mirror>
            <id>repo2</id>
            <mirrorOf>central</mirrorOf>
            <name>Human Readable Name for this Mirror.</name>
            <url>http://repo2.maven.org/maven2/</url>
        </mirror>
    </mirrors>

</settings>

localRepository(本地仓库设置)

<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">
  ...
 <!--本地仓库。该值表示构建系统本地仓库的路径。其默认值为${user.home}/.m2/repository。  -->  
<localRepository>usr/local/maven</localRepository> 
  ...
</settings>

mirrors(镜像设置)

<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">
  ...
<!--为仓库列表配置的下载镜像列表。用于指定中央仓库的镜像,以提高依赖项下载的速度  -->  
    <mirrors>  
            
        <!-- 
         | 【mirro 匹配顺序】: 
         | 多个 mirror 优先级 按照 id字母顺序进行排列(即与编写的顺序无关)
         | 在第一个 mirror 找不到 artifact, 不会继续超找下一个镜像。
         | 只有当 mirror 无法链接的时候, 才会尝试链接下一个镜像, 类似容灾备份。
         |-->

        <mirror>

            <!-- 该镜像的唯一标识符, id用来区分不同的 mirror 元素, 同时会套用使用 server 中 id 相同授权配置链接到镜像 -->
            <id>aliyun</id>

            <!-- 镜像名称, 无特殊作用, 可视为简述 -->
            <name>sjtug maven proxy</name>

            <!-- 镜像地址 -->
            <url>https://mirrors.sjtug.sjtu.edu.cn/maven-central/</url>
            <!-- mirrorOf表示被镜像的服务器的id, 
              必须与 repository 节点设置的 ID 一致。但是 This must not match the mirror id
             | mirrorOf 的配置语法: 
             | *           = 匹配所有远程仓库。 这样所有 pom 中定义的仓库都不生效
             | external:*  = 匹配除 localhost、使用 file:// 协议外的所有远程仓库
             | repo1,repo2 = 匹配仓库 repo1 和 repo2
             | *,!repo1    = 匹配所有远程仓库, repo1 除外
             |-->
            <mirrorOf>central</mirrorOf>
        </mirror>  
           
    </mirrors>  
      ...
</settings>

servers(服务器)

用于下载和部署的存储库由项目的pom.xml 的repositories和distributionManagement元素定义。
但是,用户名和密码等某些身份设置不应该与pom.xml一起发布。
这类信息应该存在于构建服务器的settings.xml中。

<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">
  ...
  <!-- 进行远程服务器访问时所需的授权配置信息。通过系统唯一的 server-id 进行唯一关联 -->
    <servers>
        <server>
            <!-- 这是 server 的 id, 该 id 与 distributionManagement 中 repository 元素的id 相匹配 -->
            <id>server_id</id>

            <!-- 鉴权用户名 -->
            <username>auth_username</username>

            <!-- 鉴权密码 -->
            <password>auth_pwd</password>

            <!-- 鉴权时使用的私钥位置。和前两个元素类似, 私钥位置和私钥密码指定了一个私钥的路径(默认是/home/hudson/.ssh/id_dsa)以及如果需要的话, 一个密钥 -->
            <privateKey>path/to/private_key</privateKey>

            <!-- 鉴权时使用的私钥密码, 非必要, 非必要时留空 -->
            <passphrase>some_passphrase</passphrase>

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

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

            <!-- 传输层额外的配置项 -->
            <configuration></configuration>

        </server>
    </servers>
  ...
</settings>

Profiles(配置文件)

作用:根据环境参数来调整maven管理的所有项目的配置。
settings.xml中的profile元素是pom.xml中profile元素的裁剪版本。它包含了id、activation、repositories、pluginRepositories和 properties元素。这里的profile元素只包含这五个子元素是因为这里只关心构建系统这个整体(这正是settings.xml文件的角色定位),而非单独的项目对象模型设置。
如果一个settings.xml中的profile被激活,它的值会覆盖任何其它定义在pom.xml中带有相同id的profile。当所有的约束条件都满足的时候就会激活这个profile。

<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">
  ...
<!--
     | 构建方法的配置清单, maven 将根据不同环境参数来使用这些构建配置。
     | settings.xml 中的 profile 元素是 pom.xml 中 profile 元素的裁剪版本。
     | settings.xml 负责的是整体的构建过程, pom.xml 负责单独的项目对象构建过程。
     | settings.xml 只包含了id, activation, repositories, pluginRepositories 和 properties 元素。
     | 
     | 如果 settings 中的 profile 被激活, 它的值会覆盖任何其它定义在 pom.xml 中或 profile.xml 中的相同 id 的 profile。
     |
     | 查看当前激活的 profile:
     |   mvn help:active-profiles
     |-->
    <profiles>

        <profile>

            <!-- 该配置的唯一标识符 -->
            <id>profile_id</id>

            <!--
             | profile 的激活条件配置;
             | 其他激活方式: 
             | 1. 通过 settings.xml 文件中的 activeProfile 元素进行指定激活。
             | 2. 在命令行, 使用-P标记和逗号分隔的列表来显式的激活, 如: mvn clean package -P myProfile)。 
             |-->
            <activation>

                <!-- 是否默认激活 -->
                <activeByDefault>false</activeByDefault>

                <!--  内建的 java 版本检测, 匹配规则: https://maven.apache.org/enforcer/enforcer-rules/versionRanges.html -->
                <jdk>9.9</jdk>

                <!-- 内建操作系统属性检测, 配置规则: https://maven.apache.org/enforcer/enforcer-rules/requireOS.html -->
                <os>

                    <!-- 操作系统 -->
                    <name>Windows XP</name>

                    <!-- 操作系统家族 -->
                    <family>Windows</family>

                    <!-- 操作系统 -->
                    <arch>x86</arch>

                    <!-- 操作系统版本 -->
                    <version>5.1.2600</version>

                </os>

                <!--
                 | 如果Maven检测到某一个属性(其值可以在POM中通过${名称}引用), 并且其拥有对应的名称和值, Profile就会被激活。
                 | 如果值字段是空的, 那么存在属性名称字段就会激活profile, 否则按区分大小写方式匹配属性值字段
                 |-->
                <property>

                    <!-- 属性名 -->
                    <name>mavenVersion</name>

                    <!-- 属性值 -->
                    <value>2.0.3</value>

                </property>
                
                <!-- 根据文件存在/不存在激活profile -->
                <file>

                    <!-- 如果指定的文件存在, 则激活profile -->
                    <exists>/path/to/active_on_exists</exists>

                    <!-- 如果指定的文件不存在, 则激活profile -->
                    <missing>/path/to/active_on_missing</missing>

                </file>

            </activation>
            <!-- 扩展属性设置。扩展属性可以在 POM 中的任何地方通过 ${扩展属性名} 进行引用
             |
             | 属性引用方式(包括扩展属性, 共 5 种属性可以引用): 
             |
             | env.x                  : 引用 shell 环境变量, 例如, "env.PATH"指代了 $path 环境变量(在 Linux / Windows 上是 %PATH% ).
             | project.x              : 引用 pom.xml(根元素就是 project) 中 xml 元素内容.例如 ${project.artifactId} 可以获取 pom.xml 中设置的 <artifactId /> 元素的内容
             | settings.x             : 引用 setting.xml(根元素就是 setting) 中 xml 元素内容, 例如 ${settings.offline}
             | Java System Properties : 所有可通过 java.lang.System.getProperties() 访问的属性都能在通过 ${property_name} 访问, 例如 ${java.home}
             | x                      : 在 <properties/> 或者 外部文件 中设置的属性, 都可以 ${someVar} 的形式使用
             | 
             |-->
            <properties>

                <!-- 在当前 profile 被激活时,  ${profile.property} 就可以被访问到了 -->
                <profile.property>this.property.is.accessible.when.current.profile.actived</profile.property>

            </properties>

            <!-- 远程仓库列表 -->
            <repositories>
                <!-- 
                 | releases vs snapshots
                 | maven 针对 releases、snapshots 有不同的处理策略, POM 就可以在每个单独的仓库中, 为每种类型的 artifact 采取不同的策略
                 | 例如: 
                 |     开发环境 使用 snapshots 模式实时获取最新的快照版本进行构建
                 |     生成环境 使用 releases 模式获取稳定版本进行构建
                 | 参见repositories/repository/releases元素 
                 |-->

                <!--
                 | 依赖包不更新问题:                
                 | 1. Maven 在下载依赖失败后会生成一个.lastUpdated 为后缀的文件。如果这个文件存在, 那么即使换一个有资源的仓库后, Maven依然不会去下载新资源。
                 |    可以通过 -U 参数进行强制更新、手动删除 .lastUpdated 文件:
                 |      find . -type f -name "*.lastUpdated" -exec echo {}" found and deleted" \; -exec rm -f {} \;
                 |
                 | 2. updatePolicy 设置更新频率不对, 导致没有触发 maven 检查本地 artifact 与远程 artifact 是否一致
                 |-->
                <repository>

                    <!-- 远程仓库唯一标识 -->
                    <id>maven_repository_id</id>

                    <!-- 远程仓库名称 -->
                    <name>maven_repository_name</name>

                    <!-- 远程仓库URL, 按protocol://hostname/path形式 -->
                    <url>http://host/maven</url>

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

                    <!-- 如何处理远程仓库里发布版本的下载 -->
                    <releases>

                        <!-- 是否允许该仓库为 artifact 提供 发布版 / 快照版 下载功能 -->
                        <enabled>false</enabled>

                        <!-- 
                         | 每次执行构建命令时, Maven 会比较本地 POM 和远程 POM 的时间戳, 该元素指定比较的频率。
                         | 有效选项是: 
                         |     always(每次构建都检查), daily(默认, 距上次构建检查时间超过一天), interval: x(距上次构建检查超过 x 分钟)、 never(从不)
                         |
                         | 重要: 
                         |     设置为 daily, 如果 artifact 一天更新了几次, 在一天之内进行构建, 也不会从仓库中重新获取最新版本
                         |-->
                        <updatePolicy>always</updatePolicy>

                        <!-- 当 Maven 验证 artifact 校验文件失败时该怎么做: ignore(忽略), fail(失败), 或者warn(警告) -->
                        <checksumPolicy>warn</checksumPolicy>

                    </releases>

                    <!-- 如何处理远程仓库里快照版本的下载 -->
                    <snapshots>
                        <enabled />
                        <updatePolicy />
                        <checksumPolicy />
                    </snapshots>

                </repository>

                <!-- 
                    国内可用的 maven 仓库地址(updated @ 2019-02-08):

                    http://maven.aliyun.com/nexus/content/groups/public
                    http://maven.wso2.org/nexus/content/groups/public/
                    http://jcenter.bintray.com/
                    http://maven.springframework.org/release/
                    http://repository.jboss.com/maven2/
                    http://uk.maven.org/maven2/
                    http://repo1.maven.org/maven2/
                    http://maven.springframework.org/milestone
                    http://maven.jeecg.org/nexus/content/repositories/
                    http://repo.maven.apache.org/maven2
                    http://repo.spring.io/release/
                    http://repo.spring.io/snapshot/
                    http://mavensync.zkoss.org/maven2/
                    https://repository.apache.org/content/groups/public/
                    https://repository.jboss.org/nexus/content/repositories/releases/   
                -->

            </repositories>

            <!-- 
             | maven 插件的远程仓库配置。maven 插件实际上是一种特殊类型的 artifact。
             | 插件仓库独立于 artifact 仓库。pluginRepositories 元素的结构和 repositories 元素的结构类似。
             |-->
            <!--
            <pluginRepositories>
                <pluginRepository>
                    <releases>
                        <enabled />
                        <updatePolicy />
                        <checksumPolicy />
                    </releases>
                    <snapshots>
                        <enabled />
                        <updatePolicy />
                        <checksumPolicy />
                    </snapshots>
                    <id />
                    <name />
                    <url />
                    <layout />
                </pluginRepository>
            </pluginRepositories>
            -->

        </profile>

    </profiles>
  ...
</settings>

激活发生在所有指定的条件都满足时,尽管不是一次需要所有条件。

Active Profiles(激活配置文件Profiles的Profile)

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

<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">
  ...
  <activeProfiles>
    <activeProfile>profile_id</activeProfile>
  </activeProfiles>
</settings>

参考文档

【1】maven笔记(4)settings.xml详解

【2】Maven中setting配置文件解析

【3】Maven的标准settings.xml文件

到此这篇关于Maven配置文件settings.xml的实现的文章就介绍到这了,更多相关Maven settings.xml内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

您可能感兴趣的文章:
阅读全文