深入Spring Boot：那些注入不了的 Spring 占位符 ( ${} 表达式 )

Spring里的占位符

spring里的占位符通常表现的形式是：


1

2

3


<bean id="dataSource" destroy-method="close" class="org.apache.commons.dbcp.BasicDataSource">

<property name="url" value="${jdbc.url}"/>

</bean>

或者


1

2

3

4

5

6


@Configuration

@ImportResource("classpath:/com/acme/properties-config.xml")

public class AppConfig {

    @Value("${jdbc.url}")

    private String url;

}

Spring应用在有时会出现占位符配置没有注入，原因可能是多样的。

本文介绍两种比较复杂的情况。

占位符是在Spring生命周期的什么时候处理的

Spirng在生命周期里关于Bean的处理大概可以分为下面几步：

  1. 加载Bean定义（从xml或者从@Import等）
  2. 处理BeanFactoryPostProcessor
  3. 实例化Bean
  4. 处理Bean的property注入
  5. 处理BeanPostProcessor

当然这只是比较理想的状态，实际上因为Spring Context在构造时，也需要创建很多内部的Bean，应用在接口实现里也会做自己的各种逻辑，整个流程会非常复杂。

那么占位符（${}表达式）是在什么时候被处理的？

  • 实际上是在org.springframework.context.support.PropertySourcesPlaceholderConfigurer里处理的，它会访问了每一个bean的BeanDefinition，然后做占位符的处理
  • PropertySourcesPlaceholderConfigurer实现了BeanFactoryPostProcessor接口
  • PropertySourcesPlaceholderConfigurer的 order是Ordered.LOWEST_PRECEDENCE，也就是最低优先级的

结合上面的Spring的生命周期，如果Bean的创建和使用在PropertySourcesPlaceholderConfigurer之前，那么就有可能出现占位符没有被处理的情况。

例子1：Mybatis 的 MapperScannerConfigurer引起的占位符没有处理

例子代码：mybatis-demo.zip

  • 首先应用自己在代码里创建了一个DataSource，其中${db.user}是希望从application.properties里注入的。代码在运行时会打印出user的实际值。

1

2

3

4

5

6

7

8

9

10

11


@Configuration

public class MyDataSourceConfig {

    @Bean(name = "dataSource1")

    public DataSource dataSource1(@Value("${db.user}") String user) {

        System.err.println("user: " + user);

        JdbcDataSource ds = new JdbcDataSource();

        ds.setURL("jdbc:h2:?/test");

        ds.setUser(user);

        return ds;

    }

}

  • 然后应用用代码的方式来初始化mybatis相关的配置，依赖上面创建的DataSource对象

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22


@Configuration

public class MybatisConfig1 {

    @Bean(name = "sqlSessionFactory1")

    public SqlSessionFactory sqlSessionFactory1(DataSource dataSource1) throws Exception {

        SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();

        org.apache.ibatis.session.Configuration ibatisConfiguration = new org.apache.ibatis.session.Configuration();

        sqlSessionFactoryBean.setConfiguration(ibatisConfiguration);

        sqlSessionFactoryBean.setDataSource(dataSource1);

        sqlSessionFactoryBean.setTypeAliasesPackage("sample.mybatis.domain");

        return sqlSessionFactoryBean.getObject();

    }

    @Bean

    MapperScannerConfigurer mapperScannerConfigurer(SqlSessionFactory sqlSessionFactory1) {

        MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();

        mapperScannerConfigurer.setSqlSessionFactoryBeanName("sqlSessionFactory1");

        mapperScannerConfigurer.setBasePackage("sample.mybatis.mapper");

        return mapperScannerConfigurer;

    }

}

当代码运行时，输出结果是：


1
user: ${db.user}

为什么会user这个变量没有被注入？

分析下Bean定义，可以发现MapperScannerConfigurer它实现了BeanDefinitionRegistryPostProcessor。这个接口在是Spring扫描Bean定义时会回调的，远早于BeanFactoryPostProcessor。

