动态代理

设计模式

Posted by Jesse on December 12, 2018

[TOC]

Java动态代理机制

1.静态代理

代理模式上,基本上有Subject角色,RealSubject角色,Proxy角色。 Subject:负责定义RealSubject和Proxy角色应该实现的接口; RealSubject:用来真正完成业务服务功能; Proxy:负责将自身的Request请求,调用realsubject 对应的request功能来实现业务功能,自己不真正做业务。

当在代码阶段规定这种代理关系,Proxy类通过编译器编译成class文件,当系统运行时,此class已经存在了。这种静态的代理模式固然在访问无法访问的资源,增强现有的接口业务功能方面有很大的优点,但是大量使用这种静态代理,会使我们系统内的类的规模增大,并且不易维护;并且由于Proxy和RealSubject的功能 本质上是相同的,Proxy只是起到了中介的作用,这种代理在系统中的存在,导致系统结构比较臃肿和松散。

2.运行期生成二进制字节码

Java编译器编译好Java文件之后,产生.class 文件在磁盘中。这种class文件是二进制文件,内容是只有JVM虚拟机能够识别的机器码。JVM虚拟机读取字节码文件,取出二进制数据,加载到内存中,解析.class 文件内的信息,生成对应的 Class对象:

由于JVM通过字节码的二进制信息加载类的,那么,如果我们在运行期系统中,遵循Java编译系统组织.class文件的格式和结构,生成相应的二进制数据,然后再把这个二进制数据加载转换成对应的类,这样,就完成了在代码中,动态创建一个类的能力了。

在运行时期可以按照Java虚拟机规范对class文件的组织规则生成对应的二进制字节码。当前有很多开源框架可以完成这些功能,如ASMJavassist

JDK的InvocationHandler

代理类处理的逻辑很简单:在调用某个方法前及方法后做一些额外的业务。换一种思路就是:在触发(invoke)真实角色的方法之前或者之后做一些额外的业务。那么,为了构造出具有通用性和简单性的代理类,可以将所有的触发真实角色动作交给一个触发的管理器,让这个管理器统一地管理触发。这种管理器就是Invocation Handler。

动态代理模式的结构跟上面的静态代理模式稍微有所不同,多引入了一个InvocationHandler角色。

动态代理工作的基本模式就是将自己的方法功能的实现交给 InvocationHandler角色,外界对Proxy角色中的每一个方法的调用,Proxy角色都会交给InvocationHandler来处理,而InvocationHandler则调用具体对象角色的方法。如下图所示:

在这种模式之中:代理Proxy 和RealSubject 应该实现相同的功能。

在面向对象的编程之中,如果我们想要约定Proxy 和RealSubject可以实现相同的功能,有两种方式:

a.一个比较直观的方式,就是定义一个功能接口,然后让Proxy 和RealSubject来实现这个接口。 b.还有比较隐晦的方式,就是通过继承。因为如果Proxy 继承自RealSubject,这样Proxy则拥有了RealSubject的功能,Proxy还可以通过重写RealSubject中的方法,来实现多态。

JDK的动态代理创建机制—-通过接口

为RealSubject这个类创建一个动态代理对象,JDK主要会做以下工作:

1.获取 RealSubject上的所有接口列表; 2.确定要生成的代理类的类名,默认为:com.sun.proxy.$ProxyXXXX ; 3.根据需要实现的接口信息,在代码中动态创建 该Proxy类的字节码; 4.将对应的字节码转换为对应的class 对象; 5.创建InvocationHandler 实例handler,用来处理Proxy所有方法调用; 6.Proxy 的class对象 以创建的handler对象为参数,实例化一个proxy对象

JDK通过 java.lang.reflect.Proxy包来支持动态代理,Proxy这个类的作用就是用来动态创建一个代理对象的类,它提供了许多的方法,但是我们用的最多的就是 newProxyInstance 这个方法:

1
2
newProxyInstance(ClassLoader loader,Class<?>[] interfaces,InvocationHandler h)
返回一个指定接口的代理类实例,该接口可以将方法调用指派到指定的调用处理程序。

loader:  一个ClassLoader对象,定义了由哪个ClassLoader对象来对生成的代理对象进行加载 interfaces:  一个Interface对象的数组,表示的是我将要给我需要代理的对象提供一组什么接口,如果我提供了一组接口给它,那么这个代理对象就宣称实现了该接口(多态),这样我就能调用这组接口中的方法了 h:  一个InvocationHandler对象,表示的是当我这个动态代理对象在调用方法的时候,会关联到哪一个InvocationHandler对象上

而对于InvocationHandler,我们需要实现下列的invoke方法: 在调用代理对象中的每一个方法时,在代码内部,都是直接调用了InvocationHandler 的invoke方法,而invoke方法根据代理类传递给自己的method参数来区分是什么方法。

1
2
invoke(Object proxy,Method method,Object[] args)
          在代理实例上处理方法调用并返回结果。

