0
点赞
收藏
分享

微信扫一扫

Spring扩展之BeanPostProcessor接口

目录

一、定义

二、自定义BeanPostProcessor的实现类

三、BeanPostProcessor的注册过程分析

四、BeanPostProcessor的执行过程分析

五、BeanPostProcessor的常用子类和实现类

六、总结


一、定义

BeanPostProcessor是Spring IOC容器给我们提供的一个扩展接口,它可以在spring容器实例化bean之后,在执行bean的初始化方法前后,允许我们自定义修改新的bean实例,如修改bean的属性,可以给bean生成一个动态代理实例等等,Spring AOP的底层处理也是通过实现BeanPostProcessor来执行代理包装逻辑的。

BeanPostProcessor是一个接口,其定义如下:

public interface BeanPostProcessor {

	// 在实例化及依赖注入完成后、在bean初始化之前执行
	@Nullable
	default Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
		return bean;
	}

	// 在bean初始化之后执行
	@Nullable
	default Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
		return bean;
	}

}

二、自定义BeanPostProcessor的实现类

(一)、先编写一个简单的实体类

public class Student implements Serializable, InitializingBean {

	private String id;

	private String name;

	private Integer age;

	public Student() {
		System.out.println("执行Student实例化...");
	}

	public String getId() {
		return id;
	}

	public void setId(String id) {
		this.id = id;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public Integer getAge() {
		return age;
	}

	public void setAge(Integer age) {
		this.age = age;
	}

	public void init() {
		System.out.println("执行Student的init()方法...");
	}

	public void destroy() {
		System.out.println("执行Student的destroy()方法...");
	}

	@Override
	public void afterPropertiesSet() throws Exception {
		System.out.println("执行Student的afterPropertiesSet()方法...");
	}

	@Override
	public String toString() {
		return "Student{" +
				"id='" + id + '\'' +
				", name='" + name + '\'' +
				", age=" + age +
				'}';
	}
}

这里,实体类实现了InitializingBean接口重写了afterPropertiesSet()方法,以及定义了两个自定义初始化、销毁对应的方法。

(二)、编写BeanPostProcessor实现类

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanPostProcessor;

public class MyBeanPostProcessor implements BeanPostProcessor {
	@Override
	public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
		System.out.println("执行MyBeanPostProcessor的postProcessBeforeInitialization()方法...");
		return bean;
	}

	@Override
	public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
		System.out.println("执行MyBeanPostProcessor的postProcessAfterInitialization()方法...");
		return bean;
	}
}

(三)、编写spring配置文件,注册自定义的BeanFactoryPostProcessor、bean信息

<!--自定义BeanPostProcessor-->
<bean id="student" class="com.wsh.beanpostprocessor.Student" init-method="init" destroy-method="destroy">
    <property name="id" value="1"/>
    <property name="name" value="张三"/>
    <property name="age" value="10"/>
</bean>
<bean id="myBeanPostProcessor" class="com.wsh.beanpostprocessor.MyBeanPostProcessor"/>

(四)、测试类

public class Test {
	public static void main(String[] args) {
		ClassPathXmlApplicationContext applicationContext = new ClassPathXmlApplicationContext("classpath:spring-config.xml");
		System.out.println( applicationContext.getBean("student"));
	}
}

(五)、运行结果

执行Student实例化...
执行MyBeanPostProcessor的postProcessBeforeInitialization()方法...
执行Student的afterPropertiesSet()方法...
执行Student的init()方法...
执行MyBeanPostProcessor的postProcessAfterInitialization()方法...
Student{id='1', name='张三', age=10}

从上面的结果可以看出,在调用两个初始化方法前后,执行了自定义BeanPostProcessor的逻辑,这里只是简单的输出,读者可自行扩展。并且初始化方法的执行顺序是,先执行afterPropertiesSet(),再执行自定义的初始化方法init-method。

三、BeanPostProcessor的注册过程分析

BeanPostProcessor的注册是在refresh()方法的第六步完成的,主要通过registerBeanPostProcessors(beanFactory)方法:

