Java动态代理

什么是代理

代理就是客户类不再直接和委托类打交道, 而是通过一个中间层来访问, 这个中间层就是代理。为啥要这样呢, 是因为使用代理有两个优势:

  1. 可以隐藏委托类的实现
  2. 可以实现客户与委托类之间的解耦, 在不修改委托类代码的情况下能够做一些额外的处理


静态代理

首先, 定义接口和接口的实现类, 然后定义接口的代理对象, 将接口的实例注入到代理对象中, 然后通过代理对象去调用真正的实现类,实现过程非常简单也比较容易理解, 静态代理的代理关系在编译期间就已经确定了的。它适合于代理类较少且确定的情况。它可实现在怒修改委托类代码的情况下做一些额外的处理,比如包装礼盒,实现客户类与委托类的解耦。


HelloService接口

public interface HelloService {
    String sayHello(String content);
}

HelloServiceImpl实现类

public class HelloServiceImpl implements HelloService {
    @Override
    public String sayHello(String content) {
        return "hello " + content;
    }
}

HelloServiceProxy代理类

public class HelloServiceProxy implements HelloService {
    private HelloService helloService;
    
    public HelloServiceProxy(HelloService helloService) {
        this.helloService = helloService;
    }
    
    @Override
    public String sayHello(String content) {
        System.out.println("before invoke");
        String result = helloService.sayHello(content);
        System.out.println("after invoke");
        
        return result;
    }
}

测试类

public class StaticProxyTest {
    public static void main(String[] args) {
        String content = "static proxy";
        HelloService helloService = new HelloServiceImpl();
        HelloServiceProxy proxy = new HelloServiceProxy(helloService);
        System.out.println(proxy.sayHello(content));
    }
}

输出结果

before invoke
after invoke
hello static proxy

JDK动态代理

在Java实现动态代理, 主要依赖java.lang.reflect包下的Proxy和InvocationHandler两个类,具体步骤如下:

  1. 创建一个实现接口InvocationHandler的类,它必须实现invoke方法
  2. 创建被代理的类以及接口
  3. 通过Proxy的newProxyInstance静态方法创建一个代理
  4. 通过代理调用方法

HelloService接口

public interface HelloService {
    String sayHello(String content);
}

HelloServiceImpl实现类

public class HelloServiceImpl implements HelloService {

    @Override
    public String sayHello(String content) {
        return "hello " + content;
    }
}

MyInvocationHandler调用器

public class MyInvocationHandler implements InvocationHandler {
    // 真实对象
    private Object obj;

    public MyInvocationHandler(Object obj) {
        this.obj = obj;
    }

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        System.out.println("before invoke......");
        // 此处通过反射,调用真实对象的相关方法
        Object result = method.invoke(obj, args);
        System.out.println("after invoke......");
        return result;
    }
}

测试类

public class DynamicProxyTest {

    public static void main(String[] args) { 
        // 通过此配置,会把生成的代理类保存在项目中
        System.setProperty("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
        String content = "dynamic proxy";
        // 创建真实实现对象
        HelloService helloService = new HelloServiceImpl();
        // 创建调用器
        InvocationHandler handler = new MyInvocationHandler(helloService);
        // 创建代理对象
        Object proxy = Proxy.newProxyInstance(helloService.getClass().getClassLoader(), helloService.getClass()
                .getInterfaces(), handler);
        System.out.println("代理类名称:" + proxy.getClass().getName());
        System.out.println("代理类接口:" + proxy.getClass().getInterfaces()[0].getName());
        // 类型转换
        HelloService proxyService = (HelloService) proxy;
        // 执行代理逻辑
        System.out.println(proxyService.sayHello(content));
    }
}

输出结果

代理类名称:com.sun.proxy.$Proxy0
代理类接口:com.sankuai.meituan.zcm.depot.proxy.HelloService
before invoke......
after invoke......
hello dynamic proxy

动态代理分析

$Proxy0代理类源码

public final class $Proxy0 extends Proxy implements HelloService {
    private static Method m1;
    private static Method m3;
    private static Method m2;
    private static Method m0;

    public $Proxy0(InvocationHandler var1) throws  {
        super(var1);
    }