proxy:  指代我们所代理的那个真实对象 method:  指代的是我们所要调用真实对象的某个方法的Method对象 args:  指代的是调用真实对象某个方法时接受的参数

JDK动态代理示例

1
2
3
public interface Rechargable {
    public void recharge();
}
1
2
3
public interface Vehicle {
    public void drive();
}
1
2
3
4
5
6
7
8
9
10
11
12
public class ElectricCar implements Rechargable,Vehicle {
    @Override
    public void recharge() {
        System.out.println("Electric Car is Recharging...");
    }

    @Override
    public void drive() {
        System.out.println("Electric Car is Moving silently...");

    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
public class InvocationHandlerImpl implements InvocationHandler {
    private ElectricCar car;

    public InvocationHandlerImpl(ElectricCar car)
    {
        this.car=car;
    }

    @Override
    public Object invoke(Object proxy, Method paramMethod, Object[] args) throws Throwable {
        System.out.println("You are going to invoke "+paramMethod.getName()+" ...");
        paramMethod.invoke(car, null);
        System.out.println(paramMethod.getName()+" invocation Has Been finished...");
        return null;
    }
}

运行结果

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
public class ProxyUtils {
    /**
	 * 将根据类信息 动态生成的二进制字节码保存到硬盘中,
	 * 默认的是clazz目录下
         * params :clazz 需要生成动态代理类的类
         * proxyName : 为动态生成的代理类的名称
         */
    public static void generateClassFile(Class clazz,String proxyName)
    {
        //根据类信息和提供的代理类名称,生成字节码
        byte[] classFile = ProxyGenerator.generateProxyClass(proxyName, clazz.getInterfaces());
        String paths = clazz.getResource(".").getPath();
        System.out.println(paths);
        FileOutputStream out = null;

        try {
            //保留到硬盘中
            out = new FileOutputStream(paths+proxyName+".class");
            out.write(classFile);
            out.flush();
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            try {
                out.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }

    public static void main(String[] args) {
        ElectricCar electricCar = new ElectricCar();
        ProxyUtils.generateClassFile(electricCar.getClass(), "ElectricCarProxy");
    }
}

IDEA自带反编译工具,得到ElectricCarProxy.class 文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
/**
 生成的动态代理类的组织模式是继承Proxy类,然后实现需要实现代理的类上的所有接口,而在实现的过程中,则是通过将所有的方法都交给了InvocationHandler来处理
*/
public final class ElectricCarProxy extends Proxy implements Rechargable, Vehicle {
    private static Method m1;
    private static Method m3;
    private static Method m2;
    private static Method m4;
    private static Method m0;

    public ElectricCarProxy(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 void recharge() throws  {
        try {
        // 方法功能实现交给InvocationHandler处理
            super.h.invoke(this, m3, (Object[])null);
        } catch (RuntimeException | Error var2) {
            throw var2;
        } catch (Throwable var3) {
            throw new UndeclaredThrowableException(var3);
        }
    }

    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 void drive() throws  {
        try {
            super.h.invoke(this, m4, (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 {
    //为每一个需要方法对象,当调用相应的方法时,分别将方法对象作为参数传递InvocationHandler处理
        try {
            m1 = Class.forName("java.lang.Object").getMethod("equals", Class.forName("java.lang.Object"));
            m3 = Class.forName("DProxy.Rechargable").getMethod("recharge");
            m2 = Class.forName("java.lang.Object").getMethod("toString");
            m4 = Class.forName("DProxy.Vehicle").getMethod("drive");
            m0 = Class.forName("java.lang.Object").getMethod("hashCode");
        } catch (NoSuchMethodException var2) {
            throw new NoSuchMethodError(var2.getMessage());
        } catch (ClassNotFoundException var3) {
            throw new NoClassDefFoundError(var3.getMessage());
        }
    }
}

生成的动态代理类有几个特点:

1.继承自 java.lang.reflect.Proxy,实现了 Rechargable,Vehicle 这两个ElectricCar实现的接口; 2.类中的所有方法都是final 的; 3.所有的方法功能的实现都统一调用了InvocationHandler的invoke()方法。

调用代理对象的时候,代理对象会触发传入的InvocationHandler方法中的invoke()方法, 即:

将执行功能的权利转交给了InvocationHandler, 而InvocationHandler通过method参数,来就具体区分是什么方法,进而进行相应的处理。一般情况下InvocationHandler的invoke()方法体内,会调用method.invoke()方法来调用具体对象的对应method

cglib 生成动态代理类的机制—-通过类继承:

“CGLIB(Code Generation Library),是一个强大的,高性能,高质量的Code生成类库,它可以在运行期扩展Java类与实现Java接口。

cglib 创建某个类A的动态代理类的模式是:

  1. 查找A上的所有非final 的public类型的方法定义; 2.   将这些方法的定义转换成字节码; 3.   将组成的字节码转换成相应的代理的class对象; 4.   实现 MethodInterceptor接口,用来处理 对代理类上所有方法的请求(这个接口和JDK动态代理InvocationHandler的功能和角色是一样的)