/**
  * 6、注册BeanPostProcessor,注意,这里还不会执行BeanPostProcessor对应的增强方法
  *  真正调用是在bean初始化前、初始化后
  */
registerBeanPostProcessors(beanFactory);

// org.springframework.context.support.AbstractApplicationContext#registerBeanPostProcessors
protected void registerBeanPostProcessors(ConfigurableListableBeanFactory beanFactory) {
    PostProcessorRegistrationDelegate.registerBeanPostProcessors(beanFactory, this);
}

可以看到,核心逻辑都委托给PostProcessorRegistrationDelegate的registerBeanPostProcessors()方法。

首先简述一下registerBeanPostProcessors()方法的处理过程:

  • 1、从bean工厂中获取到所有实现了BeanPostProcessor接口的bean;
  • 2、循环遍历扫描出的所有的BeanPostProcessor,然后分别存放到前面定义的几个集合中;
  • 3、按优先级排序后,注册实现了PriorityOrdered接口的BeanPostProcessor;
  • 4、按优先级排序后,注册实现了Ordered接口的BeanPostProcessor;
  • 5、注册其他普通的BeanPostProcessor;
public static void registerBeanPostProcessors(
    ConfigurableListableBeanFactory beanFactory, AbstractApplicationContext applicationContext) {

    // 1、从bean工厂中获取到所有实现了BeanPostProcessor接口的bean
    // 如本例中我们自定义的MyBeanPostProcessor就会在这里被扫描出
    String[] postProcessorNames = beanFactory.getBeanNamesForType(BeanPostProcessor.class, true, false);

    // Register BeanPostProcessorChecker that logs an info message when
    // a bean is created during BeanPostProcessor instantiation, i.e. when
    // a bean is not eligible for getting processed by all BeanPostProcessors.
    int beanProcessorTargetCount = beanFactory.getBeanPostProcessorCount() + 1 + postProcessorNames.length;

    // 往bean工厂中添加一个BeanPostProcessor -> BeanPostProcessorChecker
    // BeanPostProcessorChecker是一个在创建bean期间记录信息消息的BeanPostProcessor
    beanFactory.addBeanPostProcessor(new BeanPostProcessorChecker(beanFactory, beanProcessorTargetCount));

    // 存放实现了PriorityOrdered接口的BeanPostProcessor
    List<BeanPostProcessor> priorityOrderedPostProcessors = new ArrayList<>();

    // 存放实现了MergedBeanDefinitionPostProcessor接口的BeanPostProcessor
    List<BeanPostProcessor> internalPostProcessors = new ArrayList<>();

    // 存放实现了Ordered接口的BeanPostProcessor
    List<String> orderedPostProcessorNames = new ArrayList<>();

    // 存放普通的BeanPostProcessor
    List<String> nonOrderedPostProcessorNames = new ArrayList<>();

    // 2、循环遍历扫描出的所有的BeanPostProcessor,然后分别存放到前面定义的几个集合中
    for (String ppName : postProcessorNames) {

        // 实现了PriorityOrdered接口的BeanPostProcessor
        if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) {
            // 通过getBean获取对应的Bean实例,然后添加到priorityOrderedPostProcessors集合中
            // 这里涉及到获取bean的过程,暂且不深入分析
            BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class);
            priorityOrderedPostProcessors.add(pp);

            // 如果同时实现了MergedBeanDefinitionPostProcessor接口,加入到internalPostProcessors集合中
            if (pp instanceof MergedBeanDefinitionPostProcessor) {
                internalPostProcessors.add(pp);
            }
        }
        else if (beanFactory.isTypeMatch(ppName, Ordered.class)) {
            // 实现了Ordered接口的BeanPostProcessor
            orderedPostProcessorNames.add(ppName);
        }
        else {
            // 普通BeanPostProcessor
            nonOrderedPostProcessorNames.add(ppName);
        }
    }

    // 排序
    sortPostProcessors(priorityOrderedPostProcessors, beanFactory);

    // 3、注册实现了PriorityOrdered接口的BeanPostProcessor
    registerBeanPostProcessors(beanFactory, priorityOrderedPostProcessors);

    List<BeanPostProcessor> orderedPostProcessors = new ArrayList<>();
    for (String ppName : orderedPostProcessorNames) {
        BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class);
        orderedPostProcessors.add(pp);

        // 如果同时实现了MergedBeanDefinitionPostProcessor接口,加入到internalPostProcessors集合中
        if (pp instanceof MergedBeanDefinitionPostProcessor) {
            internalPostProcessors.add(pp);
        }
    }
    // 排序
    sortPostProcessors(orderedPostProcessors, beanFactory);

    // 4、注册实现了Ordered接口的BeanPostProcessor
    // 通过beanFactory.addBeanPostProcessor(postProcessor)添加BeanPostProcessor
    registerBeanPostProcessors(beanFactory, orderedPostProcessors);

    // Now, register all regular BeanPostProcessors.

    // 5、注册其他普通的BeanPostProcessor
    List<BeanPostProcessor> nonOrderedPostProcessors = new ArrayList<>();
    for (String ppName : nonOrderedPostProcessorNames) {
        BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class);
        nonOrderedPostProcessors.add(pp);

        // 如果同时实现了MergedBeanDefinitionPostProcessor接口,加入到internalPostProcessors集合中
        if (pp instanceof MergedBeanDefinitionPostProcessor) {
            internalPostProcessors.add(pp);
        }
    }
    // 通过beanFactory.addBeanPostProcessor(postProcessor)添加BeanPostProcessor
    registerBeanPostProcessors(beanFactory, nonOrderedPostProcessors);

    // 排序
    sortPostProcessors(internalPostProcessors, beanFactory);

    // 通过beanFactory.addBeanPostProcessor(postProcessor)添加BeanPostProcessor
    // 6、注册所有内部 BeanPostProcessor
    registerBeanPostProcessors(beanFactory, internalPostProcessors);

    // Re-register post-processor for detecting inner beans as ApplicationListeners,
    // moving it to the end of the processor chain (for picking up proxies etc).

    // 7、往bean工厂中添加一个BeanPostProcessor -> ApplicationListenerDetector
    // ApplicationListenerDetector主要是检测bean是否实现了ApplicationListener接口
    beanFactory.addBeanPostProcessor(new ApplicationListenerDetector(applicationContext));
}

