设计模式-代理模式

定义

首先代理模式可以分为多种类型

• 远程代理：工作委托给远程对象（不同的服务器，或者不同的进程）来完成。常见的是用在web Service中。还有就是我们的RPC调用也可以理解为一种远程代理。
• 保护代理：主要进行安全/权限检查。（接触很少）
• 缓存代理：通过存储来加速调用，比如Sping中的@Cacheable方法，缓存特定的参数获取到的结果，当下次相同参数调用该方法，直接从缓存中返回数据。
• 虚拟代理：主要是为方法增加功能，比如记录一些性能指标等，或进行延迟初始化

• Subject（共同接口）：客户端使用的现有接口
• RealSubject（真实对象）：真实对象的类
• ProxySubject（代理对象）：代理类

从图中可以看出其实整个接口还是很简单，就是一个真实对象以及代理对象。

目的

提供一个实际代理对象，以便更好的控制实际对象。

代码举例实现

为了方便理解，还是举一个例子，不知道大家在读初中或者高中是否经历过传小纸条的过程，假如现在同学A 对同学C有一些话想聊（比如放学相约一起打游戏）但是因为现在是上课时间，又不能大声说，同学A和同学C之间坐了一个同学B，所以现在同学A只能是先找到同学B把纸条给它，让他转告同学C，但是去玩还是不是不去玩，那还是只能真正的同学C自己才能决定。

所以代理模式可以理解为 同学B是同学的C的代理，同学A要找同学C，只能找到同学B，通过同学B转达同学C，同时将同学的C的执行结果反馈给同学A。

public interface Subject {
  	// 共同的接口
    void doSomething();
}

定义一个共同的接口（即大家要做的事请：放学一起打游戏）

public class RealSubject implements Subject {
   	// 真实对象
    @Override
    public void doSomething() {
        System.out.println("放学去打游戏");
    }
}

构建一个真实对象，即例子中的同学C

public class ProxySubject implements Subject {

    private RealSubject realSubject;

    public ProxySubject(RealSubject realSubject) {
        this.realSubject = realSubject;
    }

    public ProxySubject() throws ClassNotFoundException, IllegalAccessException, InstantiationException {
        this.realSubject = (RealSubject) this.getClass().getClassLoader().loadClass("com.ao.bing.demo.proxyPattern.RealSubject").newInstance();
    }

    @Override
    public void doSomething() {
        realSubject.doSomething();
    }


    public static void main(String[] args) {

        try {
            // 第一种方式
            new ProxySubject().doSomething();
            // 打印结果： 放学去打游戏
        } catch (Exception e) {
            // 异常情况，代理失败，
            // 传纸条的被老师抓了。或者同学C不在座位上了 等异常情况
        }

        // 第二种方式
        new ProxySubject(new RealSubject()).doSomething();
        // 打印结果： 放学去打游戏
    }
}

构建代理对象，即同学B，那么可以看到同学A并没有真实接触到同学C，通过同学B对同学C的代理就能知道同学C放学能不能跟他一起去打游戏

在Main方法里面，有两种方式来调用真实对象

• 采用类加载器形式，去加载实列对象，这样我们就不同关心到底什么时候需要真实的实列化对象
• 通过传值的形式，把实列化对象传过来。（理解为装饰器模式了）

这里大家要区别一下，代理模式是提供完全相同的接口，而装饰器模式是为了增强接口。

静态代理、JDK动态代理和Cglib代理分析

静态代理

在上面的举的列子实现其实就是静态代理，大家可以看到整体也比较简单。但是它的缺点也很明显

静态代理需要为每一个对象都创建一个代理类，增加了维护成本以及开发成本，那么为了解决这个问题，动态代理就出来了，不要再固定为每一个需要代理的类而创建一个代理类

动态代理

动态代理合理的避免了静态代理的那种方式，不用事先为要代理的类而构建好代理类。而是在运行时通过反射机制创建。

