快速学习 Maven 配置文件 settings.xml 各元素

Maven 的 settings.xml 文件是用于定义 Maven 的全局设置、仓库、代理、插件、配置和个人用户信息等的重要配置文件。settings.xml 文件通常存储在 Maven 安装目录的 conf 文件夹下,这为全局配置。如果用户有特殊配置,可以在用户主目录的 .m2 目录下面创建 settings.xml 配置文件,进行特殊配置。

Maven 的 settings.xml 文件是用于定义 Maven 的全局设置、仓库、代理、插件、配置和个人用户信息等的重要配置文件。

settings.xml 文件通常存储在 Maven 安装目录的 conf 文件夹下,这为全局配置。如果用户有特殊配置,可以在用户主目录的 .m2 目录下面创建 settings.xml 配置文件,进行特殊配置。

注意:在 Windows 系统中的默认位置是 %user_home%.m2\settings.xml,在 Linux 或 macOS 中默认位置是 ~/.m2/settings.xml。

此外,settings.xml 文件使用 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 http://maven.apache.org/xsd/settings-1.0.0.xsd">
   <!-- 各个子元素的配置 -->
</settings>

以下是 settings.xml 中一些常见元素的详细说明:

<localRepository>

用来指定了 Maven 本地仓库的位置。本地仓库是 Maven 在本地存储下载的依赖项(如各种库和插件)的地方。通过设置 <localRepository>,可以自定义 Maven 本地仓库的路径,以便更好地管理和组织依赖项。

元素默认值为 ${user.home}/.m2/repository,即用户主目录下的 .m2/repository 文件夹。例如:

<localRepository>D:\\repository</localRepository>

<interactiveMode>

标签的主要作用是决定 Maven 在构建过程中遇到需要用户输入信息的情况时,是否暂停并等待用户交互。当该标签的值设置为 true 时,Maven 会以交互模式运行,在遇到需要用户输入的情况(如输入密码、选择配置项等)时,会暂停并提示用户输入相关信息;当设置为 false 时,Maven 会以非交互模式运行,不会等待用户输入,而是尝试使用默认值或者根据配置进行处理。

默认为 true。例如:

<interactiveMode>true</interactiveMode>

<usePluginRegistry>

该标签用于控制是否启用插件注册表。

Maven 插件注册表是一种机制,它可以记录和管理可用的插件信息。<usePluginRegistry> 标签的作用就是决定 Maven 在运行过程中是否使用这个插件注册表来查找和解析插件。

当 <usePluginRegistry> 设置为 true 时,Maven 会使用插件注册表。这意味着 Maven 在查找插件时,会先参考注册表中的信息,根据注册表中记录的插件版本、坐标等内容来定位和使用插件。这样做有助于确保在不同的构建环境中使用一致的插件版本,提高构建的可重复性和稳定性。

当 <usePluginRegistry> 设置为 false 时,Maven 不会使用插件注册表,而是按照常规的方式去查找和解析插件,即根据 pom.xml 文件中指定的插件坐标,从本地仓库或远程仓库去获取插件。

默认为 false。例如:

<usePluginRegistry>false</usePluginRegistry>

<offline>

该标签用于指定 Maven 是否以离线模式运行。当 <offline> 标签的值设置为 true 时,Maven 会进入离线模式。在离线模式下,Maven 不会尝试从远程仓库下载任何依赖项(如 JAR 文件、插件等),而是仅使用本地仓库中已有的资源来完成项目的构建。当设置为 false 时,Maven 以在线模式运行,会根据需要从远程仓库下载缺失的依赖和插件。

默认为 false。当由于网络设置原因或安全因素,构建服务器不能连接远程仓库时,此配置很有用。例如:

<offline>false</offline>

<pluginGroups>

该标签主要用于简化我们在使用 Maven 插件时的配置过程。

Maven 插件通常由 groupId(组织标识)、artifactId(项目标识)和 version(版本号)来唯一标识。在 pom.xml 文件里使用插件时,我们理论上需要完整指定这三个部分。不过,当 groupId 属于 <pluginGroups> 标签所定义的组时,我们就可以只写 artifactId 和 version,从而简化配置。