    public final boolean equals(Object var1) throws  {
        try {
            return (Boolean)super.h.invoke(this, m1, new Object[]{var1});
        } catch (RuntimeException | Error var3) {
            throw var3;
        } catch (Throwable var4) {
            throw new UndeclaredThrowableException(var4);
        }
    }

    public final String sayHello(String var1) throws  {
        try {
            return (String)super.h.invoke(this, m3, new Object[]{var1});
        } catch (RuntimeException | Error var3) {
            throw var3;
        } catch (Throwable var4) {
            throw new UndeclaredThrowableException(var4);
        }
    }

    public final String toString() throws  {
        try {
            return (String)super.h.invoke(this, m2, (Object[])null);
        } catch (RuntimeException | Error var2) {
            throw var2;
        } catch (Throwable var3) {
            throw new UndeclaredThrowableException(var3);
        }
    }

    public final int hashCode() throws  {
        try {
            return (Integer)super.h.invoke(this, m0, (Object[])null);
        } catch (RuntimeException | Error var2) {
            throw var2;
        } catch (Throwable var3) {
            throw new UndeclaredThrowableException(var3);
        }
    }

    static {
        try {
            m1 = Class.forName("java.lang.Object").getMethod("equals", Class.forName("java.lang.Object"));
            m3 = Class.forName("com.sankuai.meituan.zcm.depot.proxy.HelloService").getMethod("sayHello", Class.forName("java.lang.String"));
            m2 = Class.forName("java.lang.Object").getMethod("toString");
            m0 = Class.forName("java.lang.Object").getMethod("hashCode");
        } catch (NoSuchMethodException var2) {
            throw new NoSuchMethodError(var2.getMessage());
        } catch (ClassNotFoundException var3) {
            throw new NoClassDefFoundError(var3.getMessage());
        }
    }
}

通过上述源码,动态代理关系可以理解为两层静态代理关系组合,第一层代理关系是$Proxy0和MyInvocationHandler关于invoke()方法组成的静态代理,第二层代理关系是MyInvocationHandler和HelloServiceImpl关于sayHello()方法组成的代理关系。调用流程如下:
第一层静态代理

// 创建代理类
Object proxy = Proxy.newProxyInstance(helloService.getClass().getClassLoader(), helloService.getClass().getInterfaces(), handler);

// 调用代理类sayHello()方法,底层会调用hanlder的invoke()方法
proxyService.sayHello(content)

// $Proxy0的sayHello()方法,此处的h便是创建代理类时传入的handler
public final String sayHello(String var1) throws  {
        return (String)super.h.invoke(this, m3, new Object[]{var1});
}

第二次代理

// 设置创建并真实对象
HelloService helloService = new HelloServiceImpl();
InvocationHandler handler = new MyInvocationHandler(helloService);

// MyInvocationHandler.invoke方法
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        System.out.println("before invoke......");
        // 此处调用真实对象的sayHello()方法
        Object result = method.invoke(obj, args);
        System.out.println("after invoke......");
        return result;
    }

CGLIB动态代理

CGLIB代理是针对类来实现代理的,原理是对指定的委托类生成一个子类并重写其中业务方法来实现代理。代理类对象是由Enhancer类创建的。

  1. 查找目标类上的所有非final的public类型的方法 (final 的不能被重写)
  2. 将这些方法的定义转成字节码
  3. 将组成的字节码转换成相应的代理的Class对象然后通过反射获得代理类的实例对象
  4. 实现MethodInterceptor接口, 用来处理对代理类上所有方法的请求

JDK 动态代理和 CGLIB 动态代理的区别

  • 实现方式:JDK 动态代理基于 Java 反射机制实现, 必须要实现了接口的业务类才能用这种方法生成代理对象。CGLIB 动态代理基于 ASM 框架通过生成业务类的子类来实现。
  • 实现难度:JDK 动态代理的优势是最小化依赖关系,减少依赖意味着简化开发和维护并且有 JDK 自身支持。还可以平滑进行 JDK 版本升级,代码实现简单。基于 CGLIB 框架的优势是无须实现接口,达到代理类无侵入,我们只需操作我们关系的类,不必为其它相关类增加工作量,性能比较高。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容