07 结构型模式之代理模式（Proxy）

最新推荐文章于 2021-12-30 16:25:52 发布

wyaoyao93

最新推荐文章于 2021-12-30 16:25:52 发布

阅读量144

点赞数

分类专栏：设计模式 java

本文链接：https://blog.csdn.net/wyaoyao93/article/details/111032658

版权

java 同时被 2 个专栏收录

51 篇文章 0 订阅

订阅专栏

设计模式

17 篇文章 1 订阅

订阅专栏

文章目录

1 结构型模式

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

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

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

代理模式
适配器模式
装饰者模式
桥接模式
外观模式
组合模式
享元模式

2 代理模式介绍

2.1 概述

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

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

2.1 角色

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

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

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

在这里插入图片描述

3 静态代理

在这里插入图片描述

定义售票接口: 抽象主题（Subject）类

package study.wyy.design.proxy.staticproxy;

/**
 * @author by wyaoyao
 * @Description
 * @Date 2020/12/11 3:03 下午
 */
public interface SellTicket {

    /**
     *  @author: wyaoyao
     *  @Date: 2020/12/11 3:04 下午
     *  @Description: 售票
     */
    void sellTicket(String IDCard);
}

定义火车站：目标类

package study.wyy.design.proxy.staticproxy;

/**
 * @author by wyaoyao
 * @Description
 * @Date 2020/12/11 3:04 下午
 * 火车站，火车站具有卖票功能，所以需要实现SellTickets接口
 */
public class TrainStation implements SellTicket{

    @Override
    public void sellTicket(String IDCard) {
        System.out.println("火车站售票");
    }
}

代售点：代理类

package study.wyy.design.proxy.staticproxy;

/**
 * @author by wyaoyao
 * @Description
 * @Date 2020/12/11 3:08 下午
 * 代售点
 */
public class ProxySellPoint implements SellTicket{

    private TrainStation trainStation;

    public ProxySellPoint(TrainStation trainStation) {
        this.trainStation = trainStation;
    }

    @Override
    public void sellTicket(String IDCard) {
        System.out.println("代售点收取服务费");
        trainStation.sellTicket(IDCard);
    }
}

测试

  public static void main(String[] args) {
       TrainStation trainStation = new TrainStation();
       ProxySellPoint proxySellPoint = new ProxySellPoint(trainStation);
       proxySellPoint.sellTicket("12312312");
   }

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

4 动态代理

4.1 JDK动态代理

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

4.1.1 API介绍

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

参数介绍：

ClassLoader loader: 类加载器，用于加载代理类，使用真实对象的类加载器即可
Class<?>[] interfaces: 真实对象所实现的接口，代理模式真实对象和代理对象实现相同的接口，比如我们这个场景就是售票接口SellTicket
InvocationHandler h ：代理对象的调用处理程序

返回值：返回的就是代理对象

InvocationHandler接口：

package java.lang.reflect;

/**
 * @author      Peter Jones
 * @see         Proxy
 * @since       1.3
 */
public interface InvocationHandler {
    public Object invoke(Object proxy, Method method, Object[] args)
        throws Throwable;
}

Object proxy: 代理对象
Method method: 对应于在代理对象上调用的接口方法的 Method 实例
Object[] args ：代理对象调用接口方法时传递的实际参数
返回值：返回目标对象目标方法（这里就是sellTicket方法）的返回值

4.1.2 演示

定义售票接口: 抽象主题（Subject）类

package study.wyy.design.proxy.jdkproxy;

import lombok.Builder;

/**
 * @author by wyaoyao
 * @Description
 * @Date 2020/12/11 5:15 下午
 * 简单定义一个票model
 */
@Builder
@ToString
public class Ticket {

    // 所有者
    private final String owner;
    // 目的地
    private final String targetAddress;
    // 出发地
    private final String sourceAddress;
    // 票钱
    private final Long price;
    // 座位号
    private final String seat;


    public Ticket(String owner, String targetAddress, String sourceAddress, Long price, String seat) {
        this.owner = owner;
        this.targetAddress = targetAddress;
        this.sourceAddress = sourceAddress;
        this.price = price;
        this.seat = seat;
    }
}

package study.wyy.design.proxy.jdkproxy;

/**
 * @author by wyaoyao
 * @Description
 * @Date 2020/12/11 3:03 下午
 */
public interface SellTicket {


    /**
    * @Description
    * @Author  wyaoyao
    * @Date   2020/12/11 5:17 下午
    * @Param    targetAddress: 目的地； sourceAddress：出发地， name姓名
    * @Return
    * @Exception
    */
    Ticket sellTicket(String name,String targetAddress,String sourceAddress);
}

