构建与依赖 / 系统课时

Profile 的激活方式

Profile 的激活方式

Profile 定义好以后,真正决定构建结果的是“什么时候激活”。Maven 支持命令行、默认激活、JDK、操作系统、属性和文件条件;掌握这些方式后,你可以让构建显式可控,也能让少量环境差异自动匹配。

学习目标

  • 会用 -P 显式激活 Profile,并理解 activeByDefault 的行为。
  • 会配置 JDK、操作系统、系统属性和文件存在条件。
  • 能用可重复的命令验证当前到底激活了哪些环境配置。

命令行与默认激活

命令行是最容易排查的方式:-Pprod 激活 ID 为 prod 的 Profile,多个 ID 可写成 -Pdev,debug。下面的片段同时展示显式 Profile 和默认 Profile;当同一 POM 中另一个 Profile 被显式或隐式激活时,activeByDefault Profile 会自动退出。

xml
<profiles>
  <profile>
    <id>local</id>
    <activation>
      <activeByDefault>true</activeByDefault>
    </activation>
    <properties>
      <env.name>local</env.name>
    </properties>
  </profile>

  <profile>
    <id>prod</id>
    <properties>
      <env.name>prod</env.name>
    </properties>
  </profile>
</profiles>

片段示例:把它放在 pom.xml 的 <project> 内。先不带 -P 查询属性应得到 local;显式激活 prod 后则得到 prod。

bash
mvn -q help:evaluate -Pprod -Dexpression=env.name -DforceStdout

预期输出:

text
prod

如果某个 Profile 必须对当前用户的所有构建持续生效,也可以在 ${user.home}/.m2/settings.xml 的 <activeProfiles> 中列出它;团队项目不要依赖这种隐藏配置,否则不同开发机很容易得到不同构建结果。

按 JDK 与操作系统激活

JDK 条件判断的是“运行 Maven 的 JDK”,不是 maven.compiler.release 指定的目标版本。[17,) 表示 17 及以上;操作系统可按 name、family、arch、version 匹配,实际项目里优先用较稳定的 family 或 arch,避免把补丁级系统版本写死。

xml
<profiles>
  <profile>
    <id>jdk17-plus</id>
    <activation>
      <jdk>[17,)</jdk>
    </activation>
    <properties>
      <toolchain.mode>modern</toolchain.mode>
    </properties>
  </profile>

  <profile>
    <id>windows</id>
    <activation>
      <os>
        <family>Windows</family>
      </os>
    </activation>
    <properties>
      <script.suffix>.cmd</script.suffix>
    </properties>
  </profile>
</profiles>

片段示例:在 Java 17、21 等版本上运行 Maven 时,jdk17-plus 会满足条件;在 Windows 上运行时,windows 会满足条件。两者条件彼此独立,因此一台 Windows + Java 21 的机器可以同时激活两个 Profile。

按属性激活

属性激活适合 CI、测试模式或临时开关,因为调用者可以显式传入 -Dname=value。下面只有在 environment=test 时激活 test-env,不会因为属性存在但值不同而误触发。

xml
<profile>
  <id>test-env</id>
  <activation>
    <property>
      <name>environment</name>
      <value>test</value>
    </property>
  </activation>
  <properties>
    <env.name>test</env.name>
  </properties>
</profile>

片段示例:把它放进 <profiles>。验证时执行下面命令,-Denvironment=test 同时是 Profile 的触发条件。

bash
mvn -q help:evaluate -Denvironment=test -Dexpression=env.name -DforceStdout

预期输出:

text
test

只写 <name>debug</name> 而不写 <value> 时,只要 debug 属性被设置就能触发。若需要团队构建可复现,建议给关键属性同时约定明确值,例如 -Denvironment=test,不要让“是否存在”承担太多语义。

按文件条件激活

文件激活常用于判断本机是否存在某个标记文件或生成结果。<exists> 表示文件存在时激活,<missing> 表示缺失时激活;相对路径以项目目录为基准,不能指望这里读取同一 POM <properties> 中刚定义的普通属性。

xml
<profile>
  <id>release-marker</id>
  <activation>
    <file>
      <exists>.release</exists>
    </file>
  </activation>
  <properties>
    <release.marker.present>true</release.marker.present>
  </properties>
</profile>

片段示例:在项目根目录创建空文件 .release 后再运行 Maven,该 Profile 会满足条件;删除文件后再次构建就不会激活。团队如果使用这种方式,应把“谁创建标记文件、何时删除”写进构建脚本,否则最容易出现本机有效、CI 无效。

组合条件时怎样避免误激活

同一个 Profile 可以组合不同类型的隐式条件,Maven 会在这些条件全部满足时才激活。例如同时要求 Java 17+、Windows 和 -Dci=true,只有三项都成立才生效;同一种条件类型不要在一个 <activation> 中重复堆叠。

xml
<profile>
  <id>windows-ci-jdk17</id>
  <activation>
    <jdk>[17,)</jdk>
    <os>
      <family>Windows</family>
    </os>
    <property>
      <name>ci</name>
      <value>true</value>
    </property>
  </activation>
  <properties>
    <build.lane>windows-ci</build.lane>
  </properties>
</profile>

片段示例:在 Windows、Java 17+ 环境执行带有 -Dci=true 的 Maven 构建才会激活。自动条件越多,排查成本越高;生产发布通常更适合显式 -Pprod,而 JDK、OS 或文件条件应只用于确实由环境决定的差异。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

Profile 的激活方式

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通