Spring BPP中如何优雅的创建动态代理Bean详解
v一、前言
本文章所讲并没有基于Aspectj，而是直接通过Cglib以及ProxyFactoryBean去创建代理Bean。通过下面的例子，可以看出Cglib方式创建的代理Bean和ProxyFactoryBean创建的代理Bean的区别。
v二、基本测试代码
测试实体类，在BPP中创建BppTestDepBean类型的代理Bean。
@Component
publicstaticclassBppTestBean{
@Autowired
privateBppTestDepBeandepBean;
publicvoidtest1(){
depBean.testDep();
}
publicvoidtest2(){
depBean.testDep();
}
@TestMethod
publicvoidtest3(){
depBean.testDep();
}
}
@Component
publicstaticclassBppTestDepBean{
publicvoidtestDep(){
System.out.println("HEHE");
}
}
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public@interfaceTestMethod{
}
测试类
@RunWith(SpringRunner.class)
@SpringBootTest
publicclassBppTest{
@Autowired
privateBppTestBeanbppTestBean;
@Test
publicvoidtest(){
bppTestBean.test1();
bppTestBean.test2();
bppTestBean.test3();
}
}
v三、使用Cglib创建代理Bean
publicclassProxyBpp1implementsBeanPostProcessor{
privatestaticfinalLoggerLOGGER=LoggerFactory.getLogger(ProxyBpp1.class);
@Override
publicObjectpostProcessBeforeInitialization(Objectbean,StringbeanName)throwsBeansException{
if(beaninstanceofBppTestBean){
Enhancerenhancer=newEnhancer();
enhancer.setSuperclass(bean.getClass());
//标识Spring-generatedproxies
enhancer.setInterfaces(newClass[]{SpringProxy.class});
//设置增强
enhancer.setCallback((MethodInterceptor)(target,method,args,methodProxy)->{
if("test1".equals(method.getName())){
LOGGER.info("ProxyBpp1开始执行...");
Objectresult=methodProxy.invokeSuper(target,args);
LOGGER.info("ProxyBpp1结束执行...");
returnresult;
}
returnmethod.invoke(target,args);
});
returnenhancer.create();
}
returnbean;
}
}
主要是代理BppTestBean的test1方法。其实这种方式创建的代理Bean使用问题的，@Autowired字段没有注入进来，所以会有出现NPE。methodProxy.invokeSuper(target,args)，这一行代码是有问题的，targe是代理类对象，而真实的对象是postProcessBeforeInitialization(Objectbean,StringbeanName)中的bean对象，此时bean对象@Autowired字段已经注入了。所以可以将methodProxy.invokeSuper(target,args)修改为method.invoke(bean,args)解决无法注入@Autowired字段的问题。
v四、使用ProxyFactoryBean创建代理Bean
publicclassProxyBpp2implementsBeanPostProcessor{
privatestaticfinalLoggerLOGGER=LoggerFactory.getLogger(ProxyBpp2.class);
@Override
publicObjectpostProcessBeforeInitialization(Objectbean,StringbeanName)throwsBeansException{
if(beaninstanceofBppTestBean){
ProxyFactoryBeanpfb=newProxyFactoryBean();
pfb.setTarget(bean);
pfb.setAutodetectInterfaces(false);
NameMatchMethodPointcutAdvisoradvisor=newNameMatchMethodPointcutAdvisor();
advisor.addMethodName("test1");
advisor.setAdvice((MethodInterceptor)invocation->{
LOGGER.info("ProxyBpp2开始执行...");
Objectresult=invocation.getMethod().invoke(invocation.getThis(),invocation.getArguments());
LOGGER.info("ProxyBpp2结束执行...");
returnresult;
});
pfb.addAdvisor(advisor);
returnpfb.getObject();
}
returnbean;
}
}
使用ProxyFactoryBean创建代理Bean的时候，一定要一个targe对象的。Advisor在切入的时候，会逐个执行Advice。invocation.getThis()就是在通过ProxyFactoryBean创建代理Bean的时候传入的target对象。由于target对象就是postProcessBeforeInitialization(Objectbean,StringbeanName)中的bean对象，所以@Autowired字段也已经注入进来了。
v五、@Autowired注解何时被处理
想必大家都知道@Autowired字段的处理也是通过一个BPP，不过这个BPP比我们平常使用的要高级一些，它就是InstantiationAwareBeanPostProcessor。这个BPP可以实现Bean的创建、属性的注入和解析（比如@Autowired、@Value、@Resource等等），大家可以参考一下CommonAnnotationBeanPostProcessor（处理JSR-250相关注解），AutowiredAnnotationBeanPostProcessor（处理@Autowired、@Value、@Inject相关注解）。
InstantiationAwareBeanPostProcessor中有一个如下的方法，AutowiredAnnotationBeanPostProcessor就是覆盖这个方法实现了带有相关注解属性的自动注入。
@Nullable
defaultPropertyValuespostProcessProperties(PropertyValuespvs,Objectbean,StringbeanName)
throwsBeansException{
returnnull;
}
@Override
publicPropertyValuespostProcessProperties(PropertyValuespvs,Objectbean,StringbeanName){
InjectionMetadatametadata=findAutowiringMetadata(beanName,bean.getClass(),pvs);
try{
metadata.inject(bean,beanName,pvs);
}
catch(BeanCreationExceptionex){
throwex;
}
catch(Throwableex){
thrownewBeanCreationException(beanName,"Injectionofautowireddependenciesfailed",ex);
}
returnpvs;
}
InstantiationAwareBeanPostProcessor的postProcessProperties方法实在SpringAbstractAutowireCapableBeanFactory的populateBean方法中被调用。在AbstractAutowireCapableBeanFactory的doCreateBan中有如下代码。
//Initializethebeaninstance.
ObjectexposedObject=bean;#
try{
populateBean(beanName,mbd,instanceWrapper);
exposedObject=initializeBean(beanName,exposedObject,mbd);
}
也就是先进行了Bean的属性填充，然后进行Bean的初始化工作。initializeBean方法中主要做了四件事。
1、invokeAwareMethods
2、applyBeanPostProcessorsBeforeInitialization
3、invokeInitMethods
4、applyBeanPostProcessorsAfterInitialization
其中2和4就是分别调用的普通的BPP中的postProcessBeforeInitialization方法和postProcessAfterInitialization方法。
这就是为什么在BPP中创建代理Bean的时候，对应的目标Bean相关的@Autowired字段已经注入的原因了。
v六、InstantiationAwareBeanPostProcessor方式创建动态代理Bean
InstantiationAwareBeanPostProcessor接口中有个postProcessBeforeInstantiation方法，可以让我们自己去实例化Bean。通过查看AbstractAutowireCapableBeanFactory，方法调用：createBean方法->resolveBeforeInstantiation方法->applyBeanPostProcessorsBeforeInstantiation方法->InstantiationAwareBeanPostProcessor#postProcessBeforeInstantiation方法，如果最终返回一个非null的实例，那么就不会再执行doCreateBean方法。这就意味着不会有Bean属性的填充和初始化的流程了，但是可以借助AbstractAutowireCapableBeanFactory帮助我们实现。
publicTpostProcess(Tobject){ if(object==null){ returnnull; } Tresult; try{ //使用容器autowireBeanFactory标准依赖注入方法autowireBean()处理object对象的依赖注入 this.autowireBeanFactory.autowireBean(object); //使用容器autowireBeanFactory标准初始化方法initializeBean()初始化对象object result=(T)this.autowireBeanFactory.initializeBean(object, object.toString()); }catch(RuntimeExceptione){ Classtype=object.getClass(); thrownewRuntimeException( "CouldnotpostProcess"+object+"oftype"+type,e); } returnresult; }
上图代码，可以帮组我们实现非Spring容器Bean自动注入和初始化的功能。使用过Springsecurity同学都知道，内部也是用了这个方式解决对象中的属性注入问题。如果你阅读了Springsecurity的源码，你会发现很多对象，比如WebSecurity、ProviderManager、各个安全Filter等，这些对象的创建并不是通过bean定义的形式被容器发现和注册进入spring容器的，而是直接new出来的。Springsecurity提供的AutowireBeanFactoryObjectPostProcessor这个工具类可以使这些对象具有容器bean同样的生命周期，也能注入相应的依赖，从而进入准备好被使用的状态。
使用Cglib在InstantiationAwareBeanPostProcessor中创建动态代理Bean。
publicclassProxyBpp3implementsInstantiationAwareBeanPostProcessor{
privatestaticfinalLoggerLOGGER=LoggerFactory.getLogger(ProxyBpp3.class);
privatefinalAutowireCapableBeanFactoryautowireBeanFactory;
ProxyBpp3(AutowireCapableBeanFactoryautowireBeanFactory){
this.autowireBeanFactory=autowireBeanFactory;
}
@Override
publicObjectpostProcessBeforeInstantiation(ClassbeanClass,StringbeanName)throwsBeansException{
if(beanClass.equals(BppConfig.BppTestBean.class)){
Enhancerenhancer=newEnhancer();
enhancer.setSuperclass(beanClass);
//标识Spring-generatedproxies
enhancer.setInterfaces(newClass[]{SpringProxy.class});
//设置增强
enhancer.setCallback((MethodInterceptor)(target,method,args,methodProxy)->{
if("test1".equals(method.getName())){
LOGGER.info("ProxyBpp3开始执行...");
Objectresult=methodProxy.invokeSuper(target,args);
LOGGER.info("ProxyBpp3结束执行...");
returnresult;
}
returnmethodProxy.invokeSuper(target,args);
});
returnthis.postProcess(enhancer.create());
}
returnnull;
}
...
}
使用ProxyFactoryBean在InstantiationAwareBeanPostProcessor中创建动态代理Bean。
publicclassProxyBpp4implementsInstantiationAwareBeanPostProcessor{
privatestaticfinalLoggerLOGGER=LoggerFactory.getLogger(ProxyBpp4.class);
privatefinalAutowireCapableBeanFactoryautowireBeanFactory;
ProxyBpp4(AutowireCapableBeanFactoryautowireBeanFactory){
this.autowireBeanFactory=autowireBeanFactory;
}
@Override
publicObjectpostProcessBeforeInstantiation(ClassbeanClass,StringbeanName)throwsBeansException{
if(beanClass.equals(BppConfig.BppTestBean.class)){
ProxyFactoryBeanpfb=newProxyFactoryBean();
pfb.setTarget(this.postProcess(BeanUtils.instantiateClass(beanClass)));
pfb.setAutodetectInterfaces(false);
NameMatchMethodPointcutAdvisoradvisor=newNameMatchMethodPointcutAdvisor();
advisor.addMethodName("test1");
advisor.setAdvice((MethodInterceptor)invocation->{
LOGGER.info("ProxyBpp4开始执行...");
Objectresult=invocation.getMethod().invoke(invocation.getThis(),invocation.getArguments());
LOGGER.info("ProxyBpp4结束执行...");
returnresult;
});
pfb.addAdvisor(advisor);
returnpfb.getObject();
}
returnnull;
}
...
}
上述向两种方式，注意，实例化bean后主动通过postProcess方法借助AbstractAutowireCapableBeanFactory完成对象相关属性的注入以及对象的初始化流程。
v七、源码分享
点我查看源码，如果有任何疑问请关注公众号后进行咨询。
总结
以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对毛票票的支持。