Java动态代理

Java动态代理介绍

代理模式是常用的java设计模式，它的特征是代理类与委托类有同样的接口，代理类主要负责为委托类预处理消息、过滤消息、把消息转发给委托类，以及事后处理消息等。代理类与委托类之间通常会存在关联关系，一个代理类的对象与一个委托类的对象关联，代理类的对象本身并不真正实现服务，而是通过调用委托类的对象的相关方法，来提供特定的服务。

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

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

JDK方式实现动态代理

JDK为RealSubject对象创建动态代理对象，主要做了以下工作：

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

JDK通过java.lang.reflect.Proxy来支持动态代理，一般情况下，使用方法newProxyInstanceof来创建Proxy类，而对于InvocationHandler，需要实现它的invoke方法，在调用代理对象中的每一个方法时，在代码内部，都是直接调用了InvocationHandler的invoke方法，而invoke方法根据代理类传递给自己的method参数来区分是什么方法。

实例如下：

Download.java

public interface Downloader {
    public void downloadImage(String imageURL, String filename) throws Throwable;
}

Subject.java

import java.io.*;
import java.net.URL;
import java.net.URLConnection;
public class Subject implements Downloader {
    public void downloadImage(String imageURL, String filename) throws Throwable {
        System.out.println("Downloading image from " + imageURL + " to " + filename + "...");
        URL url = new URL(imageURL);
        URLConnection con = url.openConnection();
        BufferedInputStream bis = new BufferedInputStream(con.getInputStream());
        BufferedOutputStream bos = new BufferedOutputStream(new FileOutputStream(filename));
        byte[] buff = new byte[4096];
        int length;
        while ((length = bis.read(buff)) != -1) {
            bos.write(buff, 0, length);
        }
        bis.close();
        bos.close();
    }
}

ProxyHander.java

import java.lang.reflect.*;
public class ProxyHander implements InvocationHandler {
    private Object proxiedObj;
    public ProxyHander(Object obj) {
        super();
        proxiedObj = obj;
    }
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        long start = System.currentTimeMillis();
        Object result = method.invoke(proxiedObj, args);
        long end   = System.currentTimeMillis();
        System.out.println(method.getName() + " cost " + (end - start) + " ms...");
        return result;
    }
}

Main.java

import java.lang.reflect.Proxy;
public class Main {
    public static void main(String[] args) throws Throwable {
        ProxyHander proxyHander = new ProxyHander(new Subject());
        Downloader proxy = (Downloader) Proxy.newProxyInstance(Subject.class.getClassLoader(), Subject.class.getInterfaces(), proxyHander);
        proxy.downloadImage("http://202.114.96.204/cache/9/04/cankaoxiaoxi.com/df328181a0da90521ad4da4ad30f8d35/1496884353332.jpg", "image.jpg");
    }
}

输出结果

Downloading image from http://202.114.96.204/cache/9/04/cankaoxiaoxi.com/df328181a0da90521ad4da4ad30f8d35/1496884353332.jpg to image.jpg...
downloadImage cost 125 ms...

cglib实现动态代理

JDK中提供的生成动态代理类的机制有个鲜明的特点是： 某个类必须有实现的接口，而生成的代理类也只能代理某个类接口定义的方法，果某个类没有实现接口，那么这个类就不能同JDK产生动态代理了！CGLIB（Code Generation Library），是一个强大的，高性能，高质量的Code生成类库，它可以在运行期扩展Java类与实现Java接口。

cglib 创建某动态代理类的模式是：

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

实例如下：

Subject.java

import java.io.*;
import java.net.URL;
import java.net.URLConnection;
public class Subject {
    public void downloadImage(String imageURL, String filename) throws IOException {
        System.out.println("Downloading image from " + imageURL + " to " + filename + " ...");
        URL url = new URL(imageURL);
        URLConnection con = url.openConnection();
        BufferedInputStream bis = new BufferedInputStream(con.getInputStream());
        BufferedOutputStream bos = new BufferedOutputStream(new FileOutputStream(filename));
        byte[] buff = new byte[4096];
        int length;
        while ((length = bis.read(buff)) != -1) {
            bos.write(buff, 0, length);
        }
        bis.close();
        bos.close();
    }
}

SubjectEnhancer.java

import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;
import java.lang.reflect.Method;
public class SubjectEnhancer implements MethodInterceptor {
    @Override
    public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
        long start = System.currentTimeMillis();
        Object result = methodProxy.invokeSuper(o, objects);
        long end   = System.currentTimeMillis();
        System.out.println(method.getName() + " cost " + (end - start) + " ms...");
        return result;
    }
}

SubjectInterceptor.java

import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;
import java.lang.reflect.Method;
public class SubjectInterceptor implements MethodInterceptor {
    @Override
    public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
        long start = System.currentTimeMillis();
        Object result = methodProxy.invokeSuper(o, objects);
        long end   = System.currentTimeMillis();
        System.out.println(method.getName() + " cost " + (end - start) + " ms...");
        return result;
    }
}

Main.java

import java.io.IOException;
public class Main {
    public static void main(String[] args) throws IOException {
        Subject subject = ProxyFactory.getInstance(new SubjectInterceptor(), Subject.class);
        subject.downloadImage("http://202.114.96.204/cache/9/04/cankaoxiaoxi.com/df328181a0da90521ad4da4ad30f8d35/1496884353332.jpg", "image.jpg");
    }
}

输出结果

Downloading image from http://202.114.96.204/cache/9/04/cankaoxiaoxi.com/df328181a0da90521ad4da4ad30f8d35/1496884353332.jpg to image.jpg ...
downloadImage cost 219 ms...