构建与依赖 / 系统课时

properties 属性与变量引用

properties 属性与变量引用

当同一个版本号、编码或编译参数在 POM 中出现多次时,直接复制会让升级变得容易漏改。<properties> 可以把这些值集中定义,再用 ${属性名} 引用。本课用一份完整 POM 演示版本与编译参数复用,并用命令读取实际解析值。

学习目标

  • 在 <properties> 中定义版本、编码和 Java 编译目标等项目属性。
  • 使用 ${...} 引用自定义属性以及 project.version 等 Maven 模型属性。
  • 通过 help:evaluate 检查表达式最终解析成什么值。

定义可复用的属性

下面示例把 Java 目标版本、源码编码和 JUnit 版本集中到 <properties>。java.release 是项目自定义属性;project.build.sourceEncoding 是 Maven 生态中常用的编码属性名;依赖版本通过 ${junit.version} 复用。

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>properties-demo</artifactId>
    <version>1.0.0-SNAPSHOT</version>

    <properties>
        <java.release>17</java.release>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <junit.version>5.11.4</junit.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-compiler-plugin</artifactId>
                <version>3.13.0</version>
                <configuration>
                    <release>${java.release}</release>
                    <encoding>${project.build.sourceEncoding}</encoding>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

示例将 maven-compiler-plugin 固定为 3.13.0,避免插件版本随环境变化。release 设为 17 时,实际运行 Maven 的 JDK 必须能够编译 Java 17 目标;团队构建机通常直接统一使用 JDK 17 或更高版本。

识别三类常见表达式

${...} 不只引用 <properties>。日常 POM 中最常见的是项目自定义属性、Maven 项目模型属性和环境变量。先明确值来自哪里,再决定是否应该集中到 <properties>。

表达式 示例解析值 适合用途
${junit.version} 5.11.4 复用自定义依赖版本
${java.release} 17 复用自定义编译参数
${project.version} 1.0.0-SNAPSHOT 引用当前项目版本
${project.groupId} com.example 引用当前项目 groupId
${env.JAVA_HOME} 取决于当前机器 读取环境变量,结果不应假定固定

环境变量会让同一 POM 在不同机器得到不同值,因此只适合确实依赖外部环境的配置。能写成项目固定属性的值,例如源码编码和依赖版本,优先留在 POM 中,构建更容易复现。

把容易一起修改的值集中管理

属性命名应表达用途,而不是只写 version1、version2。依赖版本可以采用 junit.version、jackson.version 这类名称;Java 编译目标可以使用 java.release。一次升级时只改属性定义,所有引用点会同时得到新值。

错误做法是把同一个依赖版本复制到多个 <dependency> 节点,升级时漏掉一个就可能出现类路径不一致。正确做法是让共享值只有一个定义位置,再让插件或依赖通过表达式引用。若多个模块共享同一组版本,后续还可以把这些属性提升到父 POM 中统一管理。

验证表达式实际解析值

保存上面的 POM 后,在项目根目录运行 help:evaluate。-Dexpression=junit.version 指定要读取的表达式,-q -DforceStdout 用于只输出求值结果,便于脚本检查。

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

预期输出如下。

text
5.11.4

如果输出仍是未解析表达式或命令报找不到属性,先检查属性名是否完全一致,再检查 <properties> 是否位于 <project> 内。对于 ${project.version} 这类模型属性,不需要在 <properties> 中重复定义;直接引用 Maven 已经读取到的项目值即可。

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

目录与阅读设置

阅读设置

17

记录一个想法

properties 属性与变量引用

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

登录哪都通