真正的注册方法是在registerBeanPostProcessors():

// org.springframework.context.support.PostProcessorRegistrationDelegate#registerBeanPostProcessors(org.springframework.beans.factory.config.ConfigurableListableBeanFactory, java.util.List<org.springframework.beans.factory.config.BeanPostProcessor>)
// 注册给定的BeanPostProcessor
private static void registerBeanPostProcessors(
    ConfigurableListableBeanFactory beanFactory, List<BeanPostProcessor> postProcessors) {

    // 遍历给定的BeanPostProcessor集合,挨个通过addBeanPostProcessor方法,向bean工厂中添加,保存到BeanFactory的beanPostProcessors成员变量中
    // private final List<BeanPostProcessor> beanPostProcessors = new CopyOnWriteArrayList<>();
    for (BeanPostProcessor postProcessor : postProcessors) {
        beanFactory.addBeanPostProcessor(postProcessor);
    }
}

具体就是循环已经注册的BeanPostProcessor集合,通过beanFactory.addBeanPostProcessor添加,保存到BeanFactory的beanPostProcessors成员变量中:

private final List<BeanPostProcessor> beanPostProcessors = new CopyOnWriteArrayList<>();

// org.springframework.beans.factory.support.AbstractBeanFactory#addBeanPostProcessor
public void addBeanPostProcessor(BeanPostProcessor beanPostProcessor) {
    Assert.notNull(beanPostProcessor, "BeanPostProcessor must not be null");
    // 如果当前beanPostProcessor已经存在,则先移除
    this.beanPostProcessors.remove(beanPostProcessor);

    // Track whether it is instantiation/destruction aware
    if (beanPostProcessor instanceof InstantiationAwareBeanPostProcessor) {
        this.hasInstantiationAwareBeanPostProcessors = true;
    }
    if (beanPostProcessor instanceof DestructionAwareBeanPostProcessor) {
        this.hasDestructionAwareBeanPostProcessors = true;
    }

    // 将beanPostProcessor添加到beanPostProcessors成员属性中
    // private final List<BeanPostProcessor> beanPostProcessors = new CopyOnWriteArrayList<>();
    this.beanPostProcessors.add(beanPostProcessor);
}

