设计模式——Proxy静态代理与动态代理

简介

意图：

为其他对象提供一种代理以控制对整个对象的访问。

主要解决：

在直接访问对象时带来的问题，比如说：要访问的对象在远程的机器上。在面向对象的系统中，有些对象由于某些原因（比如对象创建开销很大，或者某些操作需要安全控制，或者需要进程外的访问），直接访问会给使用者或者系统结构带来很多麻烦，我们可以在访问此对象时加上一个对此对象的访问层。

优点：

职责清晰
高扩展性
智能化

缺点：

由于在客户端和真实主题之间增加了代理对象，因此有些类型的代理模式可能会造成请求的处理速度变慢。
实现代理需要额外的工作，有些代理模式实现起来非常复杂。

使用场景：

远程代理
虚拟代理
Copy-on-Write代理
保护代理
Cache代理
防火墙代理
同步化代理
智能引用代理

实现

静态代理

静态代理在使用时，需要定义接口或者父类，被代理对象与代理对象一起实现相同的接口或者时继承相同父类。

接口

interface Movable {    
    void move();
}

被代理类，实现该接口move方法

public class Tank implements Movable {
    /**
     * 模拟坦克移动了一段儿时间
     */
    @Override
    public void move() {
        System.out.println("Tank moving claclacla...");
        try {
            Thread.sleep(new Random().nextInt(10000));
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

代理类同样实现该接口，添加Movable属性，实现move方法内部调用传入的被代理类的move方法，在调用前后可以添加一些业务代码

class TankTimeProxy implements Movable {
    Movable m;
    public TankTimeProxy(Movable m) {
        this.m = m;
    }
    @Override
    public void move() {
        long start = System.currentTimeMillis();
        m.move();
        long end = System.currentTimeMillis();
        System.out.println(end - start);
    }
}

最后使用main方法调用代理类的move方法，如果需要多个代理类，可以多层嵌套使用

 class Demo{
    public static void main(String[] args) {
        Tank t = new Tank();
        TankTimeProxy ttp = new TankTimeProxy(t);
        //        TankLogProxy tlp = new TankLogProxy(ttp);
        ttp.move();
    }
}

静态代理总结：

可以做到在不修改目标对象的功能前提下，对目标功能扩展。
缺点：因为代理对象需要与目标对象实现一样的接口，所以会有很多代理类，类太多。同时，一旦接口增加方法，目标对象与代理对象都要维护。

动态代理

特点：

代理对象，不需要实现接口
代理对象的生成，是利用JDK的API，动态的内存中构建代理对象（没有接口的cglib代理）

被代理类，实现该接口move方法

public class Tank implements Movable {
    /**
     * 模拟坦克移动了一段儿时间
     */
    @Override
    public void move() {
        System.out.println("Tank moving claclacla...");
        try {
            Thread.sleep(new Random().nextInt(10000));
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

JDK代理：

代理类所在的包：java.lang.reflect.Proxy

public static Object newProxyInstance(ClassLoader loader,Class<?>[] interfaces,InvocationHandler h)

ClassLoader loader：指定当前目标对象使用类加载器
Class<?>[] interfaces：目标对象实现的接口的类型
InvocationHandler h：事件处理，执行目标对象的方法时会触发事件处理器，会把当前执行目标对象的方法作为参数传入

接口

interface Movable {    
    void move();
}

被代理类，实现该接口move方法

public class Tank implements Movable {
    /**
     * 模拟坦克移动了一段儿时间
     */
    @Override
    public void move() {
        System.out.println("Tank moving claclacla...");
        try {
            Thread.sleep(new Random().nextInt(10000));
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

创建一个代理类的调用处理程序

class TimeProxy implements InvocationHandler {
    // 代理类中的真实对象
    Movable m;
    public TimeProxy(Movable m) {
        this.m = m;
    }
    public void before() {
        System.out.println("method start..");
    }
    public void after() {
        System.out.println("method stop..");
    }
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        before();
        Object o = method.invoke(m, args);
        after();
        return o;
    }
}

Demo调用，生成指定接口的代理类实例

public static void main(String[] args) {
    Tank tank = new Tank();
    Movable m = (Movable)Proxy.newProxyInstance(Tank.class.getClassLoader(),
            new Class[]{Movable.class}, //tank.class.getInterfaces()
            new TimeProxy(tank)    );
    m.move();
}

上述演示的时生成指定接口的代理类示例，但是JDK中时，通过JDK代理或者cglib代理在运行时自动生成到内存中的。

JDK动态代理原理

生成动态代理文件

方法一：

必须在main方法中执行，直接用junit的test方法调用无法生成
JDK1.8之后在main方法最前面增加System.getProperties().put("jdk.proxy.ProxyGenerator.saveGeneratedFiles","true");
JDK1.8及其之前在main方法最前面增加System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles","true");

方法二：

运行时加入jvm 参数 -Djdk.proxy.ProxyGenerator.saveGeneratedFiles=true
运行时加入jvm 参数 -Dsun.misc.ProxyGenerator.saveGeneratedFiles=true

如何确定是哪个参数,查看ProxyGenerator类内容，如下：

然后执行后就会在当前目录下com包中生成代理类的class文件。

然后。。。

就是源码过程了，先上图

截图发现图片太多就算了。。。

Movable m = (Movable)Proxy.newProxyInstance(Tank.class.getClassLoader(),
        new Class[]{Movable.class},
        new TimeProxy(tank));

/*
 * Look up or generate the designated proxy class and its constructor.
 */
Constructor<?> cons = getProxyConstructor(caller, loader, interfaces);

return proxyCache.sub(intf).computeIfAbsent(
    loader,
    (ld, clv) -> new ProxyBuilder(ld, clv.key()).build()
);

Constructor<?> build() {
    Class<?> proxyClass = defineProxyClass(module, interfaces);
    final Constructor<?> cons;
    try {
        cons = proxyClass.getConstructor(constructorParams);
    } catch (NoSuchMethodException e) {
        throw new InternalError(e.toString(), e);
    }
    AccessController.doPrivileged(new PrivilegedAction<Void>() {
        public Void run() {
            cons.setAccessible(true);
            return null;
        }
    });    
return cons;
}

/* 
* Generate the specified proxy class. 
*/
byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
        proxyName, interfaces.toArray(EMPTY_CLASS_ARRAY), accessFlags);

final byte[] classFile = gen.generateClassFile();

addProxyMethod(hashCodeMethod, Object.class);
addProxyMethod(equalsMethod, Object.class);
addProxyMethod(toStringMethod, Object.class);

methods.add(pm.generateMethod());

最最最后是通过asm来实现的

Cglib动态代理

创建Enhancer对象
用Enhancer对象设置代理类的父类（被代理类）
创建回调对象（回调类实现 MethodInterceptor 接口）
用Enhancer对象设置回调对象
用Enhancer对象创建代理对象

创建一个拦截器，相当于JDK的InvocationHander

class TimeMethodInterceptor implements MethodInterceptor {
    @Override
    public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
        System.out.println(o.getClass().getSuperclass().getName());
        System.out.println("before");
        Object result = null;
        result = methodProxy.invokeSuper(o, objects);
        System.out.println("after");
        return result;
    }
}

创建动态代理

/**
 * CGLIB实现动态代理不需要接口 
*/public class Main {
    public static void main(String[] args) {
        Enhancer enhancer = new Enhancer();
        enhancer.setSuperclass(Tank.class);
        enhancer.setCallback(new TimeMethodInterceptor());
        Tank tank = (Tank)enhancer.create();
        tank.move();
    }
}

生成cglib代理的class，下面两个任选其一

System.setProperty("cglib.debugLocation", "./cg");

System.setProperty(DebuggingClassWriter.DEBUG_LOCATION_PROPERTY, "./cg");

或者在idea -> run -> edit configurations 中设置 vm options

-Dcglib.debugLocation=./cg

其他关于代理

正向代理：

知道目标地址，但无法直接访问，需要通过代理才可以访问。例如IP代理机场等。
正向代理的过程，隐藏了真实的客户端。客户端的请求服务都被代理服务器代替来请求。

反向代理：

不知道目标地址，代理服务器就相当于目标服务器，由代理服务器接受所有请求后，转发给内部其他服务器。例如访问百度www.baidu.com但是不知道实际访问是哪台服务器。