构建与依赖 / 系统课时

Profile 的定义与作用

Profile 的定义与作用

Profile 用来在同一个 Maven 项目里按环境切换一部分构建模型,例如属性、依赖、插件和仓库,而不是维护多份 POM。学完后你能写出 dev、prod 这类 Profile,并用 Maven 命令确认最终生效的配置。

学习目标

  • 知道 Profile 可以放在 pom.xml、用户级和全局 settings.xml 的哪些位置。
  • 会在 Profile 中定义属性、依赖、插件和仓库,并理解激活后如何合并进项目模型。
  • 会用 help:evaluate 验证指定 Profile 是否真的改变了构建结果。

Profile 放在哪里

项目自己的环境差异优先写在 pom.xml 的 <profiles> 中;用户级配置放在 ${user.home}/.m2/settings.xml,全局配置放在 Maven 安装目录的 conf/settings.xml。settings.xml 中的 Profile 适合放属性、普通仓库和插件仓库,不适合承载项目依赖或项目插件。

位置 适合内容 团队可复现性
pom.xml 属性、依赖、插件、仓库、模块等项目构建差异 高,随源码提交
用户 settings.xml 私有仓库地址、用户属性、仓库选择 低,需每个开发者配置
全局 settings.xml 机器或组织级 Maven 行为 低,依赖安装环境

如果一项配置会直接改变项目产物,例如新增依赖或修改打包插件,应优先放进项目 POM;认证密码则应留在 settings.xml 的 <servers> 中,不要写进 Profile 或提交到版本库。

用一个 POM 定义开发与发布差异

下面是可直接保存为 pom.xml 的完整示例。dev 使用 H2 运行时依赖并开放 Apache Snapshot 仓库;prod 使用 PostgreSQL 驱动,并在 validate 阶段通过 Enforcer 要求运行 Maven 的 Java 版本不低于 17。

xml
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.example</groupId>
  <artifactId>profile-demo</artifactId>
  <version>1.0.0</version>

  <properties>
    <maven.compiler.release>17</maven.compiler.release>
  </properties>

  <profiles>
    <profile>
      <id>dev</id>
      <properties>
        <app.env>dev</app.env>
        <db.kind>h2</db.kind>
      </properties>
      <dependencies>
        <dependency>
          <groupId>com.h2database</groupId>
          <artifactId>h2</artifactId>
          <version>2.2.224</version>
          <scope>runtime</scope>
        </dependency>
      </dependencies>
      <repositories>
        <repository>
          <id>apache-snapshots</id>
          <url>https://repository.apache.org/snapshots</url>
          <releases>
            <enabled>false</enabled>
          </releases>
          <snapshots>
            <enabled>true</enabled>
          </snapshots>
        </repository>
      </repositories>
    </profile>

    <profile>
      <id>prod</id>
      <properties>
        <app.env>prod</app.env>
        <db.kind>postgresql</db.kind>
      </properties>
      <dependencies>
        <dependency>
          <groupId>org.postgresql</groupId>
          <artifactId>postgresql</artifactId>
          <version>42.7.4</version>
          <scope>runtime</scope>
        </dependency>
      </dependencies>
      <build>
        <plugins>
          <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-enforcer-plugin</artifactId>
            <version>3.5.0</version>
            <executions>
              <execution>
                <id>require-java-17</id>
                <goals>
                  <goal>enforce</goal>
                </goals>
                <configuration>
                  <rules>
                    <requireJavaVersion>
                      <version>[17,)</version>
                    </requireJavaVersion>
                  </rules>
                </configuration>
              </execution>
            </executions>
          </plugin>
        </plugins>
      </build>
    </profile>
  </profiles>
</project>

配置生效后,基础 POM 不变,Maven 只把当前激活 Profile 中的模型片段合并进有效模型。真实项目里通常不会为了演示而额外添加 Snapshot 仓库;只有确实依赖快照构件时才保留这类仓库配置。

验证 Profile 是否真的生效

保存上面的 POM 后,在项目目录执行下面命令。help:evaluate 会读取激活后的有效模型,并打印 app.env 的最终值,因此比只看命令是否成功更能证明 Profile 已经参与构建。

bash
mvn -q help:evaluate -Pdev -Dexpression=app.env -DforceStdout

预期输出:

text
dev

把 -Pdev 改成 -Pprod 后,同一表达式应输出 prod。需要检查依赖、插件和仓库时,应查看有效 POM,并确认其中出现 org.postgresql:postgresql、maven-enforcer-plugin 或对应仓库 ID,而不是只根据 Profile 名称判断。

Profile 适合解决什么问题

Profile 最适合处理“构建模型确实不同”的场景,例如测试环境需要额外依赖、某个平台需要专用插件、某类构建需要额外仓库。若只是应用运行时的数据库地址、密钥或业务开关,更适合交给环境变量、配置中心或部署系统。

需求 是否适合 Profile 做法
开发环境加入 H2,生产加入 PostgreSQL 驱动 适合 在不同 Profile 的 <dependencies> 中定义
发布构建强制 Java 17 适合 在 prod Profile 中启用 Enforcer
私服用户名和密码 不适合放 POM Profile 放 settings.xml 的 <servers>
每次部署变化的数据库密码 不适合 交给环境变量或密钥管理系统

一套可维护的做法是让 Profile 只控制构建阶段的差异,并让 Profile 名称表达用途,例如 dev、integration-test、release。这样切换环境时只改变激活条件,不需要复制整份 POM。

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

目录与阅读设置

阅读设置

17

记录一个想法

Profile 的定义与作用

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

登录哪都通