构建与依赖 / 系统课时
资源过滤与变量替换
资源过滤与变量替换
资源过滤让 Maven 在复制文本资源时,把 ${...} 占位符替换成 Maven 属性。它适合生成带环境名、服务地址或构建参数的配置文件;关键是只对需要替换的文本开启 filtering,并检查最终进入 target/classes 的内容,而不是只看源文件。
学习目标
- 在
pom.xml中为主资源开启filtering,并使用 Maven 属性提供变量值。 - 用
-D命令行属性覆盖默认值,验证不同构建参数产生的资源结果。 - 限制资源过滤范围,并能定位占位符没有被替换的问题。
开启 filtering 并定义属性
最直接的做法是在 <properties> 中声明默认值,再把 src/main/resources 配置为可过滤资源。以下是片段示例,放入现有项目的 <project> 节点中;如果 <build> 或 <properties> 已存在,应合并内容而不是重复创建同名节点。
<properties>
<app.env>dev</app.env>
<api.baseUrl>http://localhost:8080</api.baseUrl>
</properties>
<build>
<resources>
<resource>
<directory>src/main/resources</directory>
<filtering>true</filtering>
</resource>
</resources>
</build>在 src/main/resources/application.properties 中写入要替换的 Maven 属性:
app.env=${app.env}
api.base-url=${api.baseUrl}filtering 发生在资源复制阶段,源文件本身不会被改写;程序真正读取的是构建后位于 target/classes/application.properties 的资源,因此验证过滤结果也应检查这个文件。
运行构建并检查替换结果
先使用 POM 中的默认属性执行资源处理,再读取生成文件。下面的命令应在已经完成上述配置并创建 application.properties 的项目根目录运行。
mvn -q process-resources
cat target/classes/application.properties预期输出:
app.env=dev
api.base-url=http://localhost:8080如果输出中仍保留 ${app.env},优先检查三处:资源项是否真的设置了 <filtering>true</filtering>、属性名大小写是否完全一致、文件是否位于当前 <directory> 指向的目录中。只定义 <properties> 而没有开启过滤,不会完成资源中的变量替换。
用命令行属性切换构建值
Maven 用户属性可以通过 -D名称=值 在命令行传入,适合 CI 或本地临时构建。下面把环境名和 API 地址改为 staging,不需要编辑源配置文件,也不需要改动 POM 中保存的默认值。
mvn -q -Dapp.env=staging -Dapi.baseUrl=https://staging.example.test process-resources
cat target/classes/application.properties预期输出:
app.env=staging
api.base-url=https://staging.example.test这种方式的验收标准很明确:每次构建后都检查 target/classes 中生成的最终资源,而不是根据命令参数猜测结果。CI 中还可以在打包前检查关键配置值,让错误环境参数尽早暴露。
把过滤范围限制在文本配置
项目中通常还有图片、证书或其他不需要变量替换的资源,因此不应让所有文件都经过过滤。下面把 .properties 文件交给过滤资源项处理,其余资源由另一项原样复制;两条规则通过 includes 和 excludes 保持互斥。
<build>
<resources>
<resource>
<directory>src/main/resources</directory>
<filtering>true</filtering>
<includes>
<include>**/*.properties</include>
</includes>
</resource>
<resource>
<directory>src/main/resources</directory>
<filtering>false</filtering>
<excludes>
<exclude>**/*.properties</exclude>
</excludes>
</resource>
</resources>
</build>使用前面的 application.properties 即可验证这组规则:
mvn -q clean process-resources
cat target/classes/application.properties预期输出:
app.env=dev
api.base-url=http://localhost:8080实际项目中应让过滤与非过滤规则尽量互斥,避免同一文件由多个资源项重复处理。每次修改 <resources>、includes 或 excludes 后,都用 clean process-resources 清除旧输出,再检查目标文件的实际内容。