设计模式：结构型模式--代理模式（Proxy Pattern）

最新推荐文章于 2023-06-08 14:51:37 发布

Zzay_naw

最新推荐文章于 2023-06-08 14:51:37 发布

阅读量233

点赞数

分类专栏：笔记 java 软件体系结构文章标签： java 设计模式软件架构

本文链接：https://blog.csdn.net/ZZirk/article/details/123308591

版权

java 同时被 3 个专栏收录

22 篇文章 0 订阅

订阅专栏

笔记

20 篇文章 0 订阅

订阅专栏

软件体系结构

7 篇文章 0 订阅

订阅专栏

设计模式：结构型模式–代理模式（Proxy Pattern）

1. 引入

结构型模式描述如何将类或对象按某种布局组成更大的结构。它分为类结构型模式和对象结构型模式，前者采用继承机制来组织接口和类，后者釆用组合或聚合来组合对象。

由于组合关系或聚合关系比继承关系耦合度低，满足“合成复用原则（CRP）”，所以对象结构型模式比类结构型模式具有更大的灵活性。

结构型模式分为以下 7 种：

代理模式（Proxy Pattern）
适配器模式（Adapter Pattern）
桥接模式（Bridge Pattern）
过滤器模式（Filter、Criteria Pattern）
组合模式（Composite Pattern）
装饰器模式（Decorator Pattern）
外观模式（Facade Pattern）
享元模式（Flyweight Pattern）

2. 概述

由于某些原因，我们需要给某对象提供一个代理以控制对该对象的访问。这时，访问对象不适合或者不能直接引用目标对象，代理对象作为访问对象和目标对象之间的中介。

Java中的代理按照代理类生成时机的不同分为静态代理和动态代理：

静态代理代理类： 在编译期生成。
动态代理代理类： 在Java运行时动态生成。动态代理又分为JDK代理和CGLib代理两种。

3. 组成结构

代理（Proxy）模式主要包含以下三种角色：

抽象主题类（Subject）： 通过接口或抽象类声明真实主题和代理对象实现的业务方法。
真实主题类（Real Subject）： 实现了抽象主题中的具体业务，是代理对象所代表的真实对象，是最终要引用的对象。
代理类（Proxy）： 提供了与真实主题相同的接口，其内部含有对真实主题的引用，它可以访问、控制或扩展真实主题的功能。

4. 具体实现

以下包含三种代理模式的实现方式：

静态代理
JDK动态代理
CGLIB动态代理

4.1 静态代理

此处，我们通过一个案例来感受静态代理。

【例】火车站卖票：

如果要买火车票的话，需要去火车站买票，坐车到火车站，排队等一系列的操作，显然比较麻烦。而火车站在多个地方都有代售点，我们去代售点买票就方便很多了。这个例子其实就是典型的代理模式，火车站是目标对象，代售点是代理对象。类图如下：

在这里插入图片描述

具体实现代码如下：

抽象主题类SellTickets：

通过接口或抽象类声明真实主题和代理对象实现的业务方法。

/**
 * @author zzay
 * @interfaceName SellTickets
 * @description 结构型模式-代理模式：静态代理（抽象主题类）
 * @create 2022/02/27 13:09
 */
public interface SellTickets {

    // 通过接口或抽象类声明真实主题和代理对象实现的业务方法。
    void sell();

}

具体主题类TrainStation：

实现了抽象主题中的具体业务，是代理对象所代表的真实对象，是最终要引用的对象。

/**
 * @author zzay
 * @className TrainStation
 * @description 结构型模式-代理模式：静态代理（具体主题类）
 * @create 2022/02/27 13:10
 */
public class TrainStation implements SellTickets {

    // 实现了抽象主题中的具体业务，是代理对象所代表的真实对象，是最终要引用的对象。
    public void sell() {
        System.out.println("Sold a ticket.");
    }

}

代理类ProxyPoint：

提供了与真实主题相同的接口，其内部含有对真实主题的引用。它可以访问、控制或扩展真实主题的功能。

/**
 * @author zzay
 * @className ProxyPoint
 * @description 结构型模式-代理模式：静态代理（代理类）
 * @create 2022/02/27 13:10
 */
public class ProxyPoint implements SellTickets {

    // 对象结构型模式，釆用组合或聚合来组合对象
    private TrainStation trainStation = new TrainStation();
    
    // 提供了与真实主题相同的接口，其内部含有对真实主题的引用。
    // 它可以访问、控制或扩展真实主题的功能。
    public void sell() {
        System.out.println("Add some fees at the proxy point.");
        trainStation.sell();
    }

}

