作用
spring具有很好的扩展性，但是这个扩展它的这个扩展性体现在哪里呢？而我们要说的BeanPostProcessor就是对Spring扩展性优秀的表现之一。
简单的说就是BeanPostProcessor提供了初始化前后回调的方法，我们所说的扩展就是在实例化前后对Bean进行扩展。
接口定义
public interface BeanPostProcessor {
/**
* 初始前调用
*/
@Nullable
default Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
return bean;
}
/**
* 初始化后调用
*/
@Nullable
default Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
return bean;
}
}
上面就是BeanPostProcessor接口的定义，从方法名字也能看出这两个方法一个在初始化前调用一个在初始化后调用。需要注意的是，方法的返回值为原始实例或者包装后的实例。如果返回null会导致后续的BeanPostProcessor不生效（BeanPostProcessor是可以注册多个的）。
如何使用
BeanPostProcessorDemo代码如下：
public class BeanPostProcessorDemo {
public static void main(String[] args) {
//创建基础容器
DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
//加载xml配置文件
XmlBeanDefinitionReader reader = new XmlBeanDefinitionReader(beanFactory);
reader.loadBeanDefinitions("spring-bean-post-processor.xml");
//添加BeanPostProcessor
beanFactory.addBeanPostProcessor(new UserBeanPostProcessor());
User user = beanFactory.getBean(User.class);
System.out.println(user);
}
}
@Data
class User{
private String userName;
private Integer age;
private String beforeMessage;
private String afterMessage;
public void initMethod(){
System.out.println("初始化:"+this);
this.setUserName("小明");
this.setAge(18);
}
}
class UserBeanPostProcessor implements BeanPostProcessor{
@Override
public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
if (bean instanceof User){
System.out.println("初始化前:"+bean);
((User) bean).setBeforeMessage("初始化前信息");
}
return bean;
}
@Override
public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
if (bean instanceof User){
System.out.println("初始化后:"+bean);
((User) bean).setAfterMessage("初始化后信息");
}
return bean;
}
}
spring-bean-post-processor.xml配置文件如下
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd">
<bean id="user" class="com.buydeem.beanpostprocessor.User" init-method="initMethod"/>
</beans>
运行之后打印结果如下：
初始化前:User(userName=null, age=null, beforeMessage=null, afterMessage=null)
初始化:User(userName=null, age=null, beforeMessage=初始化前信息, afterMessage=null)
初始化后:User(userName=小明, age=18, beforeMessage=初始化前信息, afterMessage=null)
User(userName=小明, age=18, beforeMessage=初始化前信息, afterMessage=初始化后信息)
上面的代码很简单就是创建基础的容器，因为我这个里面用的是BeanFactory，BeanFactory作为基础容器是需要手动将BeanPostProcessor注册到容器中去的。下面分析打印结果：
初始化前:User(userName=null, age=null, beforeMessage=null, afterMessage=null)
该结果是postProcessBeforeInitialization方法中输出的内容，这个时候User实例还只是进行了实例化，还未进行到初始化步骤，所以所有的属性都为null,说明该方法确实是初始化执行的。
初始化:User(userName=null, age=null, beforeMessage=初始化前信息, afterMessage=null)
该结果为自定义的初始化方法initMethod方法中输出的内容，这个时候User实例真正初始化，而beforeMessage中中的值正是我们在postProcessBeforeInitialization设置的。
初始化后:User(userName=小明, age=18, beforeMessage=初始化前信息, afterMessage=null)
该结果是postProcessAfterInitialization中输出内容，从打印结果可以看出它的确是在自定义initMethod后。
Spring相关源码解读
如果之前看过了解过Bean的生命周期一定知道，Spring中Bean总体上来说可以分为四个周期：实例化、属性赋值、初始化、销毁。而BeanPostProcessor则是在初始化阶段的前后执行，下面我通过源码来说明。
首先看AbstractAutowireCapableBeanFactory中doCreateBean方法，该方法实际就是创建指定Bean的方法。源码太长这里就不展示了，我们只需要找到其中三个重要的方法调用如下：createBeanInstance、populateBean、initializeBean。这三个方法分别代表了Spring Bean中的实例化、属性赋值和初始化三个生命周期。而BeanPostProcessor是在初始化前后调用，所以我们查看initializeBean中的方法详情即可。该方法详情如下：
protected Object initializeBean(String beanName, Object bean, @Nullable RootBeanDefinition mbd) {
//处理BeanNameAware、BeanClassLoaderAware、BeanFactoryAware
if (System.getSecurityManager() != null) {
AccessController.doPrivileged((PrivilegedAction<Object>) () -> {
invokeAwareMethods(beanName, bean);
return null;
}, getAccessControlContext());
}
else {
invokeAwareMethods(beanName, bean);
}
//处理BeanPostProcessor
Object wrappedBean = bean;
if (mbd == null || !mbd.isSynthetic()) {
//回调postProcessBeforeInitialization方法
wrappedBean = applyBeanPostProcessorsBeforeInitialization(wrappedBean, beanName);
}
try {
//处理InitializingBean和BeanDefinition中指定的initMethod
invokeInitMethods(beanName, wrappedBean, mbd);
}
catch (Throwable ex) {
throw new BeanCreationException(
(mbd != null ? mbd.getResourceDescription() : null),
beanName, "Invocation of init method failed", ex);
}
if (mbd == null || !mbd.isSynthetic()) {
//回调postProcessAfterInitialization方法
wrappedBean = applyBeanPostProcessorsAfterInitialization(wrappedBean, beanName);
}
return wrappedBean;
}
从上面的源码可以看出首先是处理部分Aware相关接口，然后接着就是处理BeanPostProcessor中的postProcessBeforeInitialization方法，该方法详情如下：
public Object applyBeanPostProcessorsBeforeInitialization(Object existingBean, String beanName)
throws BeansException {
Object result = existingBean;
//依次处理BeanPostProcessor
for (BeanPostProcessor processor : getBeanPostProcessors()) {
Object current = processor.postProcessBeforeInitialization(result, beanName);
//如果放回null,则直接返回后续BeanPostProcessor中的postProcessBeforeInitialization不再执行
if (current == null) {
return result;
}
result = current;
}
return result;
}
该方法就是执行postProcessBeforeInitialization回调的详情内容，从该实现可以知道，BeanPostProcessor可以有多个，而且会按照顺序依次处理。如果只要其中的任意一个返回null，则后续的BeanPostProcessor的postProcessBeforeInitialization将不会再处理了。接着就是执行初始化方法，即invokeInitMethods方法被调用。
protected void invokeInitMethods(String beanName, Object bean, @Nullable RootBeanDefinition mbd)
throws Throwable {
boolean isInitializingBean = (bean instanceof InitializingBean);
if (isInitializingBean && (mbd == null || !mbd.isExternallyManagedInitMethod("afterPropertiesSet"))) {
if (logger.isTraceEnabled()) {
logger.trace("Invoking afterPropertiesSet() on bean with name '" + beanName + "'");
}
//如果当前Bean实现了InitializingBean接口则会执行它的afterPropertiesSet()方法
if (System.getSecurityManager() != null) {
try {
AccessController.doPrivileged((PrivilegedExceptionAction<Object>) () -> {
((InitializingBean) bean).afterPropertiesSet();
return null;
}, getAccessControlContext());
}
catch (PrivilegedActionException pae) {
throw pae.getException();
}
}
else {
((InitializingBean) bean).afterPropertiesSet();
}
}
//如果在BeanDefinition中定义了initMethod则执行初始化方法
if (mbd != null && bean.getClass() != NullBean.class) {
String initMethodName = mbd.getInitMethodName();
if (StringUtils.hasLength(initMethodName) &&
!(isInitializingBean && "afterPropertiesSet".equals(initMethodName)) &&
!mbd.isExternallyManagedInitMethod(initMethodName)) {
invokeCustomInitMethod(beanName, bean, mbd);
}
}
}
从上面代码也进一步验证了BeanPostProcessor中的postProcessBeforeInitialization方法的确是在初始化前调用。当invokeInitMethods方法执行完之后接着就执行applyBeanPostProcessorsAfterInitialization方法。
@Override
public Object applyBeanPostProcessorsAfterInitialization(Object existingBean, String beanName)
throws BeansException {
Object result = existingBean;
for (BeanPostProcessor processor : getBeanPostProcessors()) {
Object current = processor.postProcessAfterInitialization(result, beanName);
if (current == null) {
return result;
}
result = current;
}
return result;
}
该方法与applyBeanPostProcessorsBeforeInitialization几乎就是相同的，不同的在于它执行的是postProcessAfterInitialization。至此Spring Bean的初始化也就完成了。
Spring对@PostConstruct的支持
通过上面源码解读了解了Spring Bean生命周期中初始化的过程，但是实际上Spring对于JSR250也支持，例如对@PostConstruct注解的支持，但是在之前的源码中并没有发现Spring Bean的初始化过程中有所体现。这里面的秘密就是我们的BeanPostProcessor了。在Spring中有一个CommonAnnotationBeanPostProcessor类，这个类的注释中有说到这个类就是用来对JSR250及其他一些规范的支持。下面我就通过这个类的源码来说明Spring是如何通过BeanPostProcessor来实现对@PostContruct的支持。
从上图中我们可以看出，CommonAnnotationBeanPostProcessor并没有直接对BeanPostProcessor有所实现，它继承InitDestroyAnnotationBeanPostProcessor该类，而对@PostConstruct的实现主要在该类中。
而对BeanPostProcessor的实现代码如下：
@Override
public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
//生命周期元数据封装
LifecycleMetadata metadata = findLifecycleMetadata(bean.getClass());
try {
//执行InitMethods
metadata.invokeInitMethods(bean, beanName);
}
catch (InvocationTargetException ex) {
throw new BeanCreationException(beanName, "Invocation of init method failed", ex.getTargetException());
}
catch (Throwable ex) {
throw new BeanCreationException(beanName, "Failed to invoke init method", ex);
}
return bean;
}
@Override
public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
return bean;
}
对BeanPostProcessor的实现主要在before方法中，该方法主要就是两部分内容，第一部分主要是信息封装到LifecycleMetadata中，便于后面第二步的执行相关初始化方法。
通过上面的方法实现我们知道了，Spring对JSR250的实现就是借助于BeanPostProcessor来实现的。下面我直接用代码来验证看看我的猜想是否正确。
public class BeanPostProcessorDemo2 {
public static void main(String[] args) {
//创建基础容器
DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
//构建BeanDefinition并注册
AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.genericBeanDefinition(Person.class)
.getBeanDefinition();
beanFactory.registerBeanDefinition("person",beanDefinition);
//注册CommonAnnotationBeanPostProcessor
CommonAnnotationBeanPostProcessor commonAnnotationBeanPostProcessor = new CommonAnnotationBeanPostProcessor();
beanFactory.addBeanPostProcessor(commonAnnotationBeanPostProcessor);
//获取Bean
Person person = beanFactory.getBean(Person.class);
System.out.println(person);
}
}
class Person{
@PostConstruct
public void annotationInitMethod(){
System.out.println("@PostConstruct");
}
}
上面的代码比较简单，我们定义一个Person并使用@PostConstruct标记出它的初始化方法，然后我们创建BeanFactory，并创建Person的BeanDefinition将其注册到BeanFactory（与读取配置文件一样），然后我们创建CommonAnnotationBeanPostProcessor并将其添加到BeanFactory中。最后打印结果打印出@PostConstruct。如果我们将下面这句代码注释。
beanFactory.addBeanPostProcessor(commonAnnotationBeanPostProcessor);
再次执行可以发现，@PostConstruct将会失效，且最后不会打印出结果。
使用中的注意事项
如何使用以及实现原理上面已经说了很多，但是在使用时有些地方是有限制的，对于这些限制还是要做了解，避免到时候使用时出现问题而不知道是什么原因导致的。
顺序性
BeanPostProcessor是可以注册多个的，在AbstractBeanFactory内部通过List变量beanPostProcessors来存储BeanPostProcessor。而在执行时是按照List中BeanPostProcessor的顺序一个个执行的，所以我们在想容器中添加BeanPostProcessor时需要注意顺序。如果我们不是通过手动添加（大多数时候不是）时，而是在代码或者配置文件中定义多个BeanPostProcessor时，我们可以通过实现Ordered接口来控制它的顺序。
BeanPostProcessor依赖的Bean不会执行BeanPostProcessor
BeanPostProcessor依赖的Bean是不会执行BeanPostProcessor的，这是因为在创建BeanPOstProcessor之所依赖的Bean就需要完成初始化，而这个时候BeanPostProcessor都还未完初始化完成。实例代码如下：
public class App3 {
public static void main(String[] args) {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
context.scan("com.buydeem.beanpostprocessor");
context.register(App3.class);
context.refresh();
}
}
@Component
class ClassA{
}
@Component
class ClassB{
}
@Component
class MyBeanPostProcessor implements BeanPostProcessor{
@Autowired
private ClassA classA;
@Override
public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
System.out.println("MyBeanPostProcessor"+bean);
return bean;
}
}
最后ClassA是不会打印出来的，而ClassB是会被打印出来。因为MyBeanPostProcessor依赖ClassA实例。
注册方式
注册BeanPostProcessor方式主要有两种，一种是在Java或则xml文件配置和声明作为普通Bean。这样在ApplicationContext加载时会对这类型的Bean特殊处理，将其注册到容器中来。另外一种则是通过API手动注册到容器，就如我们之前的示例一样，在还未注册到容器之前是不会生效的。
总结
在Spring中BeanPostProcessor的子接口或实现类有很多种，例如：InstantiationAwareBeanPostProcessor、MergedBeanDefinitionPostProcessor、DestructionAwareBeanPostProcessor等等。这些接口分别处在Spring Bean生命周期的不同阶段，而他们的功能与BeanPostProcessor都类似，都是为了给Spring Bean各个声明周期提供扩展点。
