设计模式-静态代理与动态代理

  • 静态代理: 由程序员创建或工具生成代理类的源码,再编译代理类。所谓静态也就是在程序运行前就已经存在代理类的字节码文件,代理类和委托类的关系在运行前就确定了。
  • 动态代理: 在实现阶段不用关心代理类,而在运行阶段才指定哪一个对象。

情境

假设,有个汽车类具有移动停止两个方法,我们要怎么在不改动源码的情况下:

1.添加日志

2.添加事务

IMovable.java

public interface IMovable {
    void move();

    void stop();
}

Car.java

public class Car implements IMovable {

    @Override
    public void move() {
        System.out.println("汽车移动");
    }

    @Override
    public void stop() {
        System.out.println("汽车停止");
    }
}

静态代理

继承

1.添加日志

CarLog.java

public class CarLog extends Car {
    @Override
    public void move() {
        System.out.println("开始执行move");
        super.move();
        System.out.println("执行move完成");
    }

    @Override
    public void stop() {
        System.out.println("开始执行stop");
        super.stop();
        System.out.println("执行stop完成");
    }
}

Client.java

public class Client {
    public static void main(String[] args) {
        IMovable log = new CarLog();
        log.move();
        log.stop();
    }
}
  • 从上面的代码可以看出,我们定义了一个类并且继承于Car
  • 重写父类中的方法,在super(调用父类中的方法)前后加入打印日志的代码

运行截图:

静态代理_继承_日志.png

2.添加事务

CarTransaction.java

public class CarTransaction extends Car {
    @Override
    public void move() {
        System.out.println("move事务开始");
        super.move();
        System.out.println("move事务提交");
    }

    @Override
    public void stop() {
        System.out.println("stop事务开始");
        super.stop();
        System.out.println("stop事务提交");
    }
}

运行结果:

静态代理_继承_事务.png
  • 很明显,对于事务的做法与日志的做法一致

3.先添加日志再开启事务

CarLog2Trans.java

public class CarLog2Trans extends CarTransaction{
    @Override
    public void move() {
        System.out.println("开始执行move");
        super.move();
        System.out.println("执行move完成");
    }

    @Override
    public void stop() {
        System.out.println("开始执行stop");
        super.stop();
        System.out.println("执行stop完成");
    }
}

运行结果:

静态代理_继承_先日志后事务.png

4.先开启事务再添加日志

CarTrans2Log.java

public class CarTrans2Log extends CarLog {
    @Override
    public void move() {
        System.out.println("move事务开始");
        super.move();
        System.out.println("move事务提交");
    }

    @Override
    public void stop() {
        System.out.println("stop事务开始");
        super.stop();
        System.out.println("stop事务提交");
    }
}

运行结果:

静态代理_继承_先事务后日志.png
  • 从上面代码可以看出如果我们添加功能的话,就要创建新的类

情境: 有四辆汽车A,B,C,D,A汽车要做到先添加日志再开启事务,B汽车要做到先开启事务再添加日志,C汽车只需要添加日志,D汽车只需要开启事务

显然为了完成这样的功能使用继承的方式,我们必须要有四个类才能完成,哪有没有更好的方式呢?

接口(聚合)

1.添加日志

CarLogProxy.java

public class CarLogProxy implements IMovable {
    private IMovable movable;

    public CarLogProxy(IMovable movable) {
        this.movable = movable;
    }

    @Override
    public void move() {
        System.out.println("开始执行move");
        movable.move();
        System.out.println("执行move完成");
    }

    @Override
    public void stop() {
        System.out.println("开始执行stop");
        movable.stop();
        System.out.println("执行stop完成");
    }
}

Client.java

public class Client {
    public static void main(String[] args) {
        IMovable movable = new Car();
        IMovable log = new CarLogProxy(movable);
        log.move();
        log.stop();
    }
}
  • 从上面的代码可以看出,我们实现了IMovable接口(目标接口),并传入了需要被代理的对象

2.添加事务

CarTransactionProxy.java

public class CarTransactionProxy implements IMovable {
private IMovable movable;

public CarTransactionProxy(IMovable movable) {
    this.movable = movable;
}

@Override
public void move() {
    System.out.println("move事务开始");
    movable.move();
    System.out.println("move事务提交");
}

@Override
public void stop() {
    System.out.println("stop事务开始");
    movable.stop();
    System.out.println("stop事务提交");
}

}

Client.java

public class Client {
    public static void main(String[] args) {
        IMovable movable = new Car();
        IMovable transaction = new CarTransactionProxy(movable);
        transaction.move();
        transaction.stop();
    }
}

