定义

代理模式:为其他对象提供一种代理以控制对这个对象的访问。

事例

小明是一个程序员,在公司负责项目的研发工作。有一天,客户打电话进来,沟通之后,原来客户是有个模块需求要变动一下。小明却没有应允,而是让客户去找产品经理老王沟通。

是小明偷懒不想干活吗?显然不是。我们把这个事例对应到上面的定义上,程序员小明可以映射为其他对象,产品经理老王是小明的代理。它来控制小明这个对象的访问。

动态代理类实例在内存中到底长啥样?_java

我们看上面的类图,可以简单归纳以下角色。

  • Subject 某一类主题。 比如工程师

  • Proxy 代理对象。 比如产品经理老王

  • RealSubject 真实对象。 比如程序员小明

静态代理

我们通过代码来重现上面的场景。

首先定义一个 工程师的接口,它有一个编码的方法。

  1. public interface Engineer {


  2.    void coding();

  3. }

小明是个Java码农,啊呸。是个Java工程师,要实现工程师这个接口。

  1. public class JavaEngineer implements Engineer{


  2.    private String name;


  3.    public JavaEngineer(String name){

  4.        this.name = name;

  5.    }


  6.    public void coding() {


  7.        System.out.println(name+" :正在努力的coding...");

  8.        System.out.println(name+" :终于改完了!");

  9.    }

  10. }

产品经理老王也让他实现工程师的接口。他代理了公司里的Java工程师对象,当客户有需求提出来,他要整理评估一下,当需要coding的时候,他直接转交给具体的工程师去处理。

  1. public class ProductManager implements Engineer{


  2.    private String name;

  3.    private JavaEngineer engineer;


  4.    public ProductManager(JavaEngineer engineer,String name){

  5.        this.engineer = engineer;

  6.        this.name = name;

  7.    }


  8.    public void coding() {

  9.        arrange();

  10.        engineer.coding();

  11.        appease();

  12.    }



  13.    private void arrange(){

  14.        System.out.println(this.name+":整理客户需求中...");

  15.        System.out.println(this.name+":输出需求文档,交给码农去完成!");

  16.    }


  17.    private void appease(){

  18.        System.out.println(this.name+":哎,需求变好多次了.得安抚一下这个码农才好!");

  19.    }

  20. }

我们来重现一下这个场景。

  1. //有一个美丽的Java工程师,他的名字叫小明。

  2. JavaEngineer engineer = new JavaEngineer("XiaoMing");


  3. //同样,还有一个猥琐的老王。

  4. ProductManager manager = new ProductManager(engineer,"老王");


  5. //有新需求的时候,老王负责去沟通搞定。

  6. manager.coding();


  7. System.out.println("------------------输出结果-----------------------");

  8. //老王:整理客户需求中...

  9. //老王:输出需求文档,交给码农去完成!

  10. //XiaoMing :正在努力的coding...

  11. //XiaoMing :终于改完了!

  12. //老王:哎,需求变好多次了.得安抚一下这个码农才好!

动态代理

JDK通过反射机制给我们提供了动态代理的实现,允许开发人员在运行时刻动态的创建出代理类及其对象。当使用者调用了代理对象所代理的接口中的方法的时候,这个调用的信息会被传递给InvocationHandler的invoke方法。在 invoke方法的参数中可以获取到代理对象、方法对应的Method对象和调用的实际参数。invoke方法的返回值被返回给使用者。这种做法实际上相当于对方法调用进行了拦截。

关键有两个类,Proxy和InvocationHandler 。

  • Proxy 用于生成代理类

  • InvocationHandler 用于调用目标类的方法,并且允许在调用前后插入其他的逻辑

上面的事例我们改成动态代理方式来看一下。先定义一个调用处理程序

  1. public class ProxyHandler implements InvocationHandler{


  2.    private Object target;

  3.    private String name;


  4.    public ProxyHandler(Object target,String name){

  5.        this.target = target;

  6.        this.name = name;

  7.    }



  8.    public Object invoke(Object proxy, Method method, Object[] args)throws Throwable {

  9.        arrange();

  10.        method.invoke(target, args);

  11.        appease();

  12.        return null;

  13.    }



  14.    private void arrange(){

  15.        System.out.println(this.name+":整理客户需求中...");

  16.        System.out.println(this.name+":输出需求文档,交给工程师去完成!");

  17.    }


  18.    private void appease(){

  19.        System.out.println(this.name+":哎,需求变好多次了.得安抚一下这个码农才好!");

  20.    }

  21. }