定义火车站：目标类

package study.wyy.design.proxy.jdkproxy;

/**
 * @author by wyaoyao
 * @Description
 * @Date 2020/12/11 5:19 下午
 */
public class TrainStation implements SellTicket{


    @Override
    public Ticket sellTicket(String name, String targetAddress, String sourceAddress) {
        Ticket ticket = Ticket.builder()
                .owner(name)
                .targetAddress(targetAddress)
                .sourceAddress(sourceAddress)
                .seat(generateSeat())
                .price(calPrice(targetAddress, sourceAddress))
                .build();
       System.out.println("生成车票");
        return ticket;
    }

    /****
     * 模拟生成一个座位号
     * @return
     */
    protected String generateSeat(){
        // 直接返回一个
        return "8排6号";
    }

    /****
     * 计算价钱
     * @returns
     */
    protected Long calPrice(String targetAddress, String sourceAddress){
        // 直接返回一个
        return 100L;
    }
}

生成一个代理类

package study.wyy.design.proxy.jdkproxy;

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

/**
 * @author by wyaoyao
 * @Description
 * @Date 2020/12/11 5:49 下午
 * 代理工厂
 */
public class ProxyFactory {

    // 目标对象
    private TrainStation station = new TrainStation();


    public SellTicket getProxyObject(){
        /**
         *  ClassLoader loader: 类加载器
         *  Class<?>[] interfaces: 真实对象所实现的接口，代理模式真实对象和代理对象实现相同的接口，比如我们这个场景就是售票接口SellTicket
         *  InvocationHandler h: 代理对象的调用处理程序
         *  返回值：返回的就是代理对象
         */
        SellTicket proxyInstance = (SellTicket) Proxy.newProxyInstance(this.getClass().getClassLoader(),
                new Class[]{SellTicket.class}, new InvocationHandler() {
                    /**
                     * `Object proxy`:  代理对象
                     * ` Method method`:  对应于在代理对象上调用的接口方法的 Method 实例
                     * `Object[] args` ： 代理对象调用接口方法时传递的实际参数
                     * 返回值：返回目标对象目标方法（sellTicket）的返回值
                     */
                    @Override
                    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                        System.out.println("=================打印形参====================");
                        System.out.println("proxy类型：" + proxy.getClass().getName());
                        System.out.println("method：" + method.getName());
                        for (Object o :args) {
                            System.out.println("args：" + o);
                        }
                        System.out.println("=================打印形参====================");

                        // 执行目标对象目标方法：火车站的售票方法
                        // 这里可以增加前置处理
                        System.out.println("前置处理。。。。。。");
                        Object invoke = method.invoke(station, args);
                        // 这里可以增加后置处理
                        System.out.println("后置处理。。。。。。");
                        // 返回目标方法的返回值
                        return invoke;
                    }
                });
        return proxyInstance;
    }
}

测试

public static void main(String[] args) {
    ProxyFactory proxyFactory = new ProxyFactory();
    SellTicket proxyObject = proxyFactory.getProxyObject();
    Ticket ticket = proxyObject.sellTicket("john", "杭州", "北京");
    System.out.println(ticket);
}

=================打印形参====================
proxy类型：com.sun.proxy.$Proxy0
method：sellTicket
args：john
args：杭州
args：北京
=================打印形参====================
前置处理。。。。。。
生成车票
后置处理。。。。。。
Ticket(owner=john, targetAddress=杭州, sourceAddress=北京, price=100, seat=8排6号)

4.1.3 jdk实现代理分析

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 SellTicket {
    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;
    }
}

执行流程如下：

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

4.2 CGLIB动态代理

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

CGLIB代理是不需要接口的，是通过继承实现的，jdk代理是通过接口实现的

如果没有定义SellTickets接口，只定义了TrainStation(火车站类)。很显然JDK代理是无法使用了，因为JDK动态代理要求必须定义接口，对接口进行代理。

CGLIB是一个功能强大，高性能的代码生成包。它为没有实现接口的类提供代理，为JDK的动态代理提供了很好的补充。

CGLIB是第三方提供的包，所以需要引入jar包的坐标：

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

定义火车站：目标类

package study.wyy.design.proxy.cglib;



/**
 * @author by wyaoyao
 * @Description
 * @Date 2020/12/11 5:19 下午
 * 这里火车站只有一个方法，cglig会把增强这个类的的所有public方法
 * 这里为了测试，计算价钱这个方法改为public
 */
public class TrainStation {
   public Ticket sellTicket(String name, String targetAddress, String sourceAddress) {
       Ticket ticket = Ticket.builder()
                .owner(name)
                .targetAddress(targetAddress)
                .sourceAddress(sourceAddress)
                .seat(generateSeat())
                .price(calPrice(targetAddress, sourceAddress))
                .build();
        System.out.println("生成车票");
        return ticket;
    }