3.先添加日志再开启事务

Client.java

public class Client {
    public static void main(String[] args) {
        IMovable movable = new Car();
        IMovable transaction = new CarTransactionProxy(movable);
        IMovable log = new CarLogProxy(transaction);
        log.move();
        log.stop();
    }
}

4.先开启事务再添加日志

Client.java

public class Client {
    public static void main(String[] args) {
        IMovable movable = new Car();
        IMovable log = new CarLogProxy(movable);
        IMovable transaction = new CarTransactionProxy(log);
        transaction.move();
        transaction.stop();
    }
}
  • 从3与4的Client可以看出,使用聚合的办法就只要用两个类就能实现需求
  • 显然,使用实现目标接口的方式进行代理,让代理和被代理对象之间都可以相互灵活转换
  • 所以一般静态代理使用聚合的方式进行实现,使用继承的方式多多少少有些过于笨重

想必认真的人都看的出来,静态代理的方式随着功能的增多,必然要生成更多的代理对象,这样不利于维护。而且,就目前的要求来看,对 move()stop() 两个方法添加日志,其中代码出现了冗余的情况,无法复用。那么有什么方式可以解决呢?

动态代理

Client.java

public class Client {
    public static void main(String[] args) {
        IMovable movable = new Car();
        IMovable logProxy = (IMovable) Proxy.newProxyInstance(Car.class.getClassLoader(), Car.class.getInterfaces(),
                new InvocationHandler() {
                    @Override
                    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                        System.out.println("开始执行" + method.getName());
                        Object invoke =method.invoke(movable, args);
                        System.out.println("执行" + method.getName() + "完成");
                        return invoke;
                    }
                });
        logProxy.move();
        logProxy.stop();
        
        System.out.println();

        IMovable transProxy = (IMovable) Proxy.newProxyInstance(Car.class.getClassLoader(), Car.class.getInterfaces(),
                new InvocationHandler() {
                    @Override
                    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                        System.out.println(method.getName() + "开启事务");
                        Object invoke = method.invoke(logProxy, args);
                        System.out.println(method.getName() + "事务提交");
                        return invoke;
                    }
                });
        transProxy.move();
        transProxy.stop();
    }
}

运行结果:

动态代理.PNG
  • 从运行结果来看,我们使用动态代理实现了上面静态代理的例子,且没有编写多余的类
  • 从上面的代码可以看出,要使用动态代理就必须要有目标接口
  • InvocationHandler 的方法中可以获取要执行的 Method 实例
  • 通过 Method 的实例可以通过反射来执行,不过要传入被代理对象
  • 在反射前后可以进行添加日志和事务的操作
  • 而且也可以灵活的让进行代理对象与被代理对象之间的转换
  • 由于使用了反射,对性能有一定的损耗

动态代理源码解析

对于动态代理的源码其实最重要的就是下面两个方法,我们下面开始对他们进行深入分析,做到知其然知其所以然。

Proxy.newProxyInstance 部分代码

 public static Object newProxyInstance(ClassLoader loader,
                                      Class<?>[] interfaces,
                                      InvocationHandler h)
    throws IllegalArgumentException
{
     ...
     
     Class<?> cl = getProxyClass0(loader, intfs);
     try {
        ...
        
        final Constructor<?> cons = cl.getConstructor(constructorParams);
        final InvocationHandler ih = h;
        ...
        

            return cons.newInstance(new Object[]{h});
        }catch (IllegalAccessException|InstantiationException e) {
        throw new InternalError(e.toString(), e);
        }
        ...
        
}
  • loader 定义代理类的类加载器
  • interfaces 代理类要实现的接口列表
  • h 指派方法调用的调用处理程序(注:动态代理的关键)
  • 将其他多余的部分代码忽略,找核心的代码(因为有些偏底层我也看不懂 -.- )
  • getProxyClass0(loader, intfs); 获得代理类
  • cl.getConstructor(constructorParams); 获得代理类的构造方法
  • cons.newInstance(new Object[]{h}); 反射生成代理对象,并传入 InvocationHandler

所以我们往下看看它是如何得到代理对象的