在写动态代理时需要理解两个东西：Proxy 可以理解为就是调度器，InvocationHandler 增强服务接口可以理解为代理器。所以我个人理解动态代理其实就是一种行为的监听。

具体的代码实现举一个例子：螳螂捕蝉，通过螳螂监听到蝉的动作。方便后面讲到多级代理模式。

JDK动态代理

public interface BaseService {
    void mainService();
}

public class Cicada implements BaseService {
    @Override
    public void mainService() {
        System.out.println("主要业务，以蝉为例，当蝉出现业务调用时，螳螂监听到");
    }
}

创建共同接口，以及真实对象蝉

public class PrayingMantis implements InvocationHandler {

    private BaseService baseService;

  // 这里采用的是构建传参数，可以用反射，举的第一个例子有样式代码
    public PrayingMantis(BaseService baseService) {
        this.baseService = baseService;
    }

    // 螳螂主要业务，也就是监听对象
    @Override
    public Object invoke(Object listener, Method method, Object[] args) throws Throwable {
        method.invoke(baseService,args);
        secondaryMain();
        return null;
    }
    // 这里理解增强业务，即我们可以在实现InvocationHandler里面添加其他的业务，比如日志等等。
    private void secondaryMain(){
        System.out.println("螳螂捕蝉 - 次要业务");
    }
}

创建螳螂类，监听着蝉的类的动作

public class BeanFactory {

    public static BaseService newInstanc(Class classFile) {
        // 1. 创建蝉，真实类对象
        BaseService trueCicada = new Cicada();
        // 2.创建代理类 螳螂
        InvocationHandler prayingMantis = new PrayingMantis(trueCicada);
        // 3.向Jvm索要代理对象 其实就是监听的对象，
        Class classArray[] = {BaseService.class};
        BaseService baseService = (BaseService) Proxy.newProxyInstance(classFile.getClassLoader(), classArray, prayingMantis);
        return baseService;
    }
  
   // 测试Demo
    public static void main(String[] args) {
        BaseService baseService  = newInstanc(Cicada.class);
        baseService.mainService();
        // 测试结果 ：主要业务
        //           螳螂捕蝉 - 次要业务
    }
}

通过结果可以看出当蝉主要业务发生调用时，螳螂能监听到蝉的业务并且能处理其他业务逻辑，这也就是Spring里面AOP为什么能处理日志切面等。

代理的本质：一种行为的监听，对代理对象（$proxy InvocationHandler）的一种监听行为。

代理模式组成：

• 接口：声明需要被监听行为
• 代理实现类（InvocationHandler）:次要业务，次要业务和主要业务绑定执行
• 代理对象（监听对象）

Cglib动态代理

Cglib动态代理其实和jdk的动态代理是很相似的，都是要去实现代理器接口完成。

public interface BaseService {
    void mainService();
}

public class Cicada implements BaseService {
    @Override
    public void mainService() {
        System.out.println("主要业务，以蝉为例，当蝉出现业务调用时，螳螂监听到");
    }
}

public class PrayingMantis implements MethodInterceptor {

    private Cicada cicada;// 代理对象

    public Cicada getInstance(Cicada cicada) {
        this.cicada = cicada;
        Enhancer enhancer = new Enhancer();
        enhancer.setSuperclass(this.cicada.getClass());
        enhancer.setCallback(this);
        return (Cicada) enhancer.create();
    }

    @Override
    public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
        Object object = methodProxy.invokeSuper(o, objects);
        secondaryMain();
        return object;
    }

    private void secondaryMain() {
        System.out.println("螳螂捕蝉 - 次要业务");
    }

    public static void main(String[] args) {
        PrayingMantis prayingMantis = new PrayingMantis();
        Cicada instance = prayingMantis.getInstance(new Cicada());
        instance.mainService();
        // 结果：主要业务
        //      螳螂捕蝉 - 次要业务
    }

细心的同学已经发现，Cglib 无需通过接口来实现，它是通过实现子类的方式来完成调用的。

