构建与依赖 / 系统课时

项目版本与依赖版本属性化

项目版本与依赖版本属性化

当一个 POM 同时出现项目版本、测试框架版本和插件版本时,直接把数字散落在各处会让升级容易漏改。本课把项目版本集中到 Maven 支持的 revision 属性,把依赖和插件版本放进语义清晰的属性,并用命令验证最终解析结果。

学习目标

  • 使用 revision 管理项目自身版本,并理解它与普通自定义属性的区别。
  • 为依赖和插件设计稳定、可搜索的版本属性命名。
  • 通过 Maven 命令确认属性替换后的实际项目版本。

把项目版本集中到 revision

Maven 3.5.0-beta-1 起支持 CI Friendly Versions,项目 <version> 可以使用 ${revision}、${sha1} 和 ${changelist} 这三个特殊占位符。若只需要统一项目版本,使用 revision 最直接;不要把 <version> 写成 ${app.version},普通自定义属性不属于这组受支持的项目版本占位符。

下面是一个可直接使用的单模块 POM。项目版本、JUnit 版本和 Surefire 版本都只有一个修改入口。

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>version-demo</artifactId>
  <version>${revision}</version>

  <properties>
    <revision>1.4.0-SNAPSHOT</revision>
    <maven.compiler.release>17</maven.compiler.release>
    <junit.version>5.11.4</junit.version>
    <maven-surefire-plugin.version>3.5.2</maven-surefire-plugin.version>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.junit.jupiter</groupId>
      <artifactId>junit-jupiter</artifactId>
      <version>${junit.version}</version>
      <scope>test</scope>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
        <version>${maven-surefire-plugin.version}</version>
      </plugin>
    </plugins>
  </build>
</project>

这份配置适用于 Maven 3.5.0-beta-1 及以上;实际团队通常应使用更现代的 Maven 3.6.3+。如果是多模块工程,父 POM 可以定义 revision,模块之间引用同版本构件时通常使用 ${project.version},这样拿到的是 Maven 已解析后的项目版本。

依赖属性不要拆得过细

属性名最好按“构件或版本族 + .version”命名,例如 junit.version、jackson.version、maven-surefire-plugin.version。同一版本族共用一个属性才有价值;如果每个依赖都创建一个毫无复用关系的属性,POM 只是把数字从 <dependency> 搬到了 <properties>,维护成本并没有下降。

一个常用判断标准是:同一数字需要在两处以上复用,或团队明确希望从 <properties> 统一升级时再属性化。对于拥有官方 BOM 的依赖族,例如一组需要保持兼容版本的库,优先让 BOM 与 <dependencyManagement> 管理版本,而不是为每个成员创建独立属性。

验证 Maven 实际解析的版本

保存 POM 后,在项目根目录执行 Maven Help Plugin 的表达式求值。-DforceStdout 会把表达式结果直接输出,便于脚本和人工检查。

bash
mvn -q -DforceStdout help:evaluate -Dexpression=project.version

预期输出

text
1.4.0-SNAPSHOT

还可以临时覆盖 revision,验证 CI 是否能在不改 POM 的情况下指定构建版本。

bash
mvn -q -Drevision=2.0.0 -DforceStdout help:evaluate -Dexpression=project.version

预期输出

text
2.0.0

如果第一条命令仍输出 ${revision} 或直接报模型错误,先检查 Maven 版本,再检查属性名是否准确写成 revision。如果依赖版本没有按预期统一,则运行 mvn help:effective-pom 查看最终 POM,重点排查子模块是否又声明了具体 <version>。

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

目录与阅读设置

阅读设置

17

记录一个想法

项目版本与依赖版本属性化

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

登录哪都通