Spring BPP中如何优雅的创建动态代理Bean详解

 更新时间:2019年03月03日 16:18:49   作者:HJZ  
这篇文章主要给大家介绍了关于Spring BPP中如何优雅的创建动态代理Bean的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧

v一、前言

本文章所讲并没有基于Aspectj,而是直接通过Cglib以及ProxyFactoryBean去创建代理Bean。通过下面的例子,可以看出Cglib方式创建的代理Bean和ProxyFactoryBean创建的代理Bean的区别。

v二、基本测试代码

测试实体类,在BPP中创建BppTestDepBean类型的代理Bean。

@Component
public static class BppTestBean {
 @Autowired
 private BppTestDepBean depBean;

 public void test1() {
  depBean.testDep();
 }

 public void test2() {
  depBean.testDep();
 }

 @TestMethod
 public void test3() {
  depBean.testDep();
 }
}

@Component
public static class BppTestDepBean {
 public void testDep() {
  System.out.println("HEHE");
 }
}

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface TestMethod {
}

测试类

@RunWith(SpringRunner.class)
@SpringBootTest
public class BppTest {

 @Autowired
 private BppTestBean bppTestBean;

 @Test
 public void test() {
  bppTestBean.test1();
  bppTestBean.test2();
  bppTestBean.test3();
 }
}

v三、使用Cglib创建代理Bean

public class ProxyBpp1 implements BeanPostProcessor {
 private static final Logger LOGGER = LoggerFactory.getLogger(ProxyBpp1.class);

 @Override
 public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
  if (bean instanceof BppTestBean) {
   Enhancer enhancer = new Enhancer();
   enhancer.setSuperclass(bean.getClass());
   //标识Spring-generated proxies
   enhancer.setInterfaces(new Class[]{SpringProxy.class});
   //设置增强
   enhancer.setCallback((MethodInterceptor) (target, method, args, methodProxy) -> {
    if ("test1".equals(method.getName())) {
     LOGGER.info("ProxyBpp1 开始执行...");
     Object result = methodProxy.invokeSuper(target, args);
     LOGGER.info("ProxyBpp1 结束执行...");
     return result;
    }
    return method.invoke(target, args);
   });

   return enhancer.create();
  }
  return bean;
 }
}

主要是代理 BppTestBean的test1方法。其实这种方式创建的代理Bean使用问题的,@Autowired字段没有注入进来,所以会有出现NPE。methodProxy.invokeSuper(target, args) ,这一行代码是有问题的,targe是代理类对象,而真实的对象是postProcessBeforeInitialization(Object bean, String beanName) 中的bean对象,此时bean对象@Autowired字段已经注入了。所以可以将methodProxy.invokeSuper(target, args) 修改为method.invoke(bean, args)解决无法注入@Autowired字段的问题。

v四、使用ProxyFactoryBean创建代理Bean

public class ProxyBpp2 implements BeanPostProcessor {
 private static final Logger LOGGER = LoggerFactory.getLogger(ProxyBpp2.class);

 @Override
 public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
  if (bean instanceof BppTestBean) {
   ProxyFactoryBean pfb = new ProxyFactoryBean();
   pfb.setTarget(bean);
   pfb.setAutodetectInterfaces(false);
   NameMatchMethodPointcutAdvisor advisor = new NameMatchMethodPointcutAdvisor();
   advisor.addMethodName("test1");
   advisor.setAdvice((MethodInterceptor) invocation -> {
    LOGGER.info("ProxyBpp2 开始执行...");
    Object result = invocation.getMethod().invoke(invocation.getThis(), invocation.getArguments());
    LOGGER.info("ProxyBpp2 结束执行...");
    return result;
   });
   pfb.addAdvisor(advisor);

   return pfb.getObject();
  }
  return bean;
 }
}

使用ProxyFactoryBean创建代理Bean的时候,一定要一个targe对象的。Advisor在切入的时候,会逐个执行Advice。invocation.getThis()就是在通过ProxyFactoryBean创建代理Bean的时候传入的target对象。由于target对象就是postProcessBeforeInitialization(Object bean, String beanName) 中的bean对象,所以@Autowired字段也已经注入进来了。

v五、@Autowired注解何时被处理