    /****
     * 模拟生成一个座位号
     * @return
     */
    protected String generateSeat(){
        // 直接返回一个
        return "8排6号";
    }

    /****
     * 计算价钱这个方法改为public
     * @returns
     */
    public Long calPrice(String targetAddress, String sourceAddress){
        // 直接返回一个
        return 100L;
    }

}

创建代理

package study.wyy.design.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;

/**
 * @author by wyaoyao
 * @Description
 * @Date 2020/12/11 5:49 下午
 * 代理工厂
 */
public class ProxyFactory {

    // 目标对象
    private TrainStation station = new TrainStation();

    public TrainStation getProxyObject(){
        //1 创建Enhancer对象，类似于JDK动态代理的Proxy类，下一步就是设置几个参数
        Enhancer enhancer =new Enhancer();
        //2 设置父类的字节码对象
        enhancer.setSuperclass(TrainStation.class);
        //3 设置回调函数
        enhancer.setCallback(new MethodInterceptor(){
            /*
        intercept方法参数说明：
            o ： 代理对象
            method ： 真实对象中的方法的Method实例
            args ： 实际参数
            methodProxy ：代理对象中的方法的method实例
            */
            @Override
            public Object intercept(Object proxy, Method method, Object[] args, MethodProxy methodProxy) throws Throwable {
                System.out.println("=================打印形参====================");
                System.out.println("proxy类型：" + proxy.getClass().getName());
                System.out.println("method：" + method.getName());
                for (Object o :args) {
                    System.out.println("args：" + o);
                }
                System.out.println("=================打印形参====================");
                // 执行目标对象目标方法：火车站的售票方法
                // 这里可以增加前置处理
                System.out.println("前置处理。。。。。。");
                Object result = methodProxy.invoke(station, args);
                // 这里可以增加后置处理
                System.out.println("后置处理。。。。。。");
                return result;
            }
        });
        //4 创建代理对象
        TrainStation obj = (TrainStation) enhancer.create();
        return obj;
    }
}

测试

package study.wyy.design.proxy.cglib;



/**
 * @author by wyaoyao
 * @Description
 * @Date 2020/12/11 7:37 下午
 */
public class Client {
    public static void main(String[] args) {
        //创建代理工厂对象
        ProxyFactory factory = new ProxyFactory();
        //获取代理对象
        TrainStation proxyObject = factory.getProxyObject();
		System.out.println("<测试sellTicket方法>");
        Ticket ticket = proxyObject.sellTicket("john", "杭州", "北京");
        System.out.println(ticket);

        System.out.println("<测试calPrice方法>");
        proxyObject.calPrice("青海", "北京");

    }
}

输出

<测试sellTicket方法>
=================打印形参====================
proxy类型：study.wyy.design.proxy.cglib.TrainStation$$EnhancerByCGLIB$$41a7aa5e
method：sellTicket
args：john
args：杭州
args：北京
=================打印形参====================
前置处理。。。。。。
生成车票
后置处理。。。。。。
Ticket(owner=john, targetAddress=杭州, sourceAddress=北京, price=100, seat=8排6号)
<测试calPrice方法>
=================打印形参====================
proxy类型：study.wyy.design.proxy.cglib.TrainStation$$EnhancerByCGLIB$$41a7aa5e
method：calPrice
args：青海
args：北京
=================打印形参====================
前置处理。。。。。。
后置处理。。。。。。

5 三种代理的对比

jdk代理和CGLIB代理

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

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

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

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

5.1 优缺点

优点：

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

缺点：

增加了系统的复杂度；

5.2 使用场景

远程（Remote）代理

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

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

控制对一个对象的访问，如果需要，可以给不同的用户提供不同级别的使用权限。

wyaoyao93

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
07 结构型模式之代理模式（Proxy）

文章目录1 结构型模式2 代理模式介绍2.1 概述2.1 角色3 静态代理4 动态代理4.1 JDK动态代理4.1.1 API介绍4.1.2 演示4.1.3 jdk实现代理分析4.2 CGLIB动态代理5 三种代理的对比5.1 优缺点5.2 使用场景1 结构型模式结构型模式描述如何将类或对象按某种布局组成更大的结构。它分为类结构型模式和对象结构型模式，前者采用继承机制来组织接口和类，后者釆用组合或聚合来组合对象。由于组合关系或聚合关系比继承关系耦合度低，满足“合成复用原则”，所以对象结构型模式比类结构
复制链接

扫一扫