通过上述的处理,BeanPostProcessor已经完成了向bean工厂的注册工作,注意这里只是完成了注册,并没有执行BeanPostProcessor,真正执行是在bean初始化前、后。

四、BeanPostProcessor的执行过程分析

Spring IOC原理.png

上图是Spring IOC容器刷新的简图,从图中可以看到,BeanPostProcessor的执行是在bean的初始化前、后执行,bean初始化之前会执行BeanPostProcessor的postProcessBeforeInitialization()方法,bean初始化之后会调用BeanPostProcessor的postProcessAfterInitialization()方法。

我们都知道,bean的初始化执行具体是在AbstractAutowireCapableBeanFactory#initializeBean(),下面我们就从

initializeBean()方法入手,看下BeanPostProcessor是如何执行的。

protected Object initializeBean(String beanName, Object bean, @Nullable RootBeanDefinition mbd) {
    // 1、执行Aware方法,如BeanNameAware、BeanClassLoaderAware、BeanFactoryAware
    if (System.getSecurityManager() != null) {
        AccessController.doPrivileged((PrivilegedAction<Object>) () -> {
            invokeAwareMethods(beanName, bean);
            return null;
        }, getAccessControlContext());
    } else {
        invokeAwareMethods(beanName, bean);
    }

    Object wrappedBean = bean;
    if (mbd == null || !mbd.isSynthetic()) {
        // 2、执行BeanPostProcessor后置处理器的前置处理方法:postProcessBeforeInitialization(),允许对bean实例进行包装
        wrappedBean = applyBeanPostProcessorsBeforeInitialization(wrappedBean, beanName);
    }

    try {
        // 3、执行初始化方法,包括InitializingBean的afterPropertiesSet()方法、自定义的初始化方法init-method
        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()) {
        // 4、执行BeanPostProcessor后置处理器的后置处理方法:postProcessAfterInitialization(),允许对bean实例进行包装
        wrappedBean = applyBeanPostProcessorsAfterInitialization(wrappedBean, beanName);
    }

    return wrappedBean;
}

initializeBean()方法的执行流程还是很清晰的:

  • 1、执行Aware方法,如BeanNameAware、BeanClassLoaderAware、BeanFactoryAware;
  • 2、执行BeanPostProcessor后置处理器的前置处理方法:postProcessBeforeInitialization(),允许对bean实例进行包装;
  • 3、执行初始化方法,包括InitializingBean的afterPropertiesSet()方法、自定义的初始化方法init-method;
  • 4、执行BeanPostProcessor后置处理器的后置处理方法:postProcessAfterInitialization(),允许对bean实例进行包装;

从前面的代码中可以看到,BeanPostProcessor的执行确实是在bean执行初始化方法的前面、后面。

BeanPostProcessor的前置增强具体是在方法applyBeanPostProcessorsBeforeInitialization():

public Object applyBeanPostProcessorsBeforeInitialization(Object existingBean, String beanName)
    throws BeansException {

    Object result = existingBean;
    // 1、获取到当前工厂中注册的所有BeanPostProcessor后置处理器
    for (BeanPostProcessor processor : getBeanPostProcessors()) {
        // 2、执行每一个BeanPostProcessor的前置增强方法:postProcessBeforeInitialization()
        Object current = processor.postProcessBeforeInitialization(result, beanName);
        if (current == null) {
            // 3、如果postProcessBeforeInitialization()返回为空,则直接返回原始bean,将不会执行后续的BeanPostProcessor后置处理器的增强
            return result;
        }
        // 4、使用增强后的bean current,赋值给result,然后返回
        result = current;
    }
    return result;
}

