CGlib、Enhancer、ProxyFactory在springboot中的实现动态代理

基于springboot2.1.4
在springboot中对于动态代理的实现，主要通过org.springframework.cglib.proxy.Enhancer实现，主要的方式有两种：1、通过Enhancer 对目标class进行封装（EnhancerBySpringCGlib的后缀），在需要实例化时，调用newInstance，生成proxyBean（EnhancerBySpringCGlib的后缀）。2、直接通过Enhancer生成目标class的proxybean（EnhancerBySpringCGlib的后缀）
springboot的源码这两种用法表达得比较复杂，本文通过简易版的demo，呈现springboot对enhancer的使用原理。大概理解其使用方式

1、通过Enhancer 对目标class进行封装

在beandefinition阶段，对所有的bean都定义完成之后，会对@Configuration的配置类都通过Enhancer封装对应的class--->org.springframework.context.annotation.ConfigurationClassPostProcessor#enhanceConfigurationClasses

在ConfigurationClassEnhancer中实现了一些org.springframework.cglib.proxy.MethodInterceptor，调用proxyBean的方法时会通过filter对拦截的方法适配对应的MethodInterceptor。Enhancer封装对应的class需要等到org.springframework.beans.factory.support.AbstractBeanFactory#doGetBean时在org.springframework.beans.factory.support.SimpleInstantiationStrategy#instantiate处，才生成具体的proxyBean实例
简化版demo如下：

//先定义一个target class
public class TargetService {
    public void doService(){
        System.out.println("doService() TargetService");
    }

    public void testService(){
        System.out.println("testService() TargetService");
    }
}

//创建interceptor和filter
//org.springframework.cglib.proxy.MethodInterceptor
    class TestMethodInterceptor implements MethodInterceptor{

        @Override
        public Object intercept(Object obj, Method method, Object[] args, MethodProxy methodProxy) throws Throwable {
            System.out.println("before");
            Object res = methodProxy.invokeSuper(obj, args);
            System.out.println("after");
            return res;
        }
        
    }

    class TestCallbackFilter implements CallbackFilter{

        @Override
        public int accept(Method method) {
            if(method.getName().equals("doService")){
                return 0;
            }
            return 1;
        }
    }

//单元测试
    @Test
    public void test1() throws InstantiationException, IllegalAccessException {
        Enhancer enhancer = new Enhancer();
        enhancer.setSuperclass(TargetService.class);
//      enhancer.setCallbackType(TestMethodInterceptor.class);
        enhancer.setCallbackFilter(new TestCallbackFilter());//filter要比callbacks先设置
        enhancer.setCallbackTypes(new Class[]{TestMethodInterceptor.class,NoOp.class});

        Class<?> subclass = enhancer.createClass();
        Enhancer.registerCallbacks(subclass, new Callback[] {
                new TestMethodInterceptor(),NoOp.INSTANCE
        });
        System.out.println(subclass);
        TargetService obj = (TargetService) subclass.newInstance();
        obj.doService();
        obj.testService();
    }

filter返回中的数字表示的是callback列表中的下标，通过该下标调用对应的interceptor

2、直接通过Enhancer生成目标class的proxybean

这个主要体现在生成bean过程中对用@Async注解的方法对应的类进行封装的时候-->org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory#initializeBean

其中一个processor是org.springframework.scheduling.annotation.AsyncAnnotationBeanPostProcessor该processor会通过AsyncAnnotationAdvisor创建拦截器（org.aopalliance.intercept.MethodInterceptor 父类是advice，跟org.springframework.cglib.proxy.MethodInterceptor不是同一个东西）和拦截位置（pointcut 定位使用了@Async的方法）
通过org.springframework.aop.framework.AbstractAdvisingBeanPostProcessor#postProcessAfterInitialization生成ProxyBean
当一个bean时proxyFactory.getProxy(getProxyClassLoader());主要通过org.springframework.aop.framework.DefaultAopProxyFactory#createAopProxy

然后通过org.springframework.aop.framework.CglibAopProxy#getProxy(java.lang.ClassLoader)获取代理实例

其中有个org.springframework.aop.framework.CglibAopProxy.DynamicAdvisedInterceptor (implements org.springframework.cglib.proxy.MethodInterceptor)会通过链式调用的方式，对advisor中的advice（实际上以org.aopalliance.intercept.MethodInterceptor方式存在）进行调用，具体代码不分析了，可参考此处，大致的调用方式以简单demo呈现(原理类似，但是spring的封装要复杂很多)

package com.eshin.autotest;

import org.aopalliance.intercept.MethodInvocation;
import org.junit.Before;
import org.junit.Test;
import org.springframework.cglib.proxy.*;

import java.lang.reflect.AccessibleObject;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;

/**
 * @author Eshin
 * @title: TestInterceptorChain
 * @projectName pay
 * @date 2019/6/2619:38
 */
public class TestInterceptorChain {
    @Before
    public void setUp() throws Exception {
    }

    @Test
    public void name() {
    }

