Spring BPP中優雅的創建動態代理Bean

一、前言

　　本文章所講並沒有基於Aspectj，而是直接通過Cglib以及ProxyFactoryBean去創建代理Bean。通過下面的例子，可以看出Cglib方式創建的代理Bean和ProxyFactoryBean創建的代理Bean的區別。

二、基本測試代碼

　　測試實體類，在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();
    }
}

三、使用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字段的問題。

四、使用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字段也已經注入進來了。

五、@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字段已經注入的原因了。

六、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完成對象相關屬性的注入以及對象的初始化流程。

七、源碼分享

　　點我查看源碼，如果有任何疑問請關注公眾號后進行咨詢。