SpringBoot的迁移过程中碰到的奇葩坑
什么坑?
原Spring项目迁移成SpringBoot项目,早前使用 PropertyPlaceholderConfigurer 配置properties引入,在使用properties中的配置项时报错,如 ${user.name} 配置项找不到,有时又可以但 application.properties 中配置项找不到。
要找到问题关键先要知道Spring处理配置项注入是怎么实现的。
Spring 配置项注入
1. Spring注入方式
- XML注入
<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close"> <property name="driverClassName" value="${spring.datasource.driver}"/> <property name="url" value="${spring.datasource.url}"/> <property name="username" value="${spring.datasource.username}"/> <property name="password" value="${spring.datasource.password}"/> <property name="initialSize" value="${spring.datasource.initialSize}"/> <property name="maxActive" value="${spring.datasource.maxActive}"/> <property name="maxIdle" value="${spring.datasource.maxIdle}"/> <property name="minIdle" value="${spring.datasource.minIdle}"/> <property name="maxWait" value="${spring.datasource.maxWait}"/> </bean>
- @Value Java代码中注入
@Value("${user.name}") private String username;
2. 实现原理
2.1 XML
PropertyPlaceholderConfigurer 为例,实现 BeanFactoryPostProcessor 接口所以bean Definition 载入完毕后会被调用
postProcessBeanFactory()
在该方法中主要是遍历所有的BeanDefinition,找到那些 ${} 的配置项,然后替换掉
visitor.visitBeanDefinition(bd); // 遍历BeanDefinition
最后,将 StringValueResolver 加到 BeanFactory 中留作他用(如 AutowiredAnnotationBeanPostProcessor 有用,下面就分析)
beanFactoryToProcess.addEmbeddedValueResolver(valueResolver);
2.2 @Value
所有 @Value,@Autowired 注解都是由 AutowiredAnnotationBeanPostProcessor 来实现处理的,由于实现了接口 InstantiationAwareBeanPostProcessor ,所以会自动在实例完后调用
PropertyValues postProcessPropertyValues(PropertyValues var1, PropertyDescriptor[] var2, Object var3, String var4)
public PropertyValues postProcessPropertyValues(PropertyValues pvs, PropertyDescriptor[] pds, Object bean, String beanName) throws BeansException {
InjectionMetadata metadata = this.findAutowiringMetadata(beanName, bean.getClass(), pvs);
try {
metadata.inject(bean, beanName, pvs); // 注入的主逻辑
return pvs;
} catch (BeanCreationException var7) {
throw var7;
} catch (Throwable var8) {
throw new BeanCreationException(beanName, "Injection of autowired dependencies failed", var8);
}
}
在 metadata.inject 中主要是调用 BeanFactory 的
value = AutowiredAnnotationBeanPostProcessor.this.beanFactory.resolveDependency(desc, beanName, autowiredBeanNames, typeConverter);
...
field.set(bean, value);
beanFactory.resolveDependency
-> beanFactory.doResolveDependency
-> beanFactory.resolveEmbeddedValue
public String resolveEmbeddedValue(String value) {
String result = value;
StringValueResolver resolver;
for(Iterator var3 = this.embeddedValueResolvers.iterator(); var3.hasNext(); result = resolver.resolveStringValue(result)) {
resolver = (StringValueResolver)var3.next();
if(result == null) {
return null;
}
}
return result;
}
最终还是获取 embeddedValueResolvers 来处理
为什么会报错?
SpringBoot 默认就会注册一个 PropertySourcesPlaceholderConfigurer,当再配置一个 PropertyPlaceholderConfigurer 时就会存在两个,一部分properties在前者、一部分在后者,那么肯定会执行其中一个时报错。
在执行 resolver.resolveStringValue(result) 时,最终 PlaceholderResolvingStringValueResolver 的 helper 中
protected String parseStringValue(String strVal, PropertyPlaceholderHelper.PlaceholderResolver placeholderResolver, Set<String> visitedPlaceholders) {
...
if (value != null) {
...
} else {
if(!this.ignoreUnresolvablePlaceholders) {
throw new IllegalArgumentException("Could not resolve placeholder \'" + placeholder + "\'" + " in string value \"" + strVal + "\"");
}
}
}
就是解析不到${}时就会报错。
解决方法
- 将原来的 PropertySourcesPlaceholderConfigurer 去掉
- 改写 PropertySourcesPlaceholderConfigurer,将 Environment 加入
- 将两个Configurer的 ignoreUnresolvablePlaceholders 都配置成true
三种方式任选,建议(1)使用SpringBoot的最佳实践