设计模式之代理模式

Love The Way You Lie 2022-03-27 06:55 271阅读 0赞

##  ##

代理模式：为一个对象提供一个替身，以控制对这个对象的访问。即通过代理对象访问目标对象.这样做的好处是:可以在目标对象实现的基础上,增强额外的功能操作,即扩展目标对象的功能。  
被代理的对象可以是远程对象、创建开销大的对象或需要安全控制的对象

用图表示如下:

![7a97a53069bd353cbc6fd18326f5bb03.png][]

代理模式的关键点是:代理对象与目标对象.代理对象是对目标对象的扩展,并会调用目标对象

类图：

![bbc915d7a118820f974ef2001601a71f.png][]

Subject 抽象主题：声明一个接口，为真实主题和代理主题都要实现的

RealSubject 真实主题：定义了代理角色所代表的真实对象

Proxy代理主题：内部包含真实主题的引用，可以在如何时候对真实主题进行方法调用，他与真实主题有相同的接口，也就可以伪装自己，貌似自己也可以做与真实主题同样的事件。他控制真实对象，在需要真实对象出现的时候，就把他创建出来，真实主题就相当于傀儡；当然代理一般也会增加或修改真实主题的功能。

代理模式有不同的形式, 主要有三种静态代理、动态代理(JDK 代理、接口代理)和Cglib 代理(可以在内存动态的创建对象，而不需要实现接口， 他是属于动态代理的范畴)

### 静态代理 ###

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

下面举个案例来解释

老师生病了，需要一个代理老师来教课

1) 定义一个接口:ITeacherDao  
2) 目标对象TeacherDAO 实现接口ITeacherDAO  
3) 使用静态代理方式,就需要在代理对象TeacherDAOProxy 中也实现ITeacherDAO  
4) 调用的时候通过调用代理对象的方法来调用目标对象.  
5) 特别提醒：代理对象与目标对象要实现相同的接口,然后通过调用相同的方法来调用目标对象的方法

思路分析图解(类图)

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NDUwMDg5_size_16_color_FFFFFF_t_70][]

代码示例:

package com.dongguo.proxy.staticproxy;
    
    /**
     * @author Dongguo
     * @date 2021/8/22 0022-17:28
     * @description: 接口
     */
    public interface ITeacherDao {
        void teach(); // 授课的方法
    }

package com.dongguo.proxy.staticproxy;
    
    /**
     * @author Dongguo
     * @date 2021/8/22 0022-17:28
     * @description: 目标对象
     */
    public class TeacherDao implements ITeacherDao {
        @Override
        public void teach() {
            System.out.println(" 老师授课中。。。。。");
        }
    }

package com.dongguo.proxy.staticproxy;
    
    /**
     * @author Dongguo
     * @date 2021/8/22 0022-17:29
     * @description: 代理对象
     */
    public class TeacherDaoProxy implements ITeacherDao{
        private ITeacherDao target; // 目标对象，通过接口来聚合
        //构造器
        public TeacherDaoProxy(ITeacherDao target) {
            this.target = target;
        }
        @Override
        public void teach() {
            System.out.println("开始代理完成某些操作。。。。。");//方法
            target.teach();
            System.out.println("提交。。。。。");//方法
    
        }
    }

package com.dongguo.proxy.staticproxy;
    
    /**
     * @author Dongguo
     * @date 2021/8/22 0022-17:28
     * @description:
     */
    public class Client {
        public static void main(String[] args) {
            //创建目标对象(被代理对象)
            TeacherDao teacherDao = new TeacherDao();
            //创建代理对象, 同时将被代理对象传递给代理对象
            TeacherDaoProxy teacherDaoProxy = new TeacherDaoProxy(teacherDao);
            //通过代理对象，调用到被代理对象的方法
            //即：执行的是代理对象的方法，代理对象再去调用目标对象的方法
            teacherDaoProxy.teach();
        }
    }
    运行结果：
    开始代理完成某些操作。。。。。
     老师授课中。。。。。
    提交。。。。。

**静态代理总结:**  
1.可以做到在不修改目标对象的功能前提下,对目标功能扩展.  
2.缺点:

*  因为代理对象需要与目标对象实现一样的接口,所以会有很多代理类,类太多.同时,一旦接口增加方法,目标对象与代理对象都要维护.
 *

如何解决静态代理中的缺点呢?答案是可以使用动态代理方式

### 动态代理 ###

**动态代理有以下特点:**  
1.代理对象,不需要实现接口  
2.代理对象的生成,是利用JDK的API,动态的在内存中构建代理对象(需要我们指定创建代理对象/目标对象实现的接口的类型)  
3.动态代理也叫做:JDK代理,接口代理

**JDK中生成代理对象的API**  
代理类所在包:java.lang.reflect.Proxy  
JDK实现代理只需要使用newProxyInstance方法,但是该方法需要接收三个参数,完整的写法是:

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

注意该方法是在Proxy类中是静态方法,且接收的三个参数依次为:

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