Maven 在查找插件时,若未指定 groupId,就会按照 <pluginGroups> 中定义的顺序依次查找对应的插件组,直到找到匹配的插件。

默认情况下包含 org.apache.maven.plugins 和 org.codehaus.mojo。例如:

<pluginGroups>
       <pluginGroup>org.codehaus.mojo</pluginGroup>
</pluginGroups>

<servers>

该标签主要用于存储与远程服务器进行交互时所需的认证信息(如用户名、密码等)。这些远程服务器可以是私有 Maven 仓库、部署目标服务器等。

当 Maven 需要与受保护的远程服务器进行通信,比如向私有仓库部署构件或者从需要认证的仓库下载依赖时,就需要提供相应的认证信息。<servers> 标签就是用来配置这些认证信息的,确保 Maven 有足够的权限访问这些服务器。

<servers> 标签包含一个或多个 <server> 子标签,每个 <server> 标签对应一个远程服务器的配置,其主要子标签及含义如下:

  • <id>:服务器的唯一标识符,该 ID 要与 pom.xml 中 <distributionManagement> 或 <repositories> 里指定的仓库 ID 一致,这样 Maven 才能正确关联认证信息。

  • <username>:访问服务器所需的用户名。

  • <password>:对应的密码。

  • <privateKey>:(可选)用于 SSH 认证的私钥文件路径。

  • <passphrase>:(可选)私钥的密码。

  • <filePermissions>:(可选)部署文件时设置的文件权限。

  • <directoryPermissions>:(可选)部署文件时设置的目录权限。

  • <configuration>:(可选)其他特定于服务器的配置。

例如:

<settings>
   <!-- 其他配置 -->
   <servers>
       <server>
           <id>my-private-repo</id>
           <username>deployUser</username>
           <password>deployPassword</password>
       </server>
       <server>
           <id>another-repo</id>
           <username>anotherUser</username>
           <password>anotherPassword</password>
           <privateKey>/path/to/private/key</privateKey>
           <passphrase>keyPassphrase</passphrase>
       </server>
   </servers>
   <!-- 其他配置 -->
</settings>

注意,在 pom.xml 文件中,<distributionManagement> 和 <repositories> 标签用于指定项目的仓库信息。例如:

<project>
   <!-- 其他配置 -->
   <distributionManagement>
       <repository>
           <id>my-private-repo</id>
           <url>https://example.com/maven-repo</url>
       </repository>
   </distributionManagement>
   <repositories>
       <repository>
           <id>another-repo</id>
           <url>https://another.example.com/maven-repo</url>
       </repository>
   </repositories>
   <!-- 其他配置 -->
</project>

这里的 <id> 要与 settings.xml 中 <server> 标签的 <id> 相匹配。当 Maven 需要与这些仓库进行交互时,就会使用对应的认证信息。

<mirrors>

Maven 默认从中央仓库(Maven Central Repository)下载项目所需的依赖和插件,但由于网络、地理位置等因素,直接访问中央仓库可能速度较慢,甚至会遇到访问限制。<mirrors> 标签的作用就是配置镜像仓库,这些镜像仓库是中央仓库或其他远程仓库的副本,Maven 可以从镜像仓库下载资源,从而提高下载速度,解决网络访问问题。

<mirrors> 标签包含一个或多个 <mirror> 子标签,每个 <mirror> 标签代表一个镜像仓库的配置。其主要子标签及含义如下:

  • <id>:镜像仓库的唯一标识符,用于区分不同的镜像。

  • <mirrorOf>:指定该镜像仓库所代理的目标仓库。可以是具体的仓库 ID,也可以使用通配符(如 * 表示代理所有仓库,*,!repoId 表示代理除 repoId 之外的所有仓库)。

  • <name>:镜像仓库的名称,用于描述该镜像,方便用户识别。

  • <url>:镜像仓库的 URL 地址,Maven 会从这个地址下载资源。

以下是一个 <mirrors> 标签的配置示例:

