设计模式 | 详解代理模式

1、代理模式的基本介绍

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

2、被代理的对象可以有三种：远程对象、创建开销大的对象 或需要安全控制的对象 。

3、代理模式有不同的形式，主要有三种：静态代理、JDK代理和Cglib代理（可以在内存动态地创建对象，而不需要实现接口，它是属于动态代理的范畴） 。

---

2、静态代理

静态代理模式的基本介绍

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

静态代理案例

类图：

代码：

第一步先创建一个接口：

package com.cxc.proxy;

/**
 * @InterfaceName ITeacherDao
 * @Description 接口
 * @Author cxc
 * @Date 2020/9/5 15:21
 * @Verseion 1.0
 **/
public interface ITeacherDao {
    public void teacher();
}

第二步创建一个目标对象（被代理对象）,实现上述我们创建的接口：

package com.cxc.proxy;

/**
 * @ClassName TeacherDao
 * @Description 被代理对象
 * @Author cxc
 * @Date 2020/9/5 15:22
 * @Verseion 1.0
 **/
public class TeacherDao implements ITeacherDao {
    @Override
    public void teacher() {
        System.out.println("老师正在授课");
    }
}

第三步创建一个代理对象，也是实现上面那个接口，并且通过聚合一个接口来依赖被代理对象：

package com.cxc.proxy;

/**
 * @ClassName TeacherDaoProxy
 * @Description 静态代理
 * @Author cxc
 * @Date 2020/9/5 15:23
 * @Verseion 1.0
 **/
public class TeacherDaoProxy implements ITeacherDao {

    private ITeacherDao target ;    // 目标对象,通过接口来依赖

    // 构造器
    public TeacherDaoProxy(ITeacherDao target) {
        this.target = target;
    }

    @Override
    public void teacher() {
        System.out.println("代理开始:");
        target.teacher();
        System.out.println("提交");
    }
}

第四步就是编写一个客户端程序：

package com.cxc.proxy;

/**
 * @ClassName Client
 * @Description 客户端程序
 * @Author cxc
 * @Date 2020/9/5 15:28
 * @Verseion 1.0
 **/
public class Client {
    public static void main(String[] args) {
        // 创建目标对象
        TeacherDao t = new TeacherDao();
        // 创建代理对象，同时将被代理对象传递给代理对象
        TeacherDaoProxy proxy = new TeacherDaoProxy(t);
        // 通过代理对象，调用到被代理对象的方法
        // 即：执行的是代理对象的方法，代理对象再去调用目标对象的方法
        proxy.teacher();
        System.out.println(proxy);
    }
}

静态代理的优缺点

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

---

3、JDK代理

JDK模式的基本介绍

• 代理对象不需要实现接口，但是目标对象需要实现接口
• 代理对象的生成是利用JDK的API，动态的在内存中构建代理对象
• 是动态代理的一种

JDK生成代理对象的API

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

• JDK实现代理只需要使用newProxyInstance 方法，但是该方法需要接收三个参数，完整的写法如下：

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

JDK代理案例

将上面的静态代理改为JDK代理，首先我们画出类图

我们首先先建立一个接口：

package com.cxc.proxy.dynamic;
/**
 * @InterfaceName ITeacherDao
 * @Description 接口
 * @Author cxc
 * @Date 2020/9/5 16:03
 * @Verseion 1.0
 **/
public interface ITeacherDao {
    public void teacher();

}

然后我们再建立一个目标对象，实现那个接口：

package com.cxc.proxy.dynamic;

/**
 * @ClassName TeacherDao
 * @Description 目标对象
 * @Author cxc
 * @Date 2020/9/5 16:03
 * @Verseion 1.0
 **/
public class TeacherDao implements ITeacherDao {
    @Override
    public void teacher() {
        System.out.println("老师授课中");
    }
}

再定义一个代理工厂类：

package com.cxc.proxy.dynamic;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;

/**
 * @ClassName ProxyFactory
 * @Description 代理工厂类
 * @Author cxc
 * @Date 2020/9/5 16:04
 * @Verseion 1.0
 **/