测试类Client：

/**
 * @author zzay
 * @className Client
 * @description 结构型模式-代理模式：静态代理（测试类）
 * @create 2022/02/27 13:11
 */
public class Client {

    public static void main(String[] args) {
        ProxyPoint proxyPoint = new ProxyPoint();
        proxyPoint.sell();
    }

}

从上面代码中可以看出，测试类Client直接访问的是代理类ProxyPoint类对象。也就是说，ProxyPoint充当了访问对象Client和目标对象TrainStation的中介。同时也对sell()方法进行了增强（收取一些代理服务费用）。

4.2 动态代理

4.2.1 JDK实现

接下来我们使用JDK动态代理实现上面的案例。

Java中提供了一个动态代理类Proxy，但是注意Proxy并不是我们上述所说的代理对象的类，而是提供了一个创建代理对象的静态方法newProxyInstance()，以获取代理对象。此外， JDK动态代理要求必须定义接口，对接口进行代理。

具体实现代码如下：

动态代理工厂类ProxyFactory：

该类通过JDK自带Proxy来创建代理。

/**
 * @author zzay
 * @className ProxyFactory
 * @description 结构型模式-代理模式：动态代理（JDK实现）
 * @create 2022/02/27 13:23
 */
public class ProxyFactory {

    // 具体主题类：实现了抽象主题中的具体业务，是代理对象所代表的真实对象，是最终要引用的对象。
    private TrainStation trainStation = new TrainStation();

    // 使用JDK自带的Proxy获取代理对象
    public SellTickets getProxyObject() {
        /*
        newProxyInstance()方法参数说明:
            ClassLoader loader:    
            	类加载器，用于加载代理类，使用真实对象的类加载器即可
            Class<?>[] interfaces: 
            	真实对象所实现的接口，代理模式真实对象和代理对象实现相同的接口
            InvocationHandler h:   
            	代理对象的调用处理程序
         */
        SellTickets sellTickets = (SellTickets) Proxy.newProxyInstance(
				// 填入真实主题对象的类加载器，为了加载代理类
                trainStation.getClass().getClassLoader(),   
                // 真实主题对象所实现的抽象主题的接口，为了使代理对象实现相同的接口
            	trainStation.getClass().getInterfaces(),    
            	// 代理对象对真实主题对象的业务接口进行调用处理的程序
                new InvocationHandler() {   
                    /*
                    InvocationHandler中invoke()方法参数说明:
                        proxy:  代理对象
                        method: 对应于在代理对象上调用接口方法的Method实例
                        args:   代理对象调用接口方法时传递的实际参数
                     */
                    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                        // 代理点的额外业务逻辑
                        System.out.println("代理点收取服务费用(JDK动态代理方式)");
                        // 执行真实对象
                        Object result = method.invoke(trainStation, args);
                        return result;
                    }
                });
        return sellTickets;
    }

}

测试类Client：

/**
 * @author zzay
 * @className Client
 * @description 结构型模式-代理模式：动态代理（JDK实现）
 * @create 2022/02/27 13:33
 */
public class Client {

    public static void main(String[] args) {
        // 获取代理对象
        ProxyFactory proxyFactory = new ProxyFactory();
        SellTickets proxyObject = proxyFactory.getProxyObject();
        // 执行业务逻辑
        proxyObject.sell();
    }

}

使用了动态代理，思考以下问题：

ProxyFactory是代理类吗？

ProxyFactory不是代理模式中所说的代理类。在这种实现方式下，代理类是程序在运行过程中动态地在内存中生成的类。通过阿里巴巴开源的Java诊断工具Arthas可以查看代理类的结构：

package com.sun.proxy;

import com.itheima.proxy.dynamic.jdk.SellTickets;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;

public final class $Proxy0 extends Proxy implements SellTickets {
    
    private static Method m1;
    private static Method m2;
    private static Method m3;
    private static Method m0;

    public $Proxy0(InvocationHandler invocationHandler) {
        super(invocationHandler);
    }

    static {
        try {
            m1 = Class.forName("java.lang.Object").getMethod("equals", Class.forName("java.lang.Object"));
            m2 = Class.forName("java.lang.Object").getMethod("toString", new Class[0]);
            m3 = Class.forName("com.itheima.proxy.dynamic.jdk.SellTickets").getMethod("sell", new Class[0]);
            m0 = Class.forName("java.lang.Object").getMethod("hashCode", new Class[0]);
            return;
        }
        catch (NoSuchMethodException noSuchMethodException) {
            throw new NoSuchMethodError(noSuchMethodException.getMessage());
        }
        catch (ClassNotFoundException classNotFoundException) {
            throw new NoClassDefFoundError(classNotFoundException.getMessage());
        }
    }