<settings>
   <!-- 其他配置 -->
   <mirrors>
       <mirror>
           <id>aliyunmaven</id>
           <mirrorOf>*</mirrorOf>
           <name>阿里云公共仓库</name>
           <url>https://maven.aliyun.com/repository/public</url>
       </mirror>
       <mirror>
           <id>jboss-public-repository-group</id>
           <mirrorOf>repository.jboss.org</mirrorOf>
           <name>JBoss Public Repository Group Mirror</name>
           <url>https://repository.jboss.org/nexus/content/groups/public</url>
       </mirror>
   </mirrors>
   <!-- 其他配置 -->
</settings>

在上述示例中,第一个 <mirror> 配置表示阿里云公共仓库代理所有的 Maven 仓库,Maven 在下载任何资源时都会优先从该镜像仓库获取;第二个 <mirror> 配置表示 JBoss 公共仓库镜像只代理 repository.jboss.org 这个特定的仓库。

注意:当配置了多个镜像仓库时,Maven 会按照 <mirrors> 标签中 <mirror> 元素的顺序依次检查,根据 <mirrorOf> 的规则来确定使用哪个镜像仓库。如果某个镜像仓库不可用,Maven 可能会出现下载失败的情况,此时可以考虑调整镜像的顺序或者更换可用的镜像。

<proxies>

该标签用于配置代理服务器信息。当你的网络环境需要通过代理服务器才能访问外部资源(如 Maven 中央仓库)时,就需要使用该标签来进行相应配置,这样 Maven 在下载依赖和插件时,就会通过指定的代理服务器进行请求。

<proxies> 标签可以包含一个或多个 <proxy> 子标签,每个 <proxy> 子标签代表一个代理服务器的配置,其主要子元素及含义如下:

  • <id>:代理服务器的唯一标识符,用于区分不同的代理配置。

  • <active>:一个布尔值,true 表示启用该代理,false 表示禁用。默认为 true。

  • <protocol>:代理使用的协议,常见的有 http 和 https,需根据实际代理服务器支持的协议进行设置。

  • <host>:代理服务器的主机名或 IP 地址。

  • <port>:代理服务器监听的端口号。

  • <username>(可选):如果代理服务器需要认证,填写访问代理服务器的用户名。

  • <password>(可选):对应上述用户名的密码。

  • <nonProxyHosts>(可选):指定不需要通过代理访问的主机列表,多个主机名或 IP 地址之间用竖线 | 分隔,也可以使用通配符(如 *.example.com)。

以下是一个 <proxies> 标签的配置示例:

<settings>
   <!-- 其他配置 -->
   <proxies>
       <proxy>
           <id>myProxy</id>
           <active>true</active>
           <protocol>http</protocol>
           <host>proxy.example.com</host>
           <port>8080</port>
           <username>proxyUser</username>
           <password>proxyPass</password>
           <nonProxyHosts>localhost|127.0.0.1|*.local</nonProxyHosts>
       </proxy>
   </proxies>
   <!-- 其他配置 -->
</settings>

<profiles>

该标签是 settings.xml 或 pom.xml 文件里极为重要的配置元素,它能让开发者依据不同的环境、需求灵活调整项目构建过程。

<profiles> 标签用于定义一组配置文件(<profile>),每个 <profile> 代表一种特定的构建场景,例如不同的开发环境(开发、测试、生产)、不同的操作系统或者不同的硬件配置等。通过激活特定的 <profile>,Maven 可以动态地改变项目的构建行为,如使用不同的依赖、插件配置、资源文件等。

<profiles> 标签包含一个或多个 <profile> 子标签,每个 <profile> 标签有以下重要的子元素:

  • <id>:为 <profile> 提供唯一标识符,用于在激活 <profile> 时进行引用。

  • <activation>:指定 <profile> 自动激活的条件,有以下几种常见的激活方式:

    • <activeByDefault>:布尔值,若设为 true,则该 <profile> 在没有其他 <profile> 被激活时默认激活。

    • <os>:根据操作系统的属性(如名称、架构、版本)来激活 <profile>。

    • <property>:根据系统属性或用户自定义属性的值来激活 <profile>。

    • <file>:根据文件是否存在或不存在来激活 <profile>。

  • <repositories>:定义该 <profile> 下使用的远程仓库,Maven 会从这些仓库下载项目依赖。

  • <pluginRepositories>:指定该 <profile> 下使用的插件仓库,Maven 会从这些仓库下载所需的插件。

  • <dependencies>:列出该 <profile> 下项目所需的依赖项,可以覆盖或补充 pom.xml 中默认的依赖配置。

  • <build>:包含该 <profile> 下的构建相关配置,如插件配置、资源目录等。

