关于Spring的PostProcessor
本文只介绍几个重要的PostProcessor。
首先要明确一点,实例化、填充属性与初始化三者的区别
- 实例化(instantiateBean):bean的创建,可以理解为new一个实例,在Spring中通过反射完成
- 填充属性(populateBean):填充Autowire的属性
- 初始化(invokeInitMethods):此时一个对象已经实例化完成了,构造函数执行完了,Autowire的属性也注入完了。初始化对应于InitializingBean或者@Bean注解中的initMethod。比如数据库连接的初始化。
对应的也有DisposableBean和@Bean中的destroyMethod。
BeanPostProcessor
- 在容器创建过程中的registerBeanPostProcessors中从beanDefinitionMap中取出并完成初始化,而后按顺序、优先级添加到beanPostProcessors集合中
- 在bean并填充属性后但初始化的前后被调用
- 由于需要对bean实例进行后置处理,如果在该类中注入普通bean,Spring会给予警告,因为这可能导致bean被提前初始化
public interface BeanPostProcessor {
/* 在initMethod执行之前被调用,如果返回null,则不会调用后续的BeanPostProcessor */
@Nullable
default Object postProcessBeforeInitialization(
Object bean, String beanName) throws BeansException {
return bean;
}
/* 在initMethod执行之后被调用,如果返回null,则不会调用后续的BeanPostProcessor */
@Nullable
default Object postProcessAfterInitialization(
Object bean, String beanName) throws BeansException {
return bean;
}
}
InstantiationAwareBeanPostProcessor
- 继承自BeanPostProcessor接口
- bean实例化前,以及实例化后但属性填充前被调用
- 通常用于抑制特定目标 bean 的默认实例化,例如创建具有特殊 TargetSources 的代理(池化目标、延迟初始化目标等),或实现额外的注入策略,例如字段注入。
注意:该接口是一个特殊用途的接口,主要供框架内部使用
public interface InstantiationAwareBeanPostProcessor
extends BeanPostProcessor {
/* 实例化之前调用,返回的bean对象可能是一个代理来代替目标bean,有效地抑制目标bean的默认实例化 */
@Nullable
default Object postProcessBeforeInstantiation(
Class<?> beanClass, String beanName) throws BeansException {
return null;
}
/* 如果应该在 bean 上设置属性,则为true;如果应跳过属性填充,则为false;
* 正常的实现应该返回true 。 返回false还将阻止在此 bean 实例上调用任何后续
*/
default boolean postProcessAfterInstantiation(
Object bean, String beanName) throws BeansException {
return true;
}
/* 其他方法 */
...
BeanFactoryPostProcessor
- 在容器创建过程中的invokeBeanFactoryPostProcessors方法中完成初始化,并按顺序、优先级被调用,此时所有bean定义被加载,但尚未实例化任何普通bean
- 作为工厂钩子,可以修改和添加bean定义,但绝不能与bean实例交互。这样做可能会导致bean过早实例化、影响容器创建。
@FunctionalInterface
public interface BeanFactoryPostProcessor {
void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
throws BeansException;
}
BeanDefinitionRegistryPostProcessor
- 继承自BeanFactoryPostProcessor
- 在容器创建过程中的invokeBeanFactoryPostProcessors方法中完成初始化,并按顺序、优先级在BeanFactoryPostProcessor之前被调用
- 执行后,所有bean定义被加载,但尚未实例化任何普通bean
public interface BeanDefinitionRegistryPostProcessor
extends BeanFactoryPostProcessor {
void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry)
throws BeansException;
}
这个接口在Spring中有唯一的实现类,ConfigurationClassPostProcessor,这个类负责从解析配置类,在它的postProcessBeanDefinitionRegistry中,通过ConfigurationClassParser这个类扫描了@Configuration、@Import、@Bean等注解并完成对应的操作。
这个类是Spring保证容器创建的正常执行,在代码中手动注入的,名字为org.springframework.context.annotation.internalConfigurationAnnotationProcessor。
通常我们也不需要实现该接口,但假如我有独立于Spring之外的注解的类需要被解析为Bean,则可以实现该接口,典型的例子就是,@Mapper、@MapperScan注解,具体可查看Springboot-Mybatis自动配置下的该类:
public class MapperScannerConfigurer
implements BeanDefinitionRegistryPostProcessor, InitializingBean, ApplicationContextAware, BeanNameAware {
Q.E.D.