    @Test
    public void test() {
        Enhancer enhancer = new Enhancer();
        enhancer.setSuperclass(TargetService.class);
        Callback callbacks[] = new Callback[] {new TestMethodInterceptor(), NoOp.INSTANCE};

        enhancer.setCallbacks(callbacks);

        enhancer.setCallbackFilter(new CallbackFilter() {
            @Override
            public int accept(Method method) {
                if(method.getName().equals("testService")){
                    return 0;
                }
                return 1;
            }
        });
        TargetService proxyBean =   (TargetService)enhancer.create();
        proxyBean.doService();
        proxyBean.testService();
    }

    class TestMethodInterceptor implements MethodInterceptor{

        @Override
        public Object intercept(Object obj, Method method, Object[] args, MethodProxy methodProxy) throws Throwable {
            System.out.println("before");
//            Object res = methodProxy.invokeSuper(obj, args);
            AdviceChainMethodInvocation ac = new AdviceChainMethodInvocation(methodProxy, obj, args);
            ac.addChain(new TestAdviceInterceptor());
            ac.addChain(new TestAdviceInterceptor2());
            Object res = ac.proceed();
            System.out.println("after");
            return res;
        }

    }

    class TestAdviceInterceptor implements org.aopalliance.intercept.MethodInterceptor{
        @Override
        public Object invoke(MethodInvocation invocation) throws Throwable {
            System.out.println("before TestAdviceInterceptor advice");
            Object rsp = invocation.proceed();
            System.out.println("after TestAdviceInterceptor advice");
            return rsp;
        }
    }
    class TestAdviceInterceptor2 implements org.aopalliance.intercept.MethodInterceptor{
        @Override
        public Object invoke(MethodInvocation invocation) throws Throwable {
            System.out.println("before TestAdviceInterceptor2 advice");
            Object rsp = invocation.proceed();
            System.out.println("after TestAdviceInterceptor2 advice");
            return rsp;
        }
    }

    class AdviceChainMethodInvocation implements MethodInvocation {
        List<org.aopalliance.intercept.MethodInterceptor> chain = new ArrayList<>();
        int index = 0;

        Object targetMethod = null;
        Object proxy = null;
        Object[] args = null;
        public AdviceChainMethodInvocation(Object targetMethod, Object proxy, Object[]args){
            this.targetMethod = targetMethod;
            this.proxy = proxy;
            this.args = args;
        }

        public void addChain(org.aopalliance.intercept.MethodInterceptor ir){
            chain.add(ir);
        }
        public Object proceed() throws Throwable {
            Object result = null;
            if(index < chain.size()){
                index +=1;
                result = chain.get(index-1).invoke(this);
                return result;
            }
            return ((MethodProxy)this.targetMethod).invokeSuper(this.proxy,this.args);
        }

        @Override
        public Object getThis() {
            return null;
        }

        @Override
        public AccessibleObject getStaticPart() {
            return null;
        }

        @Override
        public Method getMethod() {
            return null;
        }

        @Override
        public Object[] getArguments() {
            return new Object[0];
        }
    }
}

注意：Enhancer有个硬伤，就是无法对已经封装过的targetclass，再继续封装多一次，无法实现多个interceptor的链式调用。

3、再来看看ProxyFactory

ProxyFactory总是和Enhaner的使用同时出现，在ScopeProxyFactoryBean和@Async的解析都有用到
先看一个简单例子

public interface IService {
    void doService();
}
public interface IWork {
    void doWork();
}

public class TargetService {
    public void doService(){
        System.out.println("doService() TargetService");
    }

    public void testService(){
        System.out.println("testService() TargetService");
    }
}

public class TargetService1 implements IService, IWork {

    public void doService(){
        System.out.println("doService() TargetService1");
    }

    public void testService(){
        System.out.println("testService() TargetService1");
    }

    @Override
    public void doWork() {
        System.out.println("doWork() TargetService1");
    }
}


    @Test
    public void testProxyFactory(){
        ProxyFactory pf = new ProxyFactory();
        pf.setTarget(new TargetService());
        pf.addAdvice(new TestAdviceInterceptor());
        pf.addAdvice(new TestAdviceInterceptor2());
        TargetService targetService = (TargetService) pf.getProxy();
        targetService.testService();
    }
    @Test
    public void testProxyFactory1(){
        ProxyFactory pf = new ProxyFactory();
        pf.setTarget(new TargetService1());
        pf.addAdvice(new TestAdviceInterceptor());
        pf.addAdvice(new TestAdviceInterceptor2());
        TargetService1 targetService = (TargetService1) pf.getProxy();
        targetService.testService();
        targetService.doService();
        targetService.doWork();
        System.out.println("==========================");
        pf.addInterface(IWork.class);//指定能代理的接口，指定后代理的对象只能转换成对应接口对象
        IWork work = (IWork) pf.getProxy();
        work.doWork();
    }

f.getProxy()的逻辑可以参考这里第2点

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 204,293评论 6赞 478
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 85,604评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 150,958评论 0赞 337
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,729评论 1赞 277
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,719评论 5赞 366
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,630评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,000评论 3赞 397
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,665评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,909评论 1赞 299
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,646评论 2赞 321
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,726评论 1赞 330
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,400评论 4赞 321
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,986评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,959评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,197评论 1赞 260
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 44,996评论 2赞 349
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,481评论 2赞 342