所以原因是：

  • MapperScannerConfigurer它实现了BeanDefinitionRegistryPostProcessor，所以它会Spring的早期会被创建
  • 从bean的依赖关系来看，mapperScannerConfigurer依赖了sqlSessionFactory1，sqlSessionFactory1依赖了dataSource1
  • MyDataSourceConfig里的dataSource1被提前初始化，没有经过PropertySourcesPlaceholderConfigurer的处理，所以@Value(“${db.user}”) String user 里的占位符没有被处理

要解决这个问题，可以在代码里，显式来处理占位符：


1
environment.resolvePlaceholders("${db.user}")

例子2：Spring boot自身实现问题，导致Bean被提前初始化

例子代码：demo.zip

Spring Boot里提供了@ConditionalOnBean，这个方便用户在不同条件下来创建bean。里面提供了判断是否存在bean上有某个注解的功能。


1

2

3

4

5

6

7

8

9

10

11

12


@Target({ ElementType.TYPE, ElementType.METHOD })

@Retention(RetentionPolicy.RUNTIME)

@Documented

@Conditional(OnBeanCondition.class)

public @interface ConditionalOnBean {

    /**

     * The annotation type decorating a bean that should be checked. The condition matches

     * when any of the annotations specified is defined on a bean in the

     * {@link ApplicationContext}.

     * @return the class-level annotation types to check

     */

    Class<? extends Annotation>[] annotation() default {};

比如用户自己定义了一个Annotation：


1

2

3

4


@Target({ ElementType.TYPE })

@Retention(RetentionPolicy.RUNTIME)

public @interface MyAnnotation {

}

然后用下面的写法来创建abc这个bean，意思是当用户显式使用了@MyAnnotation（比如放在main class上），才会创建这个bean。


1

2

3

4

5

6

7

8

9


@Configuration

public class MyAutoConfiguration {

    @Bean

    // if comment this line, it will be fine.

    @ConditionalOnBean(annotation = { MyAnnotation.class })

    public String abc() {

        return "abc";

    }

}

这个功能很好，但是在spring boot 1.4.5 版本之前都有问题，会导致FactoryBean提前初始化。

在例子里，通过xml创建了javaVersion这个bean，想获取到java的版本号。这里使用的是spring提供的一个调用static函数创建bean的技巧。


1

2

3

4

5

6

7

8

9

10


<bean id="sysProps" class="org.springframework.beans.factory.config.MethodInvokingFactoryBean">

  <property name="targetClass" value="java.lang.System" />

  <property name="targetMethod" value="getProperties" />

</bean>

<bean id="javaVersion" class="org.springframework.beans.factory.config.MethodInvokingFactoryBean">

  <property name="targetObject" ref="sysProps" />

  <property name="targetMethod" value="getProperty" />

  <property name="arguments" value="${java.version.key}" />

</bean>

我们在代码里获取到这个javaVersion，然后打印出来：


1

2

3

4

5

6

7

8

9


@SpringBootApplication

@ImportResource("classpath:/demo.xml")

public class DemoApplication {

    public static void main(String[] args) {

        ConfigurableApplicationContext context = SpringApplication.run(DemoApplication.class, args);

        System.err.println(context.getBean("javaVersion"));

    }

}

在实际运行时，发现javaVersion的值是null。

这个其实是spring boot的锅，要搞清楚这个问题，先要看@ConditionalOnBean的实现。