想必大家都知道@Autowired字段的处理也是通过一个BPP,不过这个BPP比我们平常使用的要高级一些,它就是InstantiationAwareBeanPostProcessor。这个BPP可以实现Bean的创建、属性的注入和解析(比如@Autowired、@Value、@Resource等等),大家可以参考一下CommonAnnotationBeanPostProcessor(处理JSR-250相关注解),AutowiredAnnotationBeanPostProcessor(处理@Autowired、@Value、@Inject相关注解)。

InstantiationAwareBeanPostProcessor中有一个如下的方法,AutowiredAnnotationBeanPostProcessor就是覆盖这个方法实现了带有相关注解属性的自动注入。

@Nullable
default PropertyValues postProcessProperties(PropertyValues pvs, Object bean, String beanName)
  throws BeansException {

 return null;
}
@Override
public PropertyValues postProcessProperties(PropertyValues pvs, Object bean, String beanName) {
 InjectionMetadata metadata = findAutowiringMetadata(beanName, bean.getClass(), pvs);
 try {
  metadata.inject(bean, beanName, pvs);
 }
 catch (BeanCreationException ex) {
  throw ex;
 }
 catch (Throwable ex) {
  throw new BeanCreationException(beanName, "Injection of autowired dependencies failed", ex);
 }
 return pvs;
}

InstantiationAwareBeanPostProcessor的postProcessProperties方法实在Spring AbstractAutowireCapableBeanFactory的populateBean方法中被调用。在AbstractAutowireCapableBeanFactory的doCreateBan中有如下代码。

// Initialize the bean instance.
Object exposedObject = 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帮助我们实现。

public <T> T postProcess(T object) {
 if (object == null) {
  return null;
 }
 T result;
 try {
  // 使用容器autowireBeanFactory标准依赖注入方法autowireBean()处理 object对象的依赖注入
  this.autowireBeanFactory.autowireBean(object);
  // 使用容器autowireBeanFactory标准初始化方法initializeBean()初始化对象 object
  result = (T) this.autowireBeanFactory.initializeBean(object,
    object.toString());
 } catch (RuntimeException e) {
  Class<?> type = object.getClass();
  throw new RuntimeException(
    "Could not postProcess " + object + " of type " + type, e);
 }
 return result;
}

上图代码,可以帮组我们实现非Spring容器Bean自动注入和初始化的功能。使用过Spring security同学都知道,内部也是用了这个方式解决对象中的属性注入问题。如果你阅读了Spring security的源码,你会发现很多对象,比如WebSecurity、ProviderManager、各个安全Filter等,这些对象的创建并不是通过bean定义的形式被容器发现和注册进入spring容器的,而是直接new出来的。Spring security提供的AutowireBeanFactoryObjectPostProcessor这个工具类可以使这些对象具有容器bean同样的生命周期,也能注入相应的依赖,从而进入准备好被使用的状态。

使用Cglib在InstantiationAwareBeanPostProcessor 中创建动态代理Bean。

public class ProxyBpp3 implements InstantiationAwareBeanPostProcessor {
 private static final Logger LOGGER = LoggerFactory.getLogger(ProxyBpp3.class);

 private final AutowireCapableBeanFactory autowireBeanFactory;

 ProxyBpp3(AutowireCapableBeanFactory autowireBeanFactory) {
  this.autowireBeanFactory = autowireBeanFactory;
 }

 @Override
 public Object postProcessBeforeInstantiation(Class<?> beanClass, String beanName) throws BeansException {
  if (beanClass.equals(BppConfig.BppTestBean.class)) {
   Enhancer enhancer = new Enhancer();
   enhancer.setSuperclass(beanClass);
   //标识Spring-generated proxies
   enhancer.setInterfaces(new Class[]{SpringProxy.class});
   //设置增强
   enhancer.setCallback((MethodInterceptor) (target, method, args, methodProxy) -> {
    if ("test1".equals(method.getName())) {
     LOGGER.info("ProxyBpp3 开始执行...");
     Object result = methodProxy.invokeSuper(target, args);
     LOGGER.info("ProxyBpp3 结束执行...");
     return result;
    }
    return methodProxy.invokeSuper(target, args);
   });

   return this.postProcess(enhancer.create());
  }
  return null;
 }

 ...
}

使用ProxyFactoryBean在InstantiationAwareBeanPostProcessor 中创建动态代理Bean。

