Maven怎么过滤XML资源文件中的变量

11次阅读

Resources插件默认不处理xml中的${…}变量,因其仅在显式启用Filtering且通过includes限定XML文件时才执行纯文本替换,不解析XML结构,未定义变量亦不报错。

Maven怎么过滤XML资源文件中的变量

为什么 resources 插件默认不处理 XML 中的 ${…} 变量

maven 的资源过滤(resource filtering)默认只对 src/main/resources 下的文件生效,但关键点在于:它**不会自动启用变量替换**,除非你显式开启 filtering,且该功能对 XML 文件本身没有特殊支持——它只是做字符串级别的文本替换。如果你的 application.xml 里写了 ${database.url},但没配对,Maven 就原样拷贝过去,不会报错,也不会替换。

  • 变量来源只能是 properties 文件(如 src/main/filters/dev.properties)、 块、或命令行 -D 参数
  • XML 文件本身不是 Maven 的“配置文件”,它不解析 XML 结构,只当纯文本处理
  • 如果变量未定义,Maven 默认保留原始占位符(如 ${missing.prop}),不会报错,容易漏检

如何在 pom.xml 中正确启用 XML 资源过滤

必须在 maven-resources-plugin 配置中显式设置 filtering = true,并限定作用范围。推荐写法如下:

               src/main/resources       true                **/*.xml         **/*.properties                               org.apache.maven.plugins       maven-resources-plugin       3.3.1                UTF-8                
  • 是必须的:否则 filtering=true 会作用于所有资源(包括二进制文件),导致损坏
  • 不要用 排除非 XML 文件——优先级低、易遗漏;用 更安全
  • 确保 maven-resources-plugin 版本 ≥ 3.2.0,旧版本对多层级路径(如 config/db/app.xml)可能过滤失败

怎么避免 XML 特殊字符和占位符冲突

XML 文件里既有 ${...} 占位符,又有 & 等实体,若变量值含这些字符,直接插入会导致 XML 格式错误。Maven 不做转义,需手动处理:

  • 变量值中含 &:必须在 .properties 文件里写成 zuojiankuohaophpcn&(即双重转义)
  • 想让某个 ${...} 不被替换(比如 mybatis${param} 动态 sql):写成 $${param} —— Maven 会把两个 $ 解析为一个,保留原始 ${param}
  • 使用 mvn resources:resources -X 查看调试日志,确认哪些文件被过滤、哪些变量被解析、哪些未定义

Profile 激活时变量没生效?检查 filter 文件路径和激活逻辑

常见现象:mvn clean package -Pdev 后 XML 里还是 ${db.host},没变成 localhost。问题往往出在 filter 文件未加载或 profile 未真正激活:

  • filter 文件路径必须匹配 配置,例如:
       src/main/filters/${env}.properties 

    此时必须通过 -Denv=dev 或 profile 的 dev 传入 env

  • profile 的 dev 必须与 -Pdev 完全一致,大小写敏感
  • filter 文件里的 key 必须是纯 ASCII,不能含空格或点号(如 db.url 可以,db.url.v2 在某些插件版本中会被截断)

Maven 对 XML 的变量过滤本质是「带条件的文本替换」,它不理解 XML 语义,也不校验格式是否合法。最容易被忽略的是:没加 导致二进制资源损坏,以及变量值含未转义的 XML 特殊字符引发解析失败。上线前务必用 target/classes/ 下的实际输出文件验证替换结果。

text=ZqhQzanResources