    public final boolean equals(Object object) {
        try {
            return (Boolean)this.h.invoke(this, m1, new Object[]{object});
        }
        catch (Error | RuntimeException throwable) {
            throw throwable;
        }
        catch (Throwable throwable) {
            throw new UndeclaredThrowableException(throwable);
        }
    }

    public final String toString() {
        try {
            return (String)this.h.invoke(this, m2, null);
        }
        catch (Error | RuntimeException throwable) {
            throw throwable;
        }
        catch (Throwable throwable) {
            throw new UndeclaredThrowableException(throwable);
        }
    }

    public final int hashCode() {
        try {
            return (Integer)this.h.invoke(this, m0, null);
        }
        catch (Error | RuntimeException throwable) {
            throw throwable;
        }
        catch (Throwable throwable) {
            throw new UndeclaredThrowableException(throwable);
        }
    }

    public final void sell() {
        try {
            this.h.invoke(this, m3, null);
            return;
        }
        catch (Error | RuntimeException throwable) {
            throw throwable;
        }
        catch (Throwable throwable) {
            throw new UndeclaredThrowableException(throwable);
        }
    }
}

从上面的类中，我们可以看到以下几个信息：

代理类$Proxy0实现了抽象主题类SellTickets。这印证了之前所说的的真实主题类和代理类实现相同的接口。
代理类$Proxy0将我们提供的匿名内部类对象传递给了父类。

动态代理的执行流程是什么样？

下面是摘取的重点代码：

//程序运行过程中动态生成的代理类
public final class $Proxy0 extends Proxy implements SellTickets {
    private static Method m3;

    public $Proxy0(InvocationHandler invocationHandler) {
        super(invocationHandler);
    }

    static {
        m3 = Class.forName("com.itheima.proxy.dynamic.jdk.SellTickets").getMethod("sell", new Class[0]);
    }

    public final void sell() {
        this.h.invoke(this, m3, null);
    }
}

//Java提供的动态代理相关类
public class Proxy implements java.io.Serializable {
	protected InvocationHandler h;
	 
	protected Proxy(InvocationHandler h) {
        this.h = h;
    }
}

//代理工厂类
public class ProxyFactory {

    private TrainStation station = new TrainStation();

    public SellTickets getProxyObject() {
        SellTickets sellTickets = (SellTickets) Proxy.newProxyInstance(
            	station.getClass().getClassLoader(),
                station.getClass().getInterfaces(),
                new InvocationHandler() {
                    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                        System.out.println("代理点收取一些服务费用(JDK动态代理方式)");
                        Object result = method.invoke(station, args);
                        return result;
                    }
                });
        return sellTickets;
    }
    
}


//测试访问类
public class Client {
    public static void main(String[] args) {
        //获取代理对象
        ProxyFactory factory = new ProxyFactory();
        SellTickets proxyObject = factory.getProxyObject();
        proxyObject.sell();
    }
}

执行流程如下：
1. 在测试类中通过代理对象调用sell()方法。
2. 根据多态的特性，执行的是代理类$Proxy0中的sell()方法。
3. 代理类$Proxy0中的sell()方法中又调用了InvocationHandler接口的子实现类对象的invoke方法。
4. invoke方法通过反射执行真实主题对象所属类TrainStation中的sell()方法。

4.2.2 CGLIB实现

同样是上面的案例，我们再次使用CGLIB代理实现。

倘若没有定义抽象主题类SellTickets，只定义了真实主题类TrainStation，那么JDK代理将无法使用，因为JDK动态代理要求必须定义接口，对接口进行代理。

CGLIB是一个功能强大，高性能的代码生成包。它为没有实现接口的类提供代理，为JDK的动态代理提供了很好的补充。由于CGLIB是第三方提供的包，所以需要引入jar包的坐标：

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

具体实现代码如下：

代理工厂类ProxyFactory：

该类通过第三方包CGLIB自带的Enhancer（类似JDK自带的Proxy）来创建代理。

/**
 * @author zzay
 * @className ProxyFactory
 * @description 结构型模式-代理模式：动态代理（CGLIB实现）
 * @create 2022/02/27 14:22
 */
public class ProxyFactory implements MethodInterceptor {

    // 需要被创建代理的真实主题对象
    private TrainStation target = new TrainStation();