• Enhancer 对象把代理对象设置为被代理类的子类来实现动态代理的。因为是采用继承方式，所以代理类不能加final修饰，否则会报错。
• final类：类不能被继承，内部的方法和变量都变成final类型

JDK和Cglib的区别

jdk动态代理是利用反射机制生成一个实现代理接口的匿名类，在调用具体方法前调用InvokeHandler来处理

cglib动态代理是利用ASM开源包，对被代理对象类的class文件加载进来，通过修改其字节码生成子类来处理

ASM: 一个 Java 字节码操控框架。它能被用来动态生成类或者增强既有类的功能。ASM 可以直接产生二进制 class 文件，也可以在类被加载入 Java 虚拟机之前动态改变类行为。Java class 被存储在严格格式定义的 .class 文件里，这些类文件拥有足够的元数据来解析类中的所有元素：类名称、方法、属性以及 Java 字节码（指令）。ASM 从类文件中读入信息后，能够改变类行为，分析类信息，甚至能够根据用户要求生成新类。

多级动态代理

看完上面的动态代理，不知道大家有没有想法，实现一个多级动态代理。

还是以螳螂捕蝉为例子，再加上一个黄雀在后，实现多级动态代理模式。

public class Cardinal implements InvocationHandler {
  // 监听代理代理对象
    private Object proxyOne;

    public Cardinal(Object proxyOne) {
        this.proxyOne = proxyOne;
    }

    // 螳螂主要业务，也就是监听对象
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws            Throwable {
        method.invoke(proxyOne, args);
        secondaryMain();
        return null;
    }
    private void secondaryMain() {
        System.out.println("黄雀吃螳螂 - 次要业务");
    }
}

创建一个黄雀代理对象，那作为他的真实对象就变成螳螂了，当螳螂对象发生调用时，黄雀就能坚挺到，同时作出对应业务逻辑

public class BeanFactory {

    public static BaseService newInstanc(Class classFile) {
        // 1. 创建蝉，真实类对象
        BaseService trueCicada = new Cicada();

        // 2.创建代理类 螳螂
        InvocationHandler prayingMantis = new PrayingMantis(trueCicada);

        // 3.向Jvm索要代理对象 其实就是坚挺的对象
        Class classArray[] = {BaseService.class};
        BaseService baseService = (BaseService) Proxy.newProxyInstance(classFile.getClassLoader(), classArray, prayingMantis);

        // 4.创建代理实现类 黄雀 二级代理
        InvocationHandler cardinal = new Cardinal(baseService);
        BaseService secondBaseService = (BaseService) Proxy.newProxyInstance(classFile.getClassLoader(), classArray, cardinal);
        
       // 假设要实现三级，四级代理，则在黄雀类上再加一层代理即可实现。
       // 省略其他的更多级代理对象
        return secondBaseService;
    }
  
     // 测试demo
      public static void main(String[] args) {
        BaseService baseService  = BeanFactory.newInstanc(Cicada.class);
        baseService.mainService();
        // 结果：主要业务
        //      螳螂捕蝉 - 次要业务
        //      黄雀吃螳螂 - 次要业务
    }
}

注:没有罗列出来的对象|接口参照上面的示例代码照搬即可,这里不做过多描述

根据这个代码基本就实现多级代理过程。螳螂监听着蝉类的动作，黄雀监听着螳螂类的动作。

同样的如果要实现三级代理，四级代理也就不是什么难事了，在每一层的上面再加一个代理对象就可以了。

动态代理本质还是可以理解为将“次要业务”与“主要业务”解耦合，让开发者能更加专注于主要业务，提升开发效率，以及维护成本。

总结

代理模式在业务代码上我个人认为是比较少见的，特别是动态代理基本上是没有见过。但是代理模式也是我们必须要理解的一种模式，因为学习好代理模式有助于我们去读一些源码，排查一些更深层次的问题，或者面对一些业务场景问题，也能有一个很大的提升，设计模式本身也就是为了解决问题而创建出来的。