设计模式之代理模式

代理模式

代理模式为一个对象提供一个替身，以控制对这个对象的访问。即通过代理对象访问目标对象。这样做的好处是可以在目标对象实现的基础上，增强额外的功能操作，即扩展目标对象的功能。

被代理对象可以是远程对象、创建开销大的对象或需要安全控制的对象，代理模式有不同的形式，主要有三种：静态代理、动态代理（JDK 代理、接口代理）和Cglib 代理（可以在内存动态的创建对象，而不需要实现接口，它是属于动态代理的范畴）。

静态代理

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

举一个栗子

老师教书的一个例子，定义一个接口ITeacherDao，然后目标对象TeacherDao去实现这个接口的方法，此时使用静态代理的方法，就需要在代理对象TeacherDaoProxy里也实现ITeacherDao，调用方法的时候通过代理对象的方法来调用目标对象。

接口：ITeacherDao

package cn.personalweb.proxy.staticproxy;

public interface ITeacherDao {
    /**
     * 老师教课方法
     */
    public void teach();
}

目标对象：TeachterDao

package cn.personalweb.proxy.staticproxy;

public class TeachterDao implements ITeacherDao{
    public void teach() {
        System.out.println("老师授课中...");
    }
}

代理对象：TeacherDaoProxy

package cn.personalweb.proxy.staticproxy;

public class TeacherDaoProxy implements ITeacherDao{

    /**
     * 接受保存的目标对象
     */
    private ITeacherDao target;

    public TeacherDaoProxy(ITeacherDao target) {
        this.target = target;
    }

    public void teach() {
        System.out.println("===开始事物===");
        target.teach();
        System.out.println("===提交事物===");
    }
}

客户端：Client

package cn.personalweb.proxy.staticproxy;

public class Client {
    public static void main(String[] args) {
        TeachterDao teachterDao = new TeachterDao();
        TeacherDaoProxy teacherDaoProxy = new TeacherDaoProxy(teachterDao);
        teacherDaoProxy.teach();
    }
}


// 输出结果
//===开始事物===
//老师授课中...
//===提交事物===

静态代理的有缺点

1. 优点：在不修改目标对象的功能前提下, 能通过代理对象对目标功能扩展

2. 缺点：因为代理对象需要与目标对象实现一样的接口,所以会有很多代理类，一旦接口增加方法,目标对象与代理对象都要维护。

动态代理

在静态代理中，代理类是由我们手动创建，并且代理对象需要实现接口。而在动态代理中，动态代理利用了JDK API动态地在内存中构建代理对象（Java 的反射机制），从而实现对目标对象的代理功能。所以动态代理又称 JDK代理或接口代理。

动态代理对象不需要实现接口，但是目标对象需要实现接口，否则不能用动态代理。

动态代理 API

1. java.lang.reflect.Proxy类

   在这个类中主要使用newProxyInstance方法，方法的定义如下：

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

   这个方法需要接受三个参数，参数如下：

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

2. java.lang.reflect.InvocationHandler接口

   在newProxyInstance中的最后一个参数就是写入此接口，通过匿名内部类的方法调用此接口。这个接口接受代理对象、方法和参数，在代理实例上处理方法并返回结果。具体用法看下面的例子，接口源代码如下：

   public Object invoke(Object proxy, Method method, Object[] args)
       throws Throwable;
   

举一个栗子

同静态代理一样，是一个老师教书的例子，不过这里增加了一个方法sayHello(String name)。增加这个方法的目的是查看java.lang.reflect.InvocationHandler接口传入的参数信息。

接口：ITeacherDao

package cn.personalweb.proxy.dynamic;

public interface ITeacherDao {
    /**
     * 老师教课方法
     */
    public void teach();

    /**
     * 打招呼的方法
     * @param name 问候人的名字
     */
    public void sayHello(String name);
}

目标对象：TeachterDao

package cn.personalweb.proxy.dynamic;

public class TeacherDao implements ITeacherDao{

    public void teach() {
        System.out.println("老师授课中.....");
    }

    public void sayHello(String name) {
        System.out.println("hello " + name);
    }
}

动态代理工厂：ProxyFactory

package cn.personalweb.proxy.dynamic;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;

public class ProxyFactory {
    /**
     * 维护一个目标对象
     */
    private Object target;

    public ProxyFactory(Object target) {
        this.target = target;
    }

