如何在 Spring 中以编程方式解析属性占位符

Question

我目前正在开发一个基于 Spring 3.1.0.M1、基于注释的 Web 应用程序，但在我的应用程序的一个特定位置解析属性占位符时遇到了问题。

这是故事。

1) 在我的 Web 应用程序上下文中（由 DispatcherServlet 加载），我有

mvc-config.xml：

<!-- Handles HTTP GET requests for /resources/version/**  -->
<resources mapping="/${app.resources.path}/**" location="/static/" cache-period="31556926"/> 

...

<!-- Web properties -->
<context:property-placeholder location="
    classpath:app.properties
    "/>

2) 在 app.properties 中，有 2 个属性，其中包括：

app.properties：

# Properties provided (filtered) by Maven itself
app.version: 0.1-SNAPSHOT
...

# Static resources mapping
app.resources.path: resources/${app.version}

3) 我的 JSP 2.1 模板中有一个 JSP 自定义标签。该标签负责根据环境设置、应用程序版本、spring 主题选择等来构建完整的资源路径。自定义标签类扩展了 spring:url 实现类，因此它可以被认为是一个普通的 url 标签，但对正确的路径有一些额外的了解。

我的问题是我无法在我的 JSP 自定义标记实现中正确解析 ${app.resources.path}。 JSP 自定义标签由 servlet 容器管理，而不是 Spring，因此不参与 DI。所以我不能只使用通常的 @Value("${app.resources.path}") 并让 Spring 自动解决它。

我所拥有的只是 Web 应用程序上下文实例，因此我必须以编程方式解析我的属性。

到目前为止我尝试过：

ResourceTag.java：

// returns null
PropertyResolver resolver = getRequestContext().getWebApplicationContext().getBean(PropertyResolver.class);
resolver.getProperty("app.resources.path");


// returns null, its the same web context instance (as expected)
PropertyResolver resolver2 = WebApplicationContextUtils.getRequiredWebApplicationContext(pageContext.getServletContext()).getBean(PropertyResolver.class);
resolver2.getProperty("app.resources.path");


// throws NPE, resolver3 is null as StringValueResolver is not bound
StringValueResolver resolver3 = getRequestContext().getWebApplicationContext().getBean(StringValueResolver.class);
resolver3.resolveStringValue("app.resources.path");


// null, since context: property-placeholder does not register itself as PropertySource
Environment env = getRequestContext().getWebApplicationContext().getEnvironment();
env.getProperty("app.resources.path");

所以现在我有点坚持。我知道解决占位符的能力是在上下文中的某个地方，我只是不知道正确的方法。
任何帮助或检查的想法都非常感谢。

Answer 1

自 Spring 3.0.3 以来，EmbeddedValueResolverAware 的工作方式与另一篇使用 appContext.getBeanFactory().resolveEmbeddedValue("${prop}") 调用的帖子中提到的相同。

解决问题：

1. 让您的类实现 EmbeddedValueResolverAware 接口，您将为您注入解析器

2. 然后您可以在哪里检索属性，如代码 sn-p 所示：

   String propertyValue = resolver.resolveStringValue("${your.property.name}");
   

那么你的 bean 就不需要依赖 ApplicationContext 来检索你需要的属性了。

Answer 2

从 3.0 版开始，Spring 在 beanFactory 中保留了一个字符串解析器列表。 你可以这样使用它：

String value = appContext.getBeanFactory().resolveEmbeddedValue("${prop}");

javadoc 声明此方法用于解析诸如注释属性之类的嵌入值，所以也许我们正在规避它的使用，但它确实有效。

Answer 3

我认为与其关注上下文占位符的内部工作，不如简单地定义一个新的 util:properties，如下所示：

<util:properties id="appProperties" location="classpath:app.properties" />

在你的代码中，像这样使用它：

Properties props = appContext.getBean("appProperties", Properties.class);

或者在任何你可以做 DI 的地方都像这样：

@Value("#{appProperties['app.resources.path']}")

Answer 4

一种选择是将PropertySource（此处MapPropertySource 以举例说明内存中的配置）添加到ConfigurableEnvironment 并要求它为您解析属性。

public class Foo {

    @Autowired
    private ConfigurableEnvironment env;

    @PostConstruct
    public void setup() {
        env.getPropertySources()
           .addFirst(new MapPropertySource("my-propertysource", 
               ImmutableMap.<String, Object>of("your.property.name", "the value")));
        env.resolvePlaceholders("your.property.name");
    }
}

可选择使用@Configuration 注释Foo 类，以享受编程配置的强大功能，以支持XML。

Answer 5

还有另一种可能的解决方案：通过 AspectJ 使标记类 @Configurable 并启用编译时或加载时编织。然后，我可以在我的自定义标签中使用常见的 Spring @Value 注释。 但是，真的，我不想仅仅因为几个类就设置编织基础设施。仍在寻找通过 ApplicationContext 解析占位符的方法。

Answer 6

只是为了添加一个完整的答案，我正在添加这个。

您可以使用这样的自定义类来做到这一点。

import org.springframework.context.EmbeddedValueResolverAware;
import org.springframework.util.StringValueResolver;
import org.springframework.lang.Nullable;

public class MyValueResolver implements EmbeddedValueResolverAware {
    //this will be injected using the setter injection.
    //Spring already has an implementation org.springframework.beans.factory.config.EmbeddedValueResolver
    //Or you can implement your own and use @Primary
    @Nullable
    private StringValueResolver resolver;

    @Override
    public void setEmbeddedValueResolver(StringValueResolver resolver) {
        this.resolver = resolver;
    }

    public String readMyProperty(String propertyString){
        return resolver.resolveStringValue(propertyString);
    }
}

此propertyString 应作为"${my.property}" 传递。

鉴于在.properties 文件中显示为

my.property=myPropertyValue