BeanPostProcessor的后置增强具体是在方法applyBeanPostProcessorsAfterInitialization():

public Object applyBeanPostProcessorsAfterInitialization(Object existingBean, String beanName)
    throws BeansException {

    Object result = existingBean;
    // 1、获取到工厂中注册的所有BeanPostProcessor后置增强器
    for (BeanPostProcessor processor : getBeanPostProcessors()) {
        // 2、执行BeanPostProcessor的后置增强方法postProcessAfterInitialization()
        Object current = processor.postProcessAfterInitialization(result, beanName);
        if (current == null) {
            // 3、如果postProcessAfterInitialization()返回为空,则直接返回原始bean,将不会执行后续的BeanPostProcessor后置处理器的增强
            return result;
        }
        // 4、使用增强后的bean current,赋值给result,然后返回
        result = current;
    }
    return result;
}

上述就是BeanPostProcessor的具体执行过程,相对来说还是比较容易理解的。

五、BeanPostProcessor的常用子类和实现类

Spring中有内置的一些BeanPostProcessor实现类以及子类,例如:

  • (一)、InstantiationAwareBeanPostProcessor

InstantiationAwareBeanPostProcessor是BeanPostProcessor的子接口,可以在Bean生命周期的另外两个时期提供扩展的回调接口,即实例化Bean之前(调用postProcessBeforeInstantiation方法)和实例化Bean之后(调用postProcessAfterInstantiation方法),该接口定义如下:

public interface InstantiationAwareBeanPostProcessor extends BeanPostProcessor {

	// 1.在目标Bean实例化之前执行
    // 2.如果方法返回的是一个非空对象,将会跳过后续Spring默认的创建流程
    // 3.默认实现返回null
	@Nullable
	default Object postProcessBeforeInstantiation(Class<?> beanClass, String beanName) throws BeansException {
		return null;
	}

	// 1.在目标Bean实例化之后、属性填充前执行
    // 2.默认实现返回true
    // 3.如果方法返回false,将会跳过后续的属性填充过程,通常情况下都应该返回true
	default boolean postProcessAfterInstantiation(Object bean, String beanName) throws BeansException {
		return true;
	}

	// 允许对填充前的属性进行处理(如对属性的验证)
	@Nullable
	default PropertyValues postProcessProperties(PropertyValues pvs, Object bean, String beanName)
			throws BeansException {

		return null;
	}

	// 对属性值进行修改,通过基于原始的PropertyValues创建一个新的MutablePropertyValues实例,添加或删除特定的值
	// 已标记过期方法,在spring未来版本可能会被删除,官方推荐使用postProcessProperties()方法
    @Deprecated
	@Nullable
	default PropertyValues postProcessPropertyValues(
			PropertyValues pvs, PropertyDescriptor[] pds, Object bean, String beanName) throws BeansException {

		return pvs;
	}

}
  • (二)、ApplicationContextAwareProcessor:用来为bean注入ApplicationContext等容器对象

在postProcessBeforeInitialization()方法中通过invokeAwareInterfaces(bean)方法给目标bean注入指定的属性值:

public Object postProcessBeforeInitialization(final Object bean, String beanName) throws BeansException {
    AccessControlContext acc = null;

    if (System.getSecurityManager() != null &&
        (bean instanceof EnvironmentAware || bean instanceof EmbeddedValueResolverAware ||
         bean instanceof ResourceLoaderAware || bean instanceof ApplicationEventPublisherAware ||
         bean instanceof MessageSourceAware || bean instanceof ApplicationContextAware)) {
        acc = this.applicationContext.getBeanFactory().getAccessControlContext();
    }

    // 执行Aware接口
    if (acc != null) {
        AccessController.doPrivileged((PrivilegedAction<Object>) () -> {
            invokeAwareInterfaces(bean);
            return null;
        }, acc);
    }
    else {
        invokeAwareInterfaces(bean);
    }

    return bean;
}