  • @ConditionalOnBean实际上是在ConfigurationClassPostProcessor里被处理的，它实现了BeanDefinitionRegistryPostProcessor
  • BeanDefinitionRegistryPostProcessor是在spring早期被处理的
  • @ConditionalOnBean的具体处理代码在org.springframework.boot.autoconfigure.condition.OnBeanCondition里
  • OnBeanCondition在获取bean的Annotation时，调用了beanFactory.getBeanNamesForAnnotation

1

2

3

4

5

6

7

8

9


private String[] getBeanNamesForAnnotation(

    ConfigurableListableBeanFactory beanFactory, String type,

    ClassLoader classLoader, boolean considerHierarchy) throws LinkageError {

  String[] result = NO_BEANS;

  try {

    @SuppressWarnings("unchecked")

    Class<? extends Annotation> typeClass = (Class<? extends Annotation>) ClassUtils

        .forName(type, classLoader);

    result = beanFactory.getBeanNamesForAnnotation(typeClass);

  • beanFactory.getBeanNamesForAnnotation 会导致FactoryBean提前初始化，创建出javaVersion里，传入的${java.version.key}没有被处理，值为null。
  • spring boot 1.4.5 修复了这个问题：https://github.com/spring-projects/spring-boot/issues/8269

实现spring boot starter要注意不能导致bean提前初始化

用户在实现spring boot starter时，通常会实现Spring的一些接口，比如BeanFactoryPostProcessor接口，在处理时，要注意不能调用类似beanFactory.getBeansOfType，beanFactory.getBeanNamesForAnnotation 这些函数，因为会导致一些bean提前初始化。

而上面有提到PropertySourcesPlaceholderConfigurer的order是最低优先级的，所以用户自己实现的BeanFactoryPostProcessor接口在被回调时很有可能占位符还没有被处理。

对于用户自己定义的@ConfigurationProperties对象的注入，可以用类似下面的代码：


1

2

3

4


@ConfigurationProperties(prefix = "spring.my")

public class MyProperties {

    String key;

}


1

2

3

4

5

6

7

8

9

10


public static MyProperties buildMyProperties(ConfigurableEnvironment environment) {

  MyProperties myProperties = new MyProperties();

  if (environment != null) {

    MutablePropertySources propertySources = environment.getPropertySources();

    new RelaxedDataBinder(myProperties, "spring.my").bind(new PropertySourcesPropertyValues(propertySources));

  }

  return myProperties;

}

总结

  • 占位符（${}表达式）是在PropertySourcesPlaceholderConfigurer里处理的，也就是BeanFactoryPostProcessor接口

  • spring的生命周期是比较复杂的事情，在实现了一些早期的接口时要小心，不能导致spring bean提前初始化
  • 在早期的接口实现里，如果想要处理占位符，可以利用spring自身的api，比如 environment.resolvePlaceholders(“${db.user}”)

一个Java交流平台分享给你们，让你在实践中积累经验掌握原理。如果你想拿高薪，想突破瓶颈，想跟别人竞争能取得优势的，想进BAT但是有担心面试不过的，可以加我的Java学习交流群：642830685

注：加群要求

1、大学学习的是Java相关专业，毕业后面试受挫，找不到对口工作

2、在公司待久了，现在过得很安逸，但跳槽时面试碰壁。需要在短时间内进修、跳槽拿高薪的

3、参加过线下培训后，知识点掌握不够深刻，就业困难，想继续深造

4、已经在Java相关部门上班的在职人员，对自身职业规划不清晰，混日子的

5、有一定的C语言基础，接触过java开发，想转行的

原文地址：http://blog.51cto.com/13551455/2066468

时间： 2024-08-29 07:25:07

深入Spring Boot：那些注入不了的 Spring 占位符 ( ${} 表达式 )的相关文章

曹工说Spring Boot源码（15）-- Spring从xml文件里到底得到了什么（context：load-time-weaver 完整解析）

写在前面的话 相关背景及资源: 曹工说Spring Boot源码(1)-- Bean Definition到底是什么,附spring思维导图分享 曹工说Spring Boot源码(2)-- Bean Definition到底是什么,咱们对着接口,逐个方法讲解 曹工说Spring Boot源码(3)-- 手动注册Bean Definition不比游戏好玩吗,我们来试一下 曹工说Spring Boot源码(4)-- 我是怎么自定义ApplicationContext,从json文件读取bean de

曹工说Spring Boot源码（16）-- Spring从xml文件里到底得到了什么（aop：config完整解析【上】）

写在前面的话 相关背景及资源: 曹工说Spring Boot源码(1)-- Bean Definition到底是什么,附spring思维导图分享 曹工说Spring Boot源码(2)-- Bean Definition到底是什么,咱们对着接口,逐个方法讲解 曹工说Spring Boot源码(3)-- 手动注册Bean Definition不比游戏好玩吗,我们来试一下 曹工说Spring Boot源码(4)-- 我是怎么自定义ApplicationContext,从json文件读取bean de

曹工说Spring Boot源码（18）-- Spring AOP源码分析三部曲，终于快讲完了 (aop：config完整解析【下】)

写在前面的话 相关背景及资源: 曹工说Spring Boot源码(1)-- Bean Definition到底是什么,附spring思维导图分享 曹工说Spring Boot源码(2)-- Bean Definition到底是什么,咱们对着接口,逐个方法讲解 曹工说Spring Boot源码(3)-- 手动注册Bean Definition不比游戏好玩吗,我们来试一下 曹工说Spring Boot源码(4)-- 我是怎么自定义ApplicationContext,从json文件读取bean de

spring boot 系列之六：@Conditional和spring boot的自动配置

我们知道,spring boot自动配置功能可以根据不同情况来决定spring配置应该用哪个,不应该用哪个,举个例子: Spring的JdbcTemplate是不是在Classpath里面?如果是,并且DataSource也存在,就自动配置一个JdbcTemplate的Bean Thymeleaf是不是在Classpath里面?如果是,则自动配置Thymeleaf的模板解析器.视图解析器.模板引擎 那个这个是怎么实现的呢?原因就在于它利用了Spring的条件化配置,条件化配置允许配置存在于应用中

曹工说Spring Boot源码（8）-- Spring解析xml文件，到底从中得到了什么（util命名空间）

写在前面的话 相关背景及资源: 曹工说Spring Boot源码(1)-- Bean Definition到底是什么,附spring思维导图分享 曹工说Spring Boot源码(2)-- Bean Definition到底是什么,咱们对着接口,逐个方法讲解 曹工说Spring Boot源码(3)-- 手动注册Bean Definition不比游戏好玩吗,我们来试一下 曹工说Spring Boot源码(4)-- 我是怎么自定义ApplicationContext,从json文件读取bean de

曹工说Spring Boot源码（9）-- Spring解析xml文件，到底从中得到了什么（context命名空间上）

写在前面的话 相关背景及资源: 曹工说Spring Boot源码(1)-- Bean Definition到底是什么,附spring思维导图分享 曹工说Spring Boot源码(2)-- Bean Definition到底是什么,咱们对着接口,逐个方法讲解 曹工说Spring Boot源码(3)-- 手动注册Bean Definition不比游戏好玩吗,我们来试一下 曹工说Spring Boot源码(4)-- 我是怎么自定义ApplicationContext,从json文件读取bean de

曹工说Spring Boot源码（19）-- Spring 带给我们的工具利器，创建代理不用愁（ProxyFactory）

写在前面的话 相关背景及资源: 曹工说Spring Boot源码(1)-- Bean Definition到底是什么,附spring思维导图分享 曹工说Spring Boot源码(2)-- Bean Definition到底是什么,咱们对着接口,逐个方法讲解 曹工说Spring Boot源码(3)-- 手动注册Bean Definition不比游戏好玩吗,我们来试一下 曹工说Spring Boot源码(4)-- 我是怎么自定义ApplicationContext,从json文件读取bean de

如何掌握 Spring，Spring Boot 全家桶？系统学习 Spring 的大纲一份（实战教学）

搞个推荐! 资深的 Spring 工程师应该都知道 Spring 界的大牛丁雪丰.作为平安壹钱包的高级架构师之余,他不仅翻译了<Spring Boot 实战><Spring 攻略>两本书,还出了一门一揽子解决 Spring 全家桶的课程<玩转 Spring 全家桶>. 他在推荐自己的这门课程时说, 市面上有很多书和教程,但对于很多开发人员,在学习 Spring 的时候,难免会遇到这些问题: 官方文档虽然全面,但面对庞杂的知识体系,很多初学者一时不知该从哪里下手: 手册式

曹工说Spring Boot源码（24）-- Spring注解扫描的瑞士军刀，asm技术实战（上）

写在前面的话 相关背景及资源: 曹工说Spring Boot源码(1)-- Bean Definition到底是什么,附spring思维导图分享 曹工说Spring Boot源码(2)-- Bean Definition到底是什么,咱们对着接口,逐个方法讲解 曹工说Spring Boot源码(3)-- 手动注册Bean Definition不比游戏好玩吗,我们来试一下 曹工说Spring Boot源码(4)-- 我是怎么自定义ApplicationContext,从json文件读取bean de

spring boot servlet 注入

spring boot 注入servlet的方法是借助ServletRegistrationBean这个类 例子如下: 先建一个servlet import java.io.IOException; import javax.servlet.ServletException; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServlet; import javax.servlet.http.Ht