示例:

<settings>
   <profiles>
       <profile>
           <id>dev</id>
           <activation>
<!-- 默认激活 -->
               <activeByDefault>true</activeByDefault>
           </activation>
           <repositories>
               <repository>
                   <id>dev-repo</id>
                   <url>http://dev.example.com/maven-repo</url>
               </repository>
           </repositories>
           <pluginRepositories>
               <pluginRepository>
                   <id>dev-plugin-repo</id>
                   <url>http://dev.example.com/maven-plugin-repo</url>
               </pluginRepository>
           </pluginRepositories>
       </profile>
       <profile>
           <id>prod</id>
           <activation>
               <property>
                   <name>env</name>
                   <value>prod</value>
               </property>
           </activation>
           <repositories>
               <repository>
                   <id>prod-repo</id>
                   <url>http://prod.example.com/maven-repo</url>
               </repository>
           </repositories>
           <pluginRepositories>
               <pluginRepository>
                   <id>prod-plugin-repo</id>
                   <url>http://prod.example.com/maven-plugin-repo</url>
               </pluginRepository>
           </pluginRepositories>
       </profile>
   </profiles>
</settings>

在上述示例中,定义了两个 <profile>:

  • dev:默认激活,使用开发环境的仓库。

  • prod:当系统属性 env 的值为 prod 时激活,使用生产环境的仓库。

<activeProfiles>

该标签用于显式指定在构建过程中默认激活的配置文件(<profile>)。

Maven 的 <profiles> 标签允许定义多个不同的构建配置,每个配置代表一种特定的构建场景。然而,这些配置文件默认是不激活的,需要通过一定的方式来激活它们。<activeProfiles> 标签提供了一种在全局层面预先指定哪些配置文件应该被激活的方法,使得在每次 Maven 构建时,这些指定的配置文件会自动生效,无需在命令行中每次都手动指定激活的配置文件。

<activeProfiles> 标签包含一个或多个 <activeProfile> 子标签,每个 <activeProfile> 子标签的值是一个 <profile> 的 id。以下是一个配置示例:

示例:

<settings>
   <!-- 其他配置 -->
   <activeProfiles>
       <activeProfile>dev</activeProfile>
       <activeProfile>test</activeProfile>
   </activeProfiles>
   <profiles>
       <profile>
           <id>dev</id>
           <!-- 开发环境的配置 -->
           <repositories>
               <repository>
                   <id>dev-repo</id>
                   <url>http://dev.example.com/maven-repo</url>
               </repository>
           </repositories>
       </profile>
       <profile>
           <id>test</id>
           <!-- 测试环境的配置 -->
           <repositories>
               <repository>
                   <id>test-repo</id>
                   <url>http://test.example.com/maven-repo</url>
               </repository>
           </repositories>
       </profile>
       <profile>
           <id>prod</id>
           <!-- 生产环境的配置 -->
           <repositories>
               <repository>
                   <id>prod-repo</id>
                   <url>http://prod.example.com/maven-repo</url>
               </repository>
           </repositories>
       </profile>
   </profiles>
   <!-- 其他配置 -->
</settings>

在上述示例中,<activeProfiles> 标签指定了 dev 和 test 这两个配置文件会在 Maven 构建时自动激活。这样,在执行 Maven 命令(如 mvn clean install)时,Maven 会应用 dev 和 test 配置文件中的相关配置,例如使用相应的仓库来下载依赖。

人永远是要学习的。死的时候,才是毕业的时候。 —— 萧楚女
0 不喜欢
说说我的看法 -
全部评论(
没有评论
关于
本网站专注于 Java、数据库(MySQL、Oracle)、Linux、软件架构及大数据等多领域技术知识分享。涵盖丰富的原创与精选技术文章,助力技术传播与交流。无论是技术新手渴望入门,还是资深开发者寻求进阶,这里都能为您提供深度见解与实用经验,让复杂编码变得轻松易懂,携手共赴技术提升新高度。如有侵权,请来信告知:hxstrive@outlook.com
公众号