private void invokeAwareInterfaces(Object bean) {
    if (bean instanceof Aware) {
        // 给bean设置Environment属性
        if (bean instanceof EnvironmentAware) {
            ((EnvironmentAware) bean).setEnvironment(this.applicationContext.getEnvironment());
        }
        // 给bean设置EmbeddedValueResolver属性
        if (bean instanceof EmbeddedValueResolverAware) {
            ((EmbeddedValueResolverAware) bean).setEmbeddedValueResolver(this.embeddedValueResolver);
        }
        // 给bean设置ResourceLoader属性
        if (bean instanceof ResourceLoaderAware) {
            ((ResourceLoaderAware) bean).setResourceLoader(this.applicationContext);
        }
        // 给bean设置ApplicationEventPublisher属性
        if (bean instanceof ApplicationEventPublisherAware) {
            ((ApplicationEventPublisherAware) bean).setApplicationEventPublisher(this.applicationContext);
        }
        // 给bean设置MessageSource属性
        if (bean instanceof MessageSourceAware) {
            ((MessageSourceAware) bean).setMessageSource(this.applicationContext);
        }
        // 给bean设置ApplicationContext属性
        if (bean instanceof ApplicationContextAware) {
            ((ApplicationContextAware) bean).setApplicationContext(this.applicationContext);
        }
    }
}
  • (三)、ApplicationListenerDetector:判断目标bean是否是ApplicationListener类型, 如果是,则添加到事件多播器中

在postProcessAfterInitialization()方法中实现了注册应用监视器功能:

public Object postProcessAfterInitialization(Object bean, String beanName) {
    if (bean instanceof ApplicationListener) {
        // potentially not detected as a listener by getBeanNamesForType retrieval
        Boolean flag = this.singletonNames.get(beanName);
        if (Boolean.TRUE.equals(flag)) {
            // singleton bean (top-level or inner): register on the fly
            this.applicationContext.addApplicationListener((ApplicationListener<?>) bean);
        }
        else if (Boolean.FALSE.equals(flag)) {
            if (logger.isWarnEnabled() && !this.applicationContext.containsBean(beanName)) {
                // inner bean with other scope - can't reliably process events
                logger.warn("Inner bean '" + beanName + "' implements ApplicationListener interface " +
                            "but is not reachable for event multicasting by its containing ApplicationContext " +
                            "because it does not have singleton scope. Only top-level listener beans are allowed " +
                            "to be of non-singleton scope.");
            }
            this.singletonNames.remove(beanName);
        }
    }
    return bean;
}
  • (四)、CommonAnnotationBeanPostProcessor:支持@Resource注解的注入
  • (五)、AutowiredAnnotationBeanPostProcessor:支持@Autowired注解的注入
  • (六)、RequiredAnnotationBeanPostProcessor:支持@Required注解的注入

六、总结

总结一下BeanFactoryPostProcessor和BeanPostProcessor的区别,看下图:

  •  1、执行时机不同

BeanFactoryPostProcessor是在bean实例化之前,也就是bean还没调用构造方法创建对象之前调用;

BeanPostProcessor是在beanbean初始化之前、初始化之后进行调用,这时候bean已经完成了实例化和属性填充;

  • 2、处理对象不同

BeanFactoryPostProcessor是BeanFactory级别的处理,是针对整个Bean的工厂进行处理;

BeanPostProcessor是bean级别的处理,针对某个具体的bean进行处理;

  • 3、使用场景不同

BeanFactoryPostProcessor允许我们在实例化任何bean之前,读取bean的定义(配置元数据),然后修改它,或者往工厂中注入更多的bean定义;

BeanPostProcessor允许我们自定义修改新的bean实例,如修改bean的属性或者给bean生成一个动态代理的对象等等;

举报

相关推荐

0 条评论