Proxy.getProxyClass0 代码

    private static final WeakCache<ClassLoader, Class<?>[], Class<?>>
    proxyClassCache = new WeakCache<>(new KeyFactory(), new ProxyClassFactory());

    
    private static Class<?> getProxyClass0(ClassLoader loader,
                                       Class<?>... interfaces) {
    if (interfaces.length > 65535) {
        throw new IllegalArgumentException("interface limit exceeded");
    }

    // If the proxy class defined by the given loader implementing
    // the given interfaces exists, this will simply return the cached copy;
    // otherwise, it will create the proxy class via the ProxyClassFactory
    return proxyClassCache.get(loader, interfaces);
  • 注释翻译: 如果存在给定接口的给定装入器定义的代理类存在,则只返回缓存的副本;否则,它将通过proxyclassfactory创建代理类

所以我们就要进一步分析 (proxyClassCache)WeakCache 类是怎么进行缓存的。(个人能力有限对于WeakCache还有较多疑惑,之后会进行总结更新)

学习资料:

https://www.cnblogs.com/liuyun1995/p/8144676.html

//www.greatytc.com/p/9f5566b5e7fb


知道了是得到创建代理类,我们继续往下分析

InvocationHandler.java

public Object invoke(Object proxy, Method method, Object[] args) throws Throwable;
  • proxy 在其上调用方法的代理实例
  • method 对应于在代理实例上调用的接口方法的 Method 实例,目标对象被调用的方法
  • args 包含传入代理实例上方法调用的参数值的对象数组

InvocationHandler用来连接代理对象与目标对象

分析代理类对象
我们可以使用如下代码获取代理类$Proxy0.class文件

        public static void main(String[] args) {
    System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
    System.out.println("$Proxy0.class: "+Proxy.getProxyClass(Inter.class.getClassLoader(), Inter.class));   
    //
    IMovable movable = new Car();
    IMovable logProxy = (IMovable) Proxy.newProxyInstance(Car.class.getClassLoader(), Car.class.getInterfaces(),
            new InvocationHandler() {
                @Override
                public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                    System.out.println("开始执行" + method.getName());
                    Object invoke =method.invoke(movable, args);
                    System.out.println("执行" + method.getName() + "完成");
                    return invoke;
                }
            });
    logProxy.move();
    logProxy.stop();
}

运行结果:

获取$Proxy0.class文件运行截图.png
  • System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true"); 打开保存开关
  • System.out.println("$Proxy0.class全名: "+Proxy.getProxyClass(IMovable.class.getClassLoader(), IMovable.class)); 可以通过打印信息获取class在项目中路径
  • 关于这个类是如何生成的,需要往下跟踪 Proxy.getProxyClass0方法中的proxyClassCache.get(loader, interfaces),这与缓存相挂钩未进行详细分析(之后还会更新文章)。

在得到 $Proxy0.class 之后我们可以使用一些工具将class进行反编译,这里我使用了JD_GUI

$Proxy0.java部分代码

public final class $Proxy0
  extends Proxy
  implements IMovable
{
  private static Method m1;
  private static Method m4;
  private static Method m2;
  private static Method m3;
  private static Method m0;
  
  public $Proxy0(InvocationHandler paramInvocationHandler)
    throws 
  {
    super(paramInvocationHandler);
  }
  
  ...
  
  public final void move()
    throws 
  {
    try
    {
      this.h.invoke(this, m4, null);
      return;
    }
    catch ...
  }
  

  
  public final void stop()
    throws 
  {
    try
    {
      this.h.invoke(this, m3, null);
      return;
    }
    catch ...
  }
  
    ...
  
  static
  {
    try
    {
      m1 = Class.forName("java.lang.Object").getMethod("equals", new Class[] { Class.forName("java.lang.Object") });
      m4 = Class.forName("com.zzz.proxy.IMovable").getMethod("move", new Class[0]);
      m2 = Class.forName("java.lang.Object").getMethod("toString", new Class[0]);
      m3 = Class.forName("com.zzz.proxy.IMovable").getMethod("stop", new Class[0]);
      m0 = Class.forName("java.lang.Object").getMethod("hashCode", new Class[0]);
      return;
    }
    catch ...
  }
}

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

推荐阅读更多精彩内容

  • 参考资料:菜鸟教程之设计模式 设计模式概述 设计模式(Design pattern)代表了最佳的实践,通常被有经验...
    Steven1997阅读 1,167评论 1 12
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,601评论 18 139
  • 还记得初中的一个冬天,老爸给我2元钱去买红萝卜,我在去菜市场的路上碰到一个骑着三轮车的菜贩子。 他卖的红萝卜是一元...
    韦哥说道阅读 1,435评论 0 0
  • 荆棘鸟生而寻刺,途远而不知疲倦 棘刺深扎而泣血,超脱痛苦而放歌 奏极美之曲,曲终而命竭 羞云雀与夜莺,感上帝于苍穹...
    葱葱王阅读 620评论 0 3