跳至主要內容

结构型代理模式

gavin-james设计模式设计模式大约 12 分钟

代理模式的基本介绍

在有些情况下，一个客户不能或者不想直接访问另一个对象，这时需要找一个中介帮忙完成某项任务，这个中介就是代理对象。例如，购买火车票不一定要去火车站买，可以通过 12306 网站或者去火车票代售点买。又如找女朋友、找保姆、找工作等都可以通过找中介完成。

在软件设计中，使用代理模式的例子也很多，例如，要访问的远程对象比较大（如视频或大图像等），其下载要花很多时间。还有因为安全原因需要屏蔽客户端直接访问真实对象，如某单位的内部数据库等。

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

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

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

主要优点

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

主要缺点

  • 代理模式会造成系统设计中类的数量增加
  • 在客户端和目标对象之间增加一个代理对象，会造成请求处理速度变慢
  • 增加了系统的复杂度

代理模式示意图：

image-20220314192143394
image-20220314192143394

静态代理

静态代理基本介绍

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

代理模式的主要角色如下：

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

在代码中，一般代理会被理解为代码增强，实际上就是在原代码逻辑前后增加一些代码逻辑，而使调用者无感知。

静态代理应用实例

  • 定义一个接口：ITeacherDao
  • 目标对象 TeacherDAO 实现接口 ITeacherDAO
  • 使用静态代理方式，就需要在代理对象 TeacherDAOProxy 中也实现 ITeacherDAO
  • 调用的时候通过调用代理对象的方法来调用目标对象

特别提醒：代理对象与目标对象要实现相同的接口，然后通过调用相同的方法来调用目标对象的方法。

思路分析图解（类图）

image-20220316213701600
image-20220316213701600

代码实现

// 接口
public interface ITeacherDao {
    void teach(); // 授课的方法
}
// 被代理对象，目标对象，实际访问的对象
public class TeacherDao implements ITeacherDao {
    @Override
    public void teach() {
        System.out.println(" 老师授课中");
    }
}
// 代理对象，静态代理
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("40 分钟后下课"); // 方法
    }
}

测试类

public class Client {

    public static void main(String[] args) {
        // 创建目标对象（被代理对象）
        TeacherDao teacherDao = new TeacherDao();

        // 创建代理对象, 同时将被代理对象传递给代理对象
        TeacherDaoProxy teacherDaoProxy = new TeacherDaoProxy(teacherDao);

        // 通过代理对象，调用到被代理对象的方法
        // 即：执行的是代理对象的方法，代理对象再去调用目标对象的方法 
        teacherDaoProxy.teach();
    }
}

静态代理优缺点

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

动态代理

动态代理基本介绍

代理对象，不需要实现接口，但是目标对象要实现接口，否则不能用动态代理。

代理对象的生成，是利用 JDK 的 API，动态的在内存中构建代理对象。

动态代理也叫做：JDK 代理、接口代理。

JDK 中生成代理对象的 API

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

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

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

人性化解释

  • 我们已经写了一个对象，这个对象已经成型（目标对象，旧对象）
  • 时代变化，新功能出现，但是原来的目标对象成型，很难添加新的东西，于是我们需要重新造出一个对象
  • 要求新的对象有旧的对象的所有功能，同时添加新的功能，于是需要 Proxy 动态代理（母亲）
  • 怎么造出新对象呢，我们首先需要旧对象的基因（类加载器）和该对象的父类基因（类的父接口）
  • 研究旧对象和其父亲的基因，造出新的对象，并且在造出的过程添加新的功能，于是新的对象更加全面
image-20220325225306403
image-20220325225306403

动态代理应用实例

将前面的静态代理改进成动态代理模式（即：JDK 代理模式）。

类图

image-20220316215716168
image-20220316215716168

代码实现

// 接口
public interface ITeacherDao {
	void teach(); // 授课方法
	void sayHello(String name);
}
public class TeacherDao implements ITeacherDao {

	@Override
	public void teach() {
		System.out.println(" 老师授课中.... ");
	}

	@Override
	public void sayHello(String name) {
		System.out.println("hello " + name);
	}
}

动态代理类

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;
                }
            }); 
    }
}

测试类

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 ");
	}
}

Cglib 代理

Cglib 代理基本介绍