public class ProxyBpp4 implements InstantiationAwareBeanPostProcessor {
 private static final Logger LOGGER = LoggerFactory.getLogger(ProxyBpp4.class);

 private final AutowireCapableBeanFactory autowireBeanFactory;

 ProxyBpp4(AutowireCapableBeanFactory autowireBeanFactory) {
  this.autowireBeanFactory = autowireBeanFactory;
 }

 @Override
 public Object postProcessBeforeInstantiation(Class<?> beanClass, String beanName) throws BeansException {
  if (beanClass.equals(BppConfig.BppTestBean.class)) {
   ProxyFactoryBean pfb = new ProxyFactoryBean();
   pfb.setTarget(this.postProcess(BeanUtils.instantiateClass(beanClass)));
   pfb.setAutodetectInterfaces(false);
   NameMatchMethodPointcutAdvisor advisor = new NameMatchMethodPointcutAdvisor();
   advisor.addMethodName("test1");
   advisor.setAdvice((MethodInterceptor) invocation -> {
    LOGGER.info("ProxyBpp4 开始执行...");
    Object result = invocation.getMethod().invoke(invocation.getThis(), invocation.getArguments());
    LOGGER.info("ProxyBpp4 结束执行...");
    return result;
   });
   pfb.addAdvisor(advisor);

   return pfb.getObject();
  }
  return null;
 }
 ...
}

上述向两种方式,注意,实例化bean后主动通过postProcess方法借助AbstractAutowireCapableBeanFactory完成对象相关属性的注入以及对象的初始化流程。

v七、源码分享

点我查看源码,如果有任何疑问请关注公众号后进行咨询。

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对脚本之家的支持。

相关文章

  • IDEA部署Docker镜像的实现示例

    IDEA部署Docker镜像的实现示例

    本文主要介绍了IDEA部署Docker镜像的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-04-04
  • JavaEE通过response实现请求重定向

    JavaEE通过response实现请求重定向

    这篇文章主要介绍了JavaEE通过response实现请求重定向的方法,非常的简单实用,有需要的朋友可以参考下
    2014-10-10
  • SpringBoot集成Quartz实现持久化定时接口调用任务

    SpringBoot集成Quartz实现持久化定时接口调用任务

    Quartz是功能强大的开源作业调度库,几乎可以集成到任何 Java 应用程序中,从最小的独立应用程序到最大的电子商务系统,本文将通过代码示例给大家介绍SpringBoot集成Quartz实现持久化定时接口调用任务,需要的朋友可以参考下
    2023-07-07
  • MyBatis discriminator标签原理实例解析

    MyBatis discriminator标签原理实例解析

    这篇文章主要为大家介绍了MyBatis discriminator标签实现原理实例解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-02-02
  • SpringMVC源码解读之HandlerMapping

    SpringMVC源码解读之HandlerMapping

    这篇文章主要介绍了SpringMVC源码解读之HandlerMapping 的相关资料,需要的朋友可以参考下
    2016-02-02
  • IDEA 中使用 Hudi的示例代码

    IDEA 中使用 Hudi的示例代码

    这篇文章主要介绍了IDEA 中使用 Hudi的相关知识,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-06-06
  • spring mvc rest 接口选择性加密解密详情

    spring mvc rest 接口选择性加密解密详情

    这篇文章主要介绍了spring mvc rest 接口选择性加密解密详情,spring mvc rest接口以前是采用https加密的,但是现在需要更加安全的加密。而且不是对所有的接口进行加密,是对部分接口进行加密,接口返回值进行解密
    2022-07-07
  • Java 后端开发中Tomcat服务器运行不了的五种解决方案

    Java 后端开发中Tomcat服务器运行不了的五种解决方案

    tomcat是在使用Java编程语言开发服务端技术使用最广泛的服务器之一,但经常在开发项目的时候会出现运行不了的情况,这里总结出几种能解决的办法
    2021-10-10
  • Java线程池中的各个参数如何合理设置

    Java线程池中的各个参数如何合理设置

    这篇文章主要介绍了Java线程池中的各个参数如何合理设置操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-06-06
  • 如何解决Nacos服务下线报错问题

    如何解决Nacos服务下线报错问题

    这篇文章主要介绍了如何解决Nacos服务下线报错问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-07-07

最新评论