设计模式——代理模式

dzWatching

已于 2023-03-18 18:59:50 修改

阅读量399

点赞数 2

文章标签：代理模式设计模式 java

于 2023-03-18 18:55:12 首次发布

本文链接：https://blog.csdn.net/qq_47155894/article/details/129640573

版权

代理模式

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

Java中的代理按照代理类生成时机不同又分为静态代理和动态代理。静态代理代理类在编译期就生成，而动态代理代理类则是在Java运行时动态生成。动态代理又有JDK代理和CGLib代理两种。

代理（Proxy）模式分为三种角色：

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

静态代理

我们通过案例来感受一下静态代理。

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

/**
 * @author Watching
 * * @date 2023/3/17
 * * Describe:买票接口
 */
public interface SellTickets {
    void sell();
}

火车站
火车站也有买票功能，所以需要实现买票接口并重写接口中的方法

/**
 * @author Watching
 * * @date 2023/3/17
 * * Describe:火车站
 */
public class RailwayStation implements SellTickets {
    @Override
    public void sell() {
        System.out.println("卖出一张火车票");
    }
}

代售点（代理类）

/**
 * @author Watching
 * * @date 2023/3/17
 * * Describe:
 */
public class ProxyPoints implements SellTickets {
    //声明目标对象
    private RailwayStation railwayStation = new RailwayStation();

	//增强代码+目标方法
    @Override
    public void sell() {
        System.out.println("售票代理网点收取一定费用");
        //调用目标对象的目标方法
        railwayStation.sell();
    }
}

可以看到在代理类中，代理类同样实现了买票接口，并且将目标对象注入进来。代理类提供了一个售票方法，并且在售票方法中调用了目标对象的目标方法，在执行目标对象的目标方法之前，可以编写代码对目标方法进行增强。

测试类

/**
 * @author Watching
 * * @date 2023/3/17
 * * Describe:
 */
public class Client {
    public static void main(String[] args) {
        ProxyPoints proxyPoints = new ProxyPoints();
        proxyPoints.sell();
    }
}

测试类中创建了代理类的对象，并调用了代理类的方法。实际上是调用了（增强代码+目标方法）

JDK动态代理

接下来我们使用动态代理实现上面案例，先说说JDK提供的动态代理。Java中提供了一个动态代理类Proxy，Proxy并不是我们上述所说的代理对象的类，而是提供了一个创建代理对象的静态方法
（newProxyInstance方法）来获取代理对象。
目标类和抽象接口代码不变

代理对象工厂类

/**
 * @author Watching
 * * @date 2023/3/17
 * * Describe:代理工厂
 * ProxyFactory不是代理模式中所说的代理类，而代理类是程序在运行过程中动态的在内存中生
 * 成的类。
 */
public class ProxyFactory {
    //创建目标对象
    private static RailwayStation railwayStation = new RailwayStation();

    //提供一个方法让外界获取代理对象
    public static SellTickets getProxyObject(){
        //使用Proxy获取代理对象
        /*
        newProxyInstance()方法参数说明：
                ClassLoader loader : 类加载器，用于加载代理类，使用真实对象的类加载器即可
                Class<?>[] interfaces : 真实对象所实现的接口，代理模式真实对象和代理对象实现相同的接口
                InvocationHandler h : 代理对象的调用处理程序
        */

        SellTickets sellTickets = (SellTickets) Proxy.newProxyInstance(
                RailwayStation.class.getClassLoader(),
                RailwayStation.class.getInterfaces(),//获取目标对象实现的接口
                new InvocationHandler() {
                    /*
                        InvocationHandler中invoke方法参数说明：
                            proxy ： 代理对象
                            method ： 对应于在代理对象上调用的接口方法的 Method 实例
                            args ： 代理对象调用接口方法时传递的实际参数
                    */
                    @Override
                    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                        System.out.println("火车票代理站点收取手续费");
                        Object invoke = method.invoke(railwayStation, args);
                        return invoke;
                    }
                }
        );
        return sellTickets;
    }
}

代理对象工厂类，顾名思义就是创建代理对象的工厂。在该类中注入了目标对象，并且创建了一个方法**getProxyObject()**用于外界获取代理对象。
在该方法中使用jdk提供的Proxy代理类的静态方法 newProxyInstance() 创建代理对象。
该方法中有一个重要参数 new InvocationHandler() 它是一个匿名内部类，它内部需要重写一个 invoke方法
这个invoke方法就是代理对象最终会调用的方法。在这个方法内部又会调用原本的目标方法。
所以增强代码就可以写在invoke方法中
测试类


