Maven如何优先读取环境变量覆盖settings.xml的私有仓库属性配置

前置说明 #

需使用Maven 3.5.0及以上版本，该版本开始支持${变量名:-默认值}的属性默认值语法，可直接实现「环境变量优先、settings配置兜底的需求，无需额外配置构建profile。

步骤1：在settings.xml中定义兜底配置 #

你可以在全局、用户级或项目级settings.xml中添加默认配置，示例如下：

<settings>
  <!-- profiles节点下添加默认配置profile -->
  <profiles>
    <profile>
      <id>default-private-repo</id>
      <activation>
        <activeByDefault>true</activeByDefault>
      </activation>
      <properties>
        <!-- settings侧定义的兜底配置，属性名避免和POM中最终使用的属性名区分，防止循环引用 -->
        <settings.private.repo.url>http://你的私有仓库默认地址</settings.private.repo.url>
        <settings.private.repo.username>默认用户名</settings.private.repo.username>
        <settings.private.repo.password>默认密码</settings.private.repo.password>
      </properties>
    </profile>
  </profiles>
  <!-- server节点配置，引用后续在POM中定义的属性 -->
  <servers>
    <server>
      <id>private-repo</id>
      <username>${private.repo.username}</username>
      <password>${private.repo.password}</password>
    </server>
  </servers>
</settings>

步骤2：在POM文件中定义优先级属性 #

在项目pom.xml的properties节点中添加如下配置，实现环境变量优先、settings配置兜底的逻辑：

<properties>
  <!-- 私有仓库配置：优先读取对应环境变量，无环境变量则取settings.xml中的兜底配置 -->
  <private.repo.url>${env.PRIVATE_REPO_URL:-${settings.private.repo.url}}</private.repo.url>
  <private.repo.username>${env.PRIVATE_REPO_USERNAME:-${settings.private.repo.username}}</private.repo.username>
  <private.repo.password>${env.PRIVATE_REPO_PASSWORD:-${settings.private.repo.password}}</private.repo.password>
</properties>

步骤3：在POM中引用私有仓库地址 #

在pom.xml的repositories或distributionManagement节点中引用上述定义的属性即可：

<repositories>
  <repository>
    <id>private-repo</id>
    <url>${private.repo.url}</url>
    <!-- 按需配置snapshots、releases等规则 -->
  </repository>
</repositories>

• 本地开发环境无需设置环境变量，会自动读取settings.xml中的配置，不会泄露敏感信息
• CI环境只需配置PRIVATE_REPO_URL、PRIVATE_REPO_USERNAME、PRIVATE_REPO_PASSWORD三个环境变量即可自动覆盖默认配置，无需调整现有流水线配置
• 如果使用低于3.5.0版本的Maven，不支持默认值语法，兼容方案可通过配置两个优先级不同的profile实现：一个默认激活读取settings配置，另一个在环境变量存在时激活读取环境变量。

内容的提问来源于stack exchange，提问作者StFS