public class ProxyFactory {
    // 维护一个目标对象
    private Object target;
    // 构造器,对target进行初始化
    public ProxyFactory(Object target) {
        this.target = target;
    }
    // 给目标对象生成一个代理对象
    public Object getProxyInstance(){
		/**
         * ClassLoader loader:指定当前目标对象使用的类加载器,获取加载器的方法固定
         * Class<?>[] interfaces:目标对象实现的接口类型，使用泛型方式确认类型
         * InvocationHandler h：事情处理，执行目标对象的方法时，会触发事情处理器方法，会把当前执行的目标对象方法作为参数传入
         */	
        return Proxy.newProxyInstance(target.getClass().getClassLoader(),
                target.getClass().getInterfaces(),
                new InvocationHandler() {
                    @Override
                    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                        System.out.println("jdk代理开始");
                        // 通过反射机制调用目标对象的方法
                        Object returnVal = method.invoke(target,args);
                        return returnVal;
                    }
                });
    }
}

再编写客户端程序：

package com.cxc.proxy.dynamic;

/**
 * @ClassName Client
 * @Description
 * @Author cxc
 * @Date 2020/9/5 16:13
 * @Verseion 1.0
 **/
public class Client {
    public static void main(String[] args) {
        // 创建一个目标对象
        ITeacherDao target = new TeacherDao();
        // 给目标对象创建代理对象
        ITeacherDao proxyInstance = (ITeacherDao) new ProxyFactory(target).getProxyInstance();
        proxyInstance.teacher();
        System.out.println(proxyInstance);
    }
}

---

4、Cglib代理

Cglib代理的基本介绍

• 静态代理和JDK代理都要求目标对象要实现一个接口。但是有时候目标对象只是一个单独的对象，并没有实现任何的接口，这个时候可使用目标对象子类来实现代理，这就是Cglib代理。
• Cglib代理也叫子类代理，它是在内存中构建一个子类对象从而实现对目标对象功能扩展。
• Cglib是一个强大的高性能的代码生成包，它可以在运行期扩展java类与实现java接口。被广泛运用在许多AOP框架中，例如Spring的AOP实现方法拦截。
• 在AOP编程中选择动态代理的方法
  • 目标对象需要实现接口，用JDK代理。
  • 目标对象不需要实现接口，用Cglib代理。
• Cglib包的底层是通过使用字节码处理框架ASM来转换字节码并生成新的类。

Cglib代理实现步骤

• 第一步是需要引入cglib的jar文件

• 然后在内存中动态构建子类，注意代理的类不能为final ，否则会报错java.lang.IllegalArgumentException

• 目标对象的方法如果为final或static，那么就不会被拦截，即不会执行目标对象额外的业务方法

cglib代理案例

案例类图：

首先先创建一个被代理对象：

package com.cxc.proxy.cglib;

/**
 * @ClassName TeacherDao
 * @Description 目标对象
 * @Author cxc
 * @Date 2020/9/5 20:00
 * @Verseion 1.0
 **/
public class TeacherDao {
    public void teacher(){
        System.out.println("我是cglib代理，不需要实现接口");
    }
}

然后创建一个ProxyFactory 类，实现MethodInterceptor 类，重写intercept() 方法：

package com.cxc.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;

/**
 * @ClassName ProxyFactory
 * @Description
 * @Author cxc
 * @Date 2020/9/5 20:01
 * @Verseion 1.0
 **/
public class ProxyFactory implements MethodInterceptor {

    // 维护一个目标对象
    private Object target;
    // 传入一个被代理的对象
    public ProxyFactory(Object target) {
        this.target = target;
    }

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


    // 重写intercept方法，会调用目标对象的方法
    @Override
    public Object intercept(Object o, Method method, Object[] args, MethodProxy methodProxy) throws Throwable {
        System.out.println("cglib代理模式开始");
        Object returnValue = method.invoke(target,args);
        System.out.println("cglib代理提交");
        return returnValue;
    }
}

客户端类来测试代码：

package com.cxc.proxy.cglib;

/**
 * @ClassName Client
 * @Description
 * @Author cxc
 * @Date 2020/9/5 20:13
 * @Verseion 1.0
 **/
public class Client {
    public static void main(String[] args) {
        // 创建目标对象
        TeacherDao target = new TeacherDao();
        // 获取代理对象，并且将目标对象传递给代理对象
        TeacherDao proxyInstance = (TeacherDao) new ProxyFactory(target).getProxyInstance();
        // 执行代理对象的方法,会触发intecept方法，从而实现对目标对象的调用
        proxyInstance.teacher();
    }
}