/**
 * @author Watching
 * * @date 2023/3/17
 * * Describe:
 */
public class Client {
    public static void main(String[] args) {
        SellTickets proxyObject = ProxyFactory.getProxyObject();
        proxyObject.sell();
    }
}

ProxyFactory不是代理模式中所说的代理类，而代理类是程序在运行过程中动态的在内存中生
成的类，具体可以通过阿里巴巴开源的 Java 诊断工具（Arthas【阿尔萨斯】）查看代理类的结构

cglib动态代理

同样是上面的案例，我们再次使用CGLIB代理实现。
如果没有定义SellTickets接口，只定义了RailwayStation(火车站类)。很显然JDK代理是无法使用
了，因为JDK动态代理要求必须定义接口，对接口进行代理。
CGLIB是一个功能强大，高性能的代码生成包。它为没有实现接口的类提供代理，为JDK的动态代理提供了很好的补充。
cglib jar包

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

cglib动态代理不需要接口了，直接在RaiwayStation中编写sell()方法
火车站类

/**
 * @author Watching
 * * @date 2023/3/17
 * * Describe:火车站
 */
public class RailwayStation  {
    public void sell() {
        System.out.println("火车售票");
    }
}

代理工厂类

/**
 * @author Watching
 * * @date 2023/3/17
 * * Describe:代理工厂
 * ProxyFactory不是代理模式中所说的代理类，而代理类是程序在运行过程中动态的在内存中生成的类。
 * cglib生成的代理类属于目标类的子类
 */
//代理工厂
public class ProxyFactory implements MethodInterceptor {
    private RailwayStation target = new RailwayStation();

    public RailwayStation getProxyObject() {
    //创建Enhancer对象，类似于JDK动态代理的Proxy类，下一步就是设置几个参数
        Enhancer enhancer = new Enhancer();
    //设置父类的字节码对象
        enhancer.setSuperclass(target.getClass());
    //设置回调函数
        enhancer.setCallback(this);
    //创建代理对象
        RailwayStation obj = (RailwayStation) enhancer.create();
        return obj;
    }
    /*
         intercept方法参数说明：
            o : 代理对象
            method : 真实对象中的方法的Method实例
            args : 实际参数
            methodProxy : 代理对象中的方法的method实例
    */
    public RailwayStation intercept(Object o, Method method, Object[] args,
                                    MethodProxy methodProxy) throws Throwable {

        System.out.println("代理点收取一些服务费用(CGLIB动态代理方式)");

        RailwayStation result = (RailwayStation) methodProxy.invokeSuper(o,
                args);
        return result;
    }
}

测试类

/**
 * @author Watching
 * * @date 2023/3/18
 * * Describe:
 */
public class Client {
    public static void main(String[] args) {
        ProxyFactory proxyFactory = new ProxyFactory();
        RailwayStation proxyObject = proxyFactory.getProxyObject();
        proxyObject.sell();
    }
}

三种代理的对比

jdk代理和CGLIB代理
使用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代理。
动态代理和静态代理
动态代理与静态代理相比较，最大的好处是接口中声明的所有方法都被转移到调用处理器一个集中的方法中处理（InvocationHandler.invoke）。这样，在接口方法数量比较多的时候，我们
可以进行灵活处理，而不需要像静态代理那样每一个方法进行中转。
如果接口增加一个方法，静态代理模式除了所有实现类需要实现这个方法外，所有代理类也需要实现此方法。增加了代码维护的复杂度。 而动态代理不会出现该问题

优缺点

优点：

代理模式在客户端与目标对象之间起到一个中介作用和保护目标对象的作用；
代理对象可以扩展目标对象的功能；
代理模式能将客户端与目标对象分离，在一定程度上降低了系统的耦合度；

缺点：

增加了系统的复杂度；

应用场景

远程（Remote）代理
本地服务通过网络请求远程服务。为了实现本地到远程的通信，我们需要实现网络通信，处理其中
可能的异常。为良好的代码设计和可维护性，我们将网络通信部分隐藏起来，只暴露给本地服务一
个接口，通过该接口即可访问远程服务提供的功能，而不必过多关心通信部分的细节。
防火墙（Firewall）代理
当你将浏览器配置成使用代理功能时，防火墙就将你的浏览器的请求转给互联网；当互联网返回响
应时，代理服务器再把它转给你的浏览器。
保护（Protect or Access）代理
控制对一个对象的访问，如果需要，可以给不同的用户提供不同级别的使用权限。