测试一下

  1. //有一个美丽的Java工程师,他的名字叫小明。

  2. Engineer engineer = new JavaEngineer("XiaoMing");


  3. //代理实例的调用处理程序

  4. ProxyHandler handler = new ProxyHandler(engineer, "老王");


  5. //返回指定接口的代理类实例,该接口可以将方法指派到指定的handler

  6. Engineer proxy = (Engineer) Proxy.newProxyInstance(Engineer.class.getClassLoader(),

  7.            new Class[]{Engineer.class}, handler);


  8. proxy.coding();


  9. System.out.println("------------------输出结果-----------------------");

  10. //老王:整理客户需求中...

  11. //老王:输出需求文档,交给码农去完成!

  12. //XiaoMing :正在努力的coding...

  13. //XiaoMing :终于改完了!

  14. //老王:哎,需求变好多次了.得安抚一下这个码农才好!

内存中的代理类实例长啥样?

我们看到,Proxy类通过静态方法newProxyInstance就生成了一个代理类的实例。先不管它是怎么样生成的,但是我想关心它到底长什么样子呢?把它拿出来看看。 JDK生成的代理类以 $Porxy开头,后面跟一个从0开始的自增长数字。比如, $Proxy0,通过下面这段代码,可以将代理类实例输出到$Proxy0.class文件中。

byte[] data = ProxyGenerator.generateProxyClass("$Proxy0",new Class[] {Engineer.class});    FileOutputStream fileOutputStream = new FileOutputStream("$Proxy0.class");fileOutputStream.write(data);fileOutputStream.close();

通过反编译class文件,得到代理类删减整理如下:

  1. public class $Proxy0 extends Proxy implements Engineer {


  2.    private static final long serialVersionUID = 1L;

  3.    private static Method m3;


  4.    protected $Proxy0(InvocationHandler h) {

  5.        //通过构造方法 把代理实例的调用处理程序传进来

  6.        super(h);

  7.    }

  8.    public final void coding() {

  9.        try {

  10.            //此处的h是父类Proxy的属性,对应的就是ProxyHandler

  11.            //invoke就相当于ProxyHandler.invoke(this, m3, null);

  12.            this.h.invoke(this, m3, null);

  13.            return;

  14.        } catch (RuntimeException localRuntimeException) {

  15.            throw localRuntimeException;

  16.        } catch (Throwable localThrowable) {

  17.            throw new UndeclaredThrowableException(localThrowable);

  18.        }

  19.    }

  20.    static {

  21.        try {

  22.            //通过反射拿到指定接口的方法

  23.            m3 = Class.forName("proxy.proxy2.Engineer").getMethod("coding",

  24.                    new Class[0]);

  25.        } catch (NoSuchMethodException localNoSuchMethodException) {

  26.            throw new NoSuchMethodError(localNoSuchMethodException.getMessage());

  27.        } catch (ClassNotFoundException localClassNotFoundException) {

  28.            throw new NoClassDefFoundError(

  29.                    localClassNotFoundException.getMessage());

  30.        }

  31.    }

  32. }

如果我们把通过反编译得到的class文件写成一个Java类,调用它同样可以实现代理功能。

Engineer engineer = new JavaEngineer("XiaoMing");ProxyHandler handler = new ProxyHandler(engineer, "老王");$Proxy0 p0 = new $Proxy0(handler);p0.coding();System.out.println("------------------输出结果-----------------------");//老王:整理客户需求中...//老王:输出需求文档,交给码农去完成!//XiaoMing :正在努力的coding...//XiaoMing :终于改完了!//老王:哎,需求变好多次了.得安抚一下这个码农才好!
总结

关于动态代理创建对象的过程,我们大概可以这样总结一下。

  • 1、通过实现InvocationHandler接口创建自己的调用处理器

  • 2、通过为Proxy类指定ClassLoader对象和一组interface创建动态代理类

  • 3、通过反射机制获取动态代理类的构造函数,其参数类型是调用处理器接口类型

  • 4、通过构造函数创建代理类实例,此时需将调用处理器对象作为参数被传入

Proxy类的newProxyInstance方法封装了2-4,只需2步就完成了代理对象的创建。 生成的代理对象集成Proxy,实现被代理对象接口。被代理对象接口的方法实际调用处理器的invoke方法,而处理器的invoke方法利用反射调用的是被代理对象的的方法 method.invoke(target,args)。