    /**
     * 为目标对象生成一个代理对象
     * @return Object
     */
    public Object getProxyInstance() {
        return Proxy.newProxyInstance(target.getClass().getClassLoader(), target.getClass().getInterfaces(), new InvocationHandler() {
            public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                System.out.println("开启事务");
                /**
                 * 反射机制调用目标对象的方法
                 * args: 方法传入的参数, sayHello 中是 name
                 * returnVal: 调用方法的返回值
                 */
                Object returnVal = method.invoke(target, args);
                System.out.println("提交事物");
                return returnVal;
            }
        });
    }
}

客户端：Client

package cn.personalweb.proxy.dynamic;

/**
 * @program: DesignPattern
 * @description:
 * @author: lizheng
 * @create: 2020-09-20 13:22
 **/
public class Client {
    public static void main(String[] args) {
        ITeacherDao target = new TeacherDao();
        ITeacherDao proxyInstance = (ITeacherDao) new ProxyFactory(target).getProxyInstance();
        proxyInstance.teach();
        proxyInstance.sayHello("Jack");

    }
}

// 输出结果
//开启事务
//老师授课中.....
//提交事物
//开启事务
//hello Jack
//提交事物

Cglib 代理

静态代理和 JDK 代理模式都要求目标对象是实现一个接口，但是有时候目标对象只是一个单独的对象，并没有实 现任何的接口,这个时候可使用目标对象子类来实现代理-这就是 Cglib 代理。

Cglib代理也叫作子类代理,它是在内存中构建一个子类对象从而实现对目标对象功能扩展, 有些书也将Cglib代 理归属到动态代理。Cglib 代理与前面动态代理最大的区别就是，动态代理的目标对象必须实现接口，而 Cglib 不需要实现接口，达到了代理类无侵入。

Cglib 是一个强大的高性能的代码生成包,它可以在运行期扩展 java 类与实现 java 接口.它广泛的被许多 AOP 的 框架使用,例如 Spring AOP， 实现方法拦截。Cglib 包的底层是通过使用字节码处理框架 ASM 来转换字节码并生成新的类。

引入Cglib 的 maven 坐标

<dependency>
    <groupId>cglib</groupId>
    <artifactId>cglib</artifactId>
    <version>3.3.0</version>
</dependency>

举一个栗子

同上，老师教书。

目标对象：TeachterDao

package cn.personalweb.proxy.cglib;

public class TeacherDao {
    public void teach() {
        System.out.println("老师授课中, cglib 不需要写接口w");
    }
}

动态代理工厂：ProxyFactory

package cn.personalweb.proxy.cglib;

import net.sf.cglib.proxy.Enhancer;
import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;

import java.lang.reflect.Method;

public class ProxyFactroy implements MethodInterceptor {
    /**
     * 维护一个目标对象
     */
    private Object target;

    public ProxyFactroy(Object target) {
        this.target = target;
    }

    /**
     * 返回一个代理对象, 是 target 对象的代理对象
     * @return
     */
    public Object getProxyInstance() {
        // 1. 创建一个工具类
        Enhancer enhancer = new Enhancer();
        // 2. 设置父类
        enhancer.setSuperclass(target.getClass());
        // 3. 设置回调函数
        enhancer.setCallback(this);
        // 4. 创建子类对象,即代理对象
        return enhancer.create();
    }

    /**
     * 会调用目标对象的方法
     * @param o 对 target 对象增强后的对象
     * @param method 代理对象截取(触发)的方法
     * @param objects 参数数组, 是代理方法的参数
     * @param methodProxy 用于调用超级的代理（非拦截方法）；可以根据需要多次调用
     * @return 代理对象执行方法后的返回值
     * @throws Throwable
     */
    public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
        System.out.println("开启事物");
        Object returnVal = method.invoke(target, objects);
        System.out.println("事物提交");
        return returnVal;
    }
}

客户端：Client

package cn.personalweb.proxy.cglib;

/**
 * @program: DesignPattern
 * @description:
 * @author: lizheng
 * @create: 2020-09-21 22:21
 **/
public class Client {
    public static void main(String[] args) {
        // 1. 创建目标对象
        TeacherDao target = new TeacherDao();
        // 2. 获取代理对象, 并且将目标对象传递给代理对象
        TeacherDao proxyInstance = (TeacherDao) new ProxyFactroy(target).getProxyInstance();
        // 3. 执行代理对方, 触发 intercept方法
        proxyInstance.teach();
    }
}


// 输出结果
//开启事物
//老师授课中, cglib 不需要写接口
//事物提交

---

参考资料：

尚硅谷 Java 设计模式课程笔记。