将前面的静态代理改进成动态代理模式(即：JDK 代理模式)

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NDUwMDg5_size_16_color_FFFFFF_t_70 1][]

代码示例:

接口类ITeacherDao.java以及接口实现类,目标对象TeacherDao是一样的,没有做修改.在这个基础上,增加一个代理工厂类(ProxyFactory.java),将代理类写在这个地方,然后在测试类(需要使用到代理的代码)中先建立目标对象和代理对象的联系,然后代用代理对象的中同名方法

代理工厂类:ProxyFactory.java

package com.dongguo.proxy.dynamic;
    
    import java.lang.reflect.InvocationHandler;
    import java.lang.reflect.Method;
    import java.lang.reflect.Proxy;
    
    /**
     * @author Dongguo
     * @date 2021/8/22 0022-17:37
     * @description:
     */
    public class ProxyFactory {
        //维护一个目标对象, Object
        private Object target;
        //构造器， 对target 进行初始化
        public ProxyFactory(Object target) {
            this.target = target;
        }
        //给目标对象生成一个代理对象
        public Object getProxyInstance() {
    //说明
    /*
    * public static Object newProxyInstance(ClassLoader loader,
    Class<?>[] interfaces,
    InvocationHandler h)
    //1. ClassLoader loader ： 指定当前目标对象使用的类加载器, 获取加载器的方法固定
    //2. Class<?>[] interfaces: 目标对象实现的接口类型，使用泛型方法确认类型
    //3. 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);
                            System.out.println("JDK 代理提交");
                            return returnVal;
                        }
                    });
        }
    }

package com.dongguo.proxy.dynamic;
    
    /**
     * @author Dongguo
     * @date 2021/8/22 0022-17:39
     * @description:
     */
    public class Client {
        public static void main(String[] args) {
            //创建目标对象
            ITeacherDao target = new TeacherDao();
            //给目标对象，创建代理对象, 可以转成ITeacherDao
    
            ITeacherDao proxyInstance = (ITeacherDao)new ProxyFactory(target).getProxyInstance();
            // proxyInstance=class com.sun.proxy.$Proxy0 内存中动态生成了代理对象
            System.out.println("proxyInstance=" + proxyInstance.getClass());
            //通过代理对象，调用目标对象的方法
            proxyInstance.teach();
    //        proxyInstance.sayHello(" tom ");
        }
    }
    运行结果：
    JDK 代理开始~~
     老师授课中.... 
    JDK 代理提交

ITeacherDao新增一个sayHello的方法

package com.dongguo.proxy.dynamic;
    
    /**
     * @author Dongguo
     * @date 2021/8/22 0022-17:28
     * @description: 接口 目标对象
     */
    public interface ITeacherDao {
        void teach(); // 授课方法
        void sayHello(String name);
    }

package com.dongguo.proxy.dynamic;
    
    /**
     * @author Dongguo
     * @date 2021/8/22 0022-17:28
     * @description:
     */
    public class TeacherDao implements ITeacherDao {
        @Override
        public void teach() {
    
            System.out.println(" 老师授课中.... ");
        }
        @Override
        public void sayHello(String name) {
            System.out.println("hello " + name);
        }
    }

package com.dongguo.proxy.dynamic;
    
    /**
     * @author Dongguo
     * @date 2021/8/22 0022-17:39
     * @description:
     */
    public class Client {
        public static void main(String[] args) {
            //创建目标对象
            ITeacherDao target = new TeacherDao();
            //给目标对象，创建代理对象, 可以转成ITeacherDao
    
            ITeacherDao proxyInstance = (ITeacherDao)new ProxyFactory(target).getProxyInstance();
            // proxyInstance=class com.sun.proxy.$Proxy0 内存中动态生成了代理对象
            System.out.println("proxyInstance=" + proxyInstance.getClass());
            //通过代理对象，调用目标对象的方法
    //        proxyInstance.teach();
            proxyInstance.sayHello(" tom ");
        }
    }
    运行结果：
    JDK 代理开始~~
    hello  tom 
    JDK 代理提交

ProxyFactory 的 public Object invoke(Object proxy, Method method, Object\[\] args)

会根据传来的方法和参数实现动态代理

**总结:**  
代理对象不需要实现接口,但是目标对象一定要实现接口,否则不能用动态代理

### Cglib代理 ###

上面的静态代理和动态代理模式都是要求目标对象是实现一个接口的目标对象,但是有时候目标对象只是一个单独的对象,并没有实现任何的接口,这个时候就可以使用以目标对象子类的方式类实现代理,这种方法就叫做:Cglib代理

Cglib 代理也叫作子类代理,它是在内存中构建一个子类对象从而实现对目标对象功能扩展, 有些书也将Cglib 代理归属到动态代理。

*  JDK的动态代理有一个限制,就是使用动态代理的对象必须实现一个或多个接口,如果想代理没有实现接口的类,就可以使用Cglib实现.
 *  Cglib是一个强大的高性能的代码生成包,它可以在运行期扩展java类与实现java接口.它广泛的被许多AOP的框架使用,例如Spring AOP和synaop,为他们提供方法的interception(拦截)
 *  Cglib包的底层是通过使用一个小而块的字节码处理框架ASM来转换字节码并生成新的类.不鼓励直接使用ASM,因为它要求你必须对JVM内部结构包括class文件的格式和指令集都很熟悉.

Cglib子类代理实现方法:  
1.需要引入cglib的jar文件,Spring的核心包中已经包括了Cglib功能,所以直接引入s`pring-core.jar也可以`.

当然了我使用的maven直接加入依赖

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

2.引入功能包后,就可以在内存中动态构建子类  
3.注意代理的类不能为final，否则报错java.lang.IllegalArgumentException:  
4.目标对象的方法如果为final/static,那么就不会被拦截,即不会执行目标对象额外的业务方法.

将前面的案例用Cglib 代理模式实现

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NDUwMDg5_size_16_color_FFFFFF_t_70 2][]

代码示例:

package com.dongguo.proxy.cglib;
    
    /**
     * @author Dongguo
     * @date 2021/8/22 0022-17:54
     * @description:
     */
    public class TeacherDao {
        public String teach() {
            System.out.println(" 老师授课中， 我是cglib 代理，不需要实现接口");
            return "hello";
        }
    }

Cglib代理工厂:ProxyFactory.java

package com.dongguo.proxy.cglib;
    
    import java.lang.reflect.Method;
    import net.sf.cglib.proxy.Enhancer;
    import net.sf.cglib.proxy.MethodInterceptor;
    import net.sf.cglib.proxy.MethodProxy;
    /**
     * @author Dongguo
     * @date 2021/8/22 0022-17:53
     * @description:
     */
    public class ProxyFactory implements MethodInterceptor {
        //维护一个目标对象
        private Object target;
        //构造器，传入一个被代理的对象
        public ProxyFactory(Object target) {
            this.target = target;
        }
        //返回一个代理对象: 是target 对象的代理对象
        public Object getProxyInstance() {
    //1. 创建一个工具类
            Enhancer enhancer = new Enhancer();
    //2. 设置父类
            enhancer.setSuperclass(target.getClass());
    //3. 设置回调函数
            enhancer.setCallback(this);
    //4. 创建子类对象，即代理对象
            return enhancer.create();
        }
        //重写intercept 方法，会调用目标对象的方法
        @Override
        public Object intercept(Object arg0, Method method, Object[] args, MethodProxy arg3) throws Throwable {
            System.out.println("Cglib 代理模式~~ 开始");
            Object returnVal = method.invoke(target, args);
            System.out.println("Cglib 代理模式~~ 提交");
            return returnVal;
        }
    }

测试类:

package com.dongguo.proxy.cglib;
    
    /**
     * @author Dongguo
     * @date 2021/8/22 0022-17:54
     * @description:
     */
    public class Client {
        public static void main(String[] args) {
    
    //创建目标对象
            TeacherDao target = new TeacherDao();
    //获取到代理对象，并且将目标对象传递给代理对象
            TeacherDao proxyInstance = (TeacherDao)new ProxyFactory(target).getProxyInstance();
    //执行代理对象的方法，触发intecept 方法，从而实现对目标对象的调用
            String res = proxyInstance.teach();
            System.out.println("res=" + res);
        }
    }
    运行结果：
    Cglib 代理模式~~ 开始
     老师授课中， 我是cglib 代理，不需要实现接口
    Cglib 代理模式~~ 提交
    res=hello

在Spring的AOP编程中:  
如果加入容器的目标对象有实现接口,用JDK代理  
如果目标对象没有实现接口,用Cglib代理

几种常见的变体代理模式介绍

1) 防火墙代理  
内网通过代理穿透防火墙，实现对公网的访问。  
2) 缓存代理  
比如：当请求图片文件等资源时，先到缓存代理取，如果取到资源则ok,如果取不到资源，再到公网或者数据库取，然后缓存。

3) 远程代理  
远程对象的本地代表，通过它可以把远程对象当本地对象来调用。远程代理通过网络和真正的远程对象沟通信息。  
4) 同步代理：主要使用在多线程编程中，完成多线程间同步工作同步代理：主要使用在多线程编程中，完成多线程间同步工作

[7a97a53069bd353cbc6fd18326f5bb03.png]: /images/20220327/108901ac85314501b5d27a58381bd470.png
[bbc915d7a118820f974ef2001601a71f.png]: /images/20220327/f9046a4488a04e76ba7c56a38532594b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NDUwMDg5_size_16_color_FFFFFF_t_70]: /images/20220327/37d2fdd2dd7c4bc3a18db739f35c6c84.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NDUwMDg5_size_16_color_FFFFFF_t_70 1]: /images/20220327/17832d4441c54af48b62914cb7c7bb31.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NDUwMDg5_size_16_color_FFFFFF_t_70 2]: /images/20220327/cb9fe5f7f5724b86b5860dee3c9bf3f7.png