web.xml中Maven占位符不生效问题记录分析

问题背景

开发反馈,一个spring mvc的web项目,在web.xml配置的占位符不生效,编译后还是没有替换成配置的属性,如下:

<context-param>
 <param-name>logbackConfigLocation</param-name>
 <param-value>classpath:${loagback.xml.path:logback.xml}</param-value>
</context-param>

问题分析

先了解下,为什么在Maven中可以通过${xx}这种占位符的方式在编译期可以获取到Maven中的Properties属性信息呢?因为Maven提供了一个插件在起作用

maven-resources-plugin:http://maven.apache.org/plugins/maven-resources-plugin/

Resources Plugin将Resource元素指定的文件复制到输出目录。以下三个变体仅在指定或默认资源和输出目录元素的方式上有所不同。

Resources插件有三个目标:

resources:resources将主源代码的资源复制到主输出目录。

此目标通常自动执行,因为它默认绑定到流程资源生命周期阶段。它始终使用project.build.resources元素指定资源,默认情况下使用project.build.outputDirectory指定复制目标。

resources:testResources将测试源代码的资源复制到测试输出目录。

此目标通常自动执行,因为它默认绑定到process-test-resources生命周期阶段。它始终使用project.build.testResources元素指定资源,默认情况下使用project.build.testOutputDirectory指定复制目标。

resources:copy-resources将资源复制到输出目录。

此目标要求您配置要复制的资源,并指定outputDirectory。

以上来自官方的释义。其实就我们使用来说,这个插件有两个作用,如下:

  • 复制或排除文件:指定源资源目录下的文件哪些需要编译到目标目录
  • 过滤$占位符:从Maven Properties中找到占位符中的变量,并替换为Properties中的值

Maven的理念是约定大于配置,所以默认情况下,Maven约定资源目录是src/main/resources。也就是说即使不在pom.xml加任何Resources配置,只要我们的资源文件放在了 

src/main/resources目录下,就能被maven-resources-plugin管理到,就能替换掉文件中的占位符。

问题定位

如上,我们的web.xml所在目录为src/main/webapp/WEB-INF下,并不在src/main/resources下,所以不起作用。

还有一个问题是${loagback.xml.path:logback.xml}占位符。Maven对占位符的解析没有Spring那么智能,不支持占位符中带条件逻辑的。

问题解决

 1、修改占位符为:${loagback.xml.path},调整好每个profile中properties的配置

 2、因为web.xml是webapp目录下的资源,而项目中使用了maven-war-plugin插件来打war包,maven-war-plugin自带了对webapp下资源的处理。做如下配置即可:

     在configuration节点中添加webResources,如:

或者,简单点配置filteringDeploymentDescriptors为true即可,如:

maven-war-plugin具体用法请参考官方文档:http://maven.apache.org/plugins/maven-war-plugin

作者:kl原文地址:http://www.kailing.pub/article/index/arcid/246.html

%s 个评论

要回复文章请先登录注册