    // 创建代理对象
    public TrainStation getProxyObject() {
        // 创建Enhancer对象，类似于JDK动态代理的Proxy类，下一步就是设置几个参数
        Enhancer enhancer = new Enhancer();
        // 设置字节码对象（真实主题类）
        enhancer.setSuperclass(target.getClass());
        // 设置接口（真实主题类所实现的抽象主题接口）
        enhancer.setInterfaces(target.getClass().getInterfaces());
        // 设置回调函数
        enhancer.setCallback(this);
        // 创建代理对象
        TrainStation object = (TrainStation) enhancer.create();
        return object;
    }

    /*
    intercept方法参数说明：
        o ：      代理对象
        method ： 真实对象中的方法的Method实例
        args ：   实际参数
        methodProxy ：代理对象中的方法的method实例
     */
    public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
        System.out.println("代理点收取一些服务费用(CGLIB动态代理方式)");
        TrainStation result = (TrainStation) methodProxy.invokeSuper(o, objects);
        return result;
    }

}

测试类Client：

/**
 * @author zzay
 * @className Client
 * @description 结构型模式-代理模式：动态代理（测试类）
 * @create 2022/02/27 14:22
 */
public class Client {

    public static void main(String[] args) {
        //创建代理工厂对象
        ProxyFactory proxyFactory = new ProxyFactory();
        //获取代理对象
        TrainStation proxyObject = proxyFactory.getProxyObject();
        proxyObject.sell();
    }

}

5. 三种代理的对比

动态代理 vs 静态代理：

动态代理与静态代理相比较，最大的好处是接口中声明的所有方法都被转移到调用处理器一个集中的方法中处理（InvocationHandler.invoke(...)）。这样，在接口方法数量比较多的时候，我们可以进行灵活处理，而不需要像静态代理那样每一个方法进行中转。

如果接口增加一个方法，静态代理模式除了所有实现类需要实现这个方法外，所有代理类也需要实现此方法。增加了代码维护的复杂度。而动态代理不会出现该问题。（原因：静态代理模式的代理类需要实现抽象主题类，而动态代理模式不需要）
JDK代理 vs CGLIB代理：

CGLib底层采用ASM字节码生成框架，使用字节码技术生成代理类，在JDK1.6之前比使用Java反射效率要高。唯一需要注意的是，CGLib不能对声明为final的类或者方法进行代理，因为CGLib原理是动态生成被代理类的子类。

在JDK1.6、JDK1.7、JDK1.8逐步对JDK动态代理优化之后，在调用次数较少的情况下，JDK代理效率高于CGLib代理效率，只有当进行大量调用的时候，JDK1.6和JDK1.7比CGLib代理效率低一点，但是到JDK1.8的时候，JDK代理效率高于CGLib代理。

因此，如果有接口则使用JDK动态代理，如果没有接口使用CGLIB代理。

6. 优缺点

优点：
- 代理模式在客户端与目标对象之间起到中介作用和保护目标对象的作用。
- 代理对象可以扩展目标对象的功能。
- 代理模式能将客户端与目标对象分离，在一定程度上降低了系统的耦合度。
缺点：
- 增加了系统的复杂度。

7. 使用场景

远程（Remote）代理：

本地服务通过网络请求远程服务。为了实现本地到远程的通信，我们需要实现网络通信，处理其中可能的异常。为良好的代码设计和可维护性，我们将网络通信部分隐藏起来，只暴露给本地服务一个接口，通过该接口即可访问远程服务提供的功能，而不必过多关心通信部分的细节。
防火墙（Firewall）代理：

当你将浏览器配置成使用代理功能时，防火墙就将你的浏览器的请求转给互联网；当互联网返回响应时，代理服务器再把它转给你的浏览器。
保护（Protect or Access）代理

Zzay_naw

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
设计模式：结构型模式--代理模式（Proxy Pattern）

设计模式：结构型模式–代理模式（Proxy Pattern）文章目录设计模式：结构型模式--代理模式（Proxy Pattern）1. 引入2. 概述3. 组成结构4. 具体实现4.1 静态代理4.2 动态代理4.2.1 JDK实现4.2.2 CGLIB实现5. 三种代理的对比6. 优缺点7. 使用场景1. 引入结构型模式描述如何将类或对象按某种布局组成更大的结构。它分为类结构型模式和对象结构型模式，前者采用继承机制来组织接口和类，后者釆用组合或聚合来组合对象。由于组合关系或聚合关系比继承关系耦合度
复制链接

扫一扫