静态代理和 JDK 代理模式都要求目标对象是实现一个接口，但是有时候目标对象只是一个 单独的对象，并没有 实现任何的接口，这个时候可使用目标对象子类来实现代理，这就是 Cglib 代理。

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

Cglib 是一个强大的高性能的代码生成包，它可以在运行期扩展 Java 类与实现 Java 接口。它广泛的被许多 AOP 的框架使用，例如 Spring AOP，实现方法拦截。

在 AOP 编程中如何选择代理模式：

  • 目标对象需要实现接口，用 JDK 代理
  • 目标对象不需要实现接口，用 Cglib 代理

Cglib 包的底层是通过使用字节码处理框架 ASM 来转换字节码并生成新的类。

image-20220325225354561
image-20220325225354561

思路

  1. 创建目标对象

  2. 创建增强器，相当于JDK动态代理需要的 父接口

  3. 设置要生成代理对象的目标对象的类

  4. 设置回调方法，里面指定生成目标对象的过程

  5. 执行生成目标对象

  6. 执行目标对象的方法

人性化解释

  • 我们已经写了一个对象，这个对象已经成型（目标对象）
  • 时代变化，新功能出现，但是原来的对象成型，很难添加新的东西，于是我们需要重新造出一个对象
  • 要求新的对象有旧的对象的所有功能，同时添加新的功能，于是需要 Proxy 动态代理（母亲）
  • 怎么造出新对象呢，我们先造出代理对象的雏形（形状），然后给雏形找个父亲（目标对象的类）
  • 让父亲和母亲造出新的对象，然后放进这个雏形（形状）里，并且在造出的过程添加新的功能，于是新的对象更加全面

Cglib 代理模式应用实例

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

image-20220316220549595
image-20220316220549595

代码实现

// Cglib 代理不需要接口
public class TeacherDao {

	public String teach() {
		System.out.println(" 老师授课中 ，我是cglib代理，不需要实现接口 ");
		return "hello";
	}
}

Cglib 代码类

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

    // 上面设置回调的 this 和重写 intercept 等价于
    enhancer.setCallback(new MethodInterceptor() {
        @Override
        public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
            System.out.println("Cglib 代理模式 ~~ 开始");
            Object returnVal = method.invoke(target, args);
            System.out.println("Cglib 代理模式 ~~ 提交");
            return returnVal;
        }
    }); // 设置回调
}

测试类

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);
	}
}

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

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

几种常见的代理模式介绍

防火墙代理

内网通过代理穿透防火墙，实现对公网的访问。

缓存代理

比如：当请求图片文件等资源时，先到缓存代理取，如果取到资源则 OK，如果取不到资源，再到公网或者数据库取，然后缓存。

远程代理

远程对象的本地代表，通过它可以把远程对象当本地对象来调用。远程代理通过网络和真正的远程对象沟通信息。

同步代理

主要使用在多线程编程中，完成多线程间同步工作。

代理模式的应用场景

当无法或不想直接引用某个对象或访问某个对象存在困难时，可以通过代理对象来间接访问。使用代理模式主要有两个目的：一是保护目标对象，二是增强目标对象。

前面分析了代理模式的结构与特点，现在来分析以下的应用场景：

  • 远程代理，这种方式通常是为了隐藏目标对象存在于不同地址空间的事实，方便客户端访问。例如，用户申请某些网盘空间时，会在用户的文件系统中建立一个虚拟的硬盘，用户访问虚拟硬盘时实际访问的是网盘空间
  • 虚拟代理，这种方式通常用于要创建的目标对象开销很大时。例如，下载一幅很大的图像需要很长时间，因某种计算比较复杂而短时间无法完成，这时可以先用小比例的虚拟代理替换真实的对象，消除用户对服务器慢的感觉
  • 安全代理，这种方式通常用于控制不同种类客户对真实对象的访问权限
  • 智能指引，主要用于调用目标对象时，代理附加一些额外的处理功能。例如，增加计算真实对象的引用次数的功能，这样当该对象没有被引用时，就可以自动释放它
  • 延迟加载，指为了提高系统的性能，延迟对目标的加载。例如，Hibernate 中就存在属性的延迟加载和关联表的延时加载
本文章大部分来自pdai:地址https://www.pdai.tech
Copyright © 2023 gavin-james