定义

在不改变原始类（或叫被代理类）的情况下，通过引入代理类来给原始类附加功能。或者是为了解耦，将业务无关的、可复用的代码提取出来作为代理类。

结构

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

代理模式(Proxy Pattern) - 图1

应用

记录请求

通过实现同一个接口

  1.     public interface IUserController {
  2.       UserVo login(String telephone, String password);
  3.       UserVo register(String telephone, String password);
  4.     }
  6. public class UserController implements IUserController {
  7.   //...省略其他属性和方法...
  9.   @Override
  10.   public UserVo login(String telephone, String password) {
  11.     //...省略login逻辑...
  12.     //...返回UserVo数据...
  13.   }
  15.   @Override
  16.   public UserVo register(String telephone, String password) {
  17.     //...省略register逻辑...
  18.     //...返回UserVo数据...
  19.   }
  20. }
  22. public class UserControllerProxy implements IUserController {
  23.   private MetricsCollector metricsCollector;
  24.   private UserController userController;
  26.   public UserControllerProxy(UserController userController) {
  27.     this.userController = userController;
  28.     this.metricsCollector = new MetricsCollector();
  29.   }
  31.   @Override
  32.   public UserVo login(String telephone, String password) {
  33.     long startTimestamp = System.currentTimeMillis();
  35.     // 委托
  36.     UserVo userVo = userController.login(telephone, password);
  38.     long endTimeStamp = System.currentTimeMillis();
  39.     long responseTime = endTimeStamp - startTimestamp;
  40.     RequestInfo requestInfo = new RequestInfo("login", responseTime, startTimestamp);
  41.     metricsCollector.recordRequest(requestInfo);
  43.     return userVo;
  44.   }
  46.   @Override
  47.   public UserVo register(String telephone, String password) {
  48.     long startTimestamp = System.currentTimeMillis();
  50.     UserVo userVo = userController.register(telephone, password);
  52.     long endTimeStamp = System.currentTimeMillis();
  53.     long responseTime = endTimeStamp - startTimestamp;
  54.     RequestInfo requestInfo = new RequestInfo("register", responseTime, startTimestamp);
  55.     metricsCollector.recordRequest(requestInfo);
  57.     return userVo;
  58.   }
  59. }
  61. //UserControllerProxy使用举例
  62. //因为原始类和代理类实现相同的接口，是基于接口而非实现编程
  63. //将UserController类对象替换为UserControllerProxy类对象，不需要改动太多代码
  64. IUserController userController = new UserControllerProxy(new UserController());

通过继承原始类

  1. public class UserControllerProxy extends UserController {
  2.   private MetricsCollector metricsCollector;
  4.   public UserControllerProxy() {
  5.     this.metricsCollector = new MetricsCollector();
  6.   }
  8.   public UserVo login(String telephone, String password) {
  9.     long startTimestamp = System.currentTimeMillis();
  11.     UserVo userVo = super.login(telephone, password);
  13.     long endTimeStamp = System.currentTimeMillis();
  14.     long responseTime = endTimeStamp - startTimestamp;
  15.     RequestInfo requestInfo = new RequestInfo("login", responseTime, startTimestamp);
  16.     metricsCollector.recordRequest(requestInfo);
  18.     return userVo;
  19.   }
  21.   public UserVo register(String telephone, String password) {
  22.     long startTimestamp = System.currentTimeMillis();
  24.     UserVo userVo = super.register(telephone, password);
  26.     long endTimeStamp = System.currentTimeMillis();
  27.     long responseTime = endTimeStamp - startTimestamp;
  28.     RequestInfo requestInfo = new RequestInfo("register", responseTime, startTimestamp);
  29.     metricsCollector.recordRequest(requestInfo);
  31.     return userVo;
  32.   }
  33. }
  34. //UserControllerProxy使用举例
  35. UserController userController = new UserControllerProxy();

相对于下文的动态代理，上述方式可称为静态代理。静态代理需要为每个原始类编写代理类，即便代理类的实现相同。

业务系统的非功能性需求开发

在业务系统中开发一些非功能性需求，比如：监控、统计、鉴权、限流、事务、幂等、日志。

RPC

实际上，RPC 框架也可以看作一种代理模式，GoF 的《设计模式》一书中把它称作远程代理。通过远程代理，将网络通信、数据编解码等细节隐藏起来。客户端在使用 RPC 服务的时候，就像使用本地函数一样，无需了解跟服务器交互的细节。除此之外，RPC 服务的开发者也只需要开发业务逻辑，就像开发本地使用的函数一样，不需要关注跟客户端的交互细节。

缓存

假设我们要开发一个接口请求的缓存功能，对于某些接口请求，如果入参相同，在设定的过期时间内，直接返回缓存结果，而不用重新进行逻辑处理。对于这样的功能可以通过spring aop来实现。

扩展

动态代理

在运行的时候动态地创建原始类对应的代理类，然后在系统中用代理类替换掉原始类。

  1. public class MetricsCollectorProxy {
  2.   private MetricsCollector metricsCollector;
  4.   public MetricsCollectorProxy() {
  5.     this.metricsCollector = new MetricsCollector();
  6.   }
  8.   public Object createProxy(Object proxiedObject) {
  9.     Class<?>[] interfaces = proxiedObject.getClass().getInterfaces();
  10.     DynamicProxyHandler handler = new DynamicProxyHandler(proxiedObject);
  11.     return Proxy.newProxyInstance(proxiedObject.getClass().getClassLoader(), interfaces, handler);
  12.   }
  14.   private class DynamicProxyHandler implements InvocationHandler {
  15.     private Object proxiedObject;
  17.     public DynamicProxyHandler(Object proxiedObject) {
  18.       this.proxiedObject = proxiedObject;
  19.     }
  21.     @Override
  22.     public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
  23.       long startTimestamp = System.currentTimeMillis();
  24.       Object result = method.invoke(proxiedObject, args);
  25.       long endTimeStamp = System.currentTimeMillis();
  26.       long responseTime = endTimeStamp - startTimestamp;
  27.       String apiName = proxiedObject.getClass().getName() + ":" + method.getName();
  28.       RequestInfo requestInfo = new RequestInfo(apiName, responseTime, startTimestamp);
  29.       metricsCollector.recordRequest(requestInfo);
  30.       return result;
  31.     }
  32.   }
  33. }
  35. //MetricsCollectorProxy使用举例
  36. MetricsCollectorProxy proxy = new MetricsCollectorProxy();
  37. IUserController userController = (IUserController) proxy.createProxy(new UserController());

动态代理的一些成功案例如Spring AOP和Mybatis等