代理模式的原理解析入门

什么是代理模式?

它在不改变原始类（或叫被代理类）代码的情况下，通过引入代理类来给原始类附加功能。

我们通过一个简单的例子来解释一下这段话。

这个例子来自我们在第 25、26、39、40 节中讲的性能计数器。当时我们开发了一个 MetricsCollector 类，用来收集接口请求的原始数据，比如访问时间、处理时长等。在业务系统中，我们采用如下方式来使用这个 MetricsCollector 类：


public class UserController {//...省略其他属性和方法...private MetricsCollector metricsCollector; // 依赖注入public UserVo login(String telephone, String password) {long startTimestamp = System.currentTimeMillis();// ... 省略login逻辑...long endTimeStamp = System.currentTimeMillis();long responseTime = endTimeStamp - startTimestamp;RequestInfo requestInfo = new RequestInfo("login", responseTime, startTimestamp);metricsCollector.recordRequest(requestInfo);//...返回UserVo数据...}public UserVo register(String telephone, String password) {long startTimestamp = System.currentTimeMillis();// ... 省略register逻辑...long endTimeStamp = System.currentTimeMillis();long responseTime = endTimeStamp - startTimestamp;RequestInfo requestInfo = new RequestInfo("register", responseTime, startTimestamp);metricsCollector.recordRequest(requestInfo);//...返回UserVo数据...}
}

很明显，上面的写法有两个问题。
第一，性能计数器框架代码侵入到业务代码中，跟业务代码高度耦合。如果未来需要替换这个框架，那替换的成本会比较大。

第二，收集接口请求的代码跟业务代码无关，本就不应该放到一个类中。业务类最好职责更加单一，只聚焦业务处理。

为了将框架代码和业务代码解耦，代理模式就派上用场了。

代理类 UserControllerProxy 和原始类 UserController 实现相同的接口 IUserController。
UserController 类只负责业务功能。
代理类 UserControllerProxy 负责在业务代码执行前后附加其他逻辑代码，并通过委托的方式调用原始类来执行业务代码。

具体的代码实现如下所示：


public interface IUserController {UserVo login(String telephone, String password);UserVo register(String telephone, String password);
}public class UserController implements IUserController {//...省略其他属性和方法...@Overridepublic UserVo login(String telephone, String password) {//...省略login逻辑...//...返回UserVo数据...}@Overridepublic UserVo register(String telephone, String password) {//...省略register逻辑...//...返回UserVo数据...}
}public class UserControllerProxy implements IUserController {private MetricsCollector metricsCollector;private UserController userController;public UserControllerProxy(UserController userController) {this.userController = userController;this.metricsCollector = new MetricsCollector();}@Overridepublic UserVo login(String telephone, String password) {long startTimestamp = System.currentTimeMillis();// 委托UserVo userVo = userController.login(telephone, password);long endTimeStamp = System.currentTimeMillis();long responseTime = endTimeStamp - startTimestamp;RequestInfo requestInfo = new RequestInfo("login", responseTime, startTimestamp);metricsCollector.recordRequest(requestInfo);return userVo;}@Overridepublic UserVo register(String telephone, String password) {long startTimestamp = System.currentTimeMillis();UserVo userVo = userController.register(telephone, password);long endTimeStamp = System.currentTimeMillis();long responseTime = endTimeStamp - startTimestamp;RequestInfo requestInfo = new RequestInfo("register", responseTime, startTimestamp);metricsCollector.recordRequest(requestInfo);return userVo;}
}//UserControllerProxy使用举例
//因为原始类和代理类实现相同的接口，是基于接口而非实现编程
//将UserController类对象替换为UserControllerProxy类对象，不需要改动太多代码
IUserController userController = new UserControllerProxy(new UserController());

参照基于接口而非实现编程的设计思想，将原始类对象替换为代理类对象的时候，为了让代码改动尽量少，在刚刚的代理模式的代码实现中，代理类和原始类需要实现相同的接口。

但是，如果原始类并没有定义接口，并且原始类代码并不是我们开发维护的（比如它来自一个第三方的类库），我们也没办法直接修改原始类，给它重新定义一个接口。在这种情况下，我们该如何实现代理模式呢？

对于这种外部类的扩展，我们一般都是采用继承的方式。这里也不例外。我们让代理类继承原始类，然后扩展附加功能。原理很简单，不需要过多解释，你直接看代码就能明白。具体代码如下所示：


public class UserControllerProxy extends UserController {private MetricsCollector metricsCollector;public UserControllerProxy() {this.metricsCollector = new MetricsCollector();}public UserVo login(String telephone, String password) {long startTimestamp = System.currentTimeMillis();UserVo userVo = super.login(telephone, password);long endTimeStamp = System.currentTimeMillis();long responseTime = endTimeStamp - startTimestamp;RequestInfo requestInfo = new RequestInfo("login", responseTime, startTimestamp);metricsCollector.recordRequest(requestInfo);return userVo;}public UserVo register(String telephone, String password) {long startTimestamp = System.currentTimeMillis();UserVo userVo = super.register(telephone, password);long endTimeStamp = System.currentTimeMillis();long responseTime = endTimeStamp - startTimestamp;RequestInfo requestInfo = new RequestInfo("register", responseTime, startTimestamp);metricsCollector.recordRequest(requestInfo);return userVo;}
}
//UserControllerProxy使用举例
UserController userController = new UserControllerProxy();

动态代理的原理解析

不过，刚刚的代码实现还是有点问题。

一方面，我们需要在代理类中，将原始类中的所有的方法，都重新实现一遍，并且为每个方法都附加相似的代码逻辑。

另一方面，如果要添加的附加功能的类有不止一个，我们需要针对每个类都创建一个代理类。

如果有 50 个要添加附加功能的原始类，那我们就要创建 50 个对应的代理类。这会导致项目中类的个数成倍增加，增加了代码维护成本。并且，每个代理类中的代码都有点像模板式的“重复”代码，也增加了不必要的开发成本。那这个问题怎么解决呢？

我们可以使用动态代理来解决这个问题。所谓动态代理（Dynamic Proxy），就是我们不事先为每个原始类编写代理类，而是在运行的时候，动态地创建原始类对应的代理类，然后在系统中用代理类替换掉原始类。那如何实现动态代理呢？

如果你熟悉的是 Java 语言，实现动态代理就是件很简单的事情。因为 Java 语言本身就已经提供了动态代理的语法（实际上，动态代理底层依赖的就是 Java 的反射语法）。我们来看一下，如何用 Java 的动态代理来实现刚刚的功能。具体的代码如下所示。其中，MetricsCollectorProxy 作为一个动态代理类，动态地给每个需要收集接口请求信息的类创建代理类。


public class MetricsCollectorProxy {private MetricsCollector metricsCollector;public MetricsCollectorProxy() {this.metricsCollector = new MetricsCollector();}public Object createProxy(Object proxiedObject) {Class<?>[] interfaces = proxiedObject.getClass().getInterfaces();DynamicProxyHandler handler = new DynamicProxyHandler(proxiedObject);return Proxy.newProxyInstance(proxiedObject.getClass().getClassLoader(), interfaces, handler);}private class DynamicProxyHandler implements InvocationHandler {private Object proxiedObject;public DynamicProxyHandler(Object proxiedObject) {this.proxiedObject = proxiedObject;}@Overridepublic Object invoke(Object proxy, Method method, Object[] args) throws Throwable {long startTimestamp = System.currentTimeMillis();Object result = method.invoke(proxiedObject, args);long endTimeStamp = System.currentTimeMillis();long responseTime = endTimeStamp - startTimestamp;String apiName = proxiedObject.getClass().getName() + ":" + method.getName();RequestInfo requestInfo = new RequestInfo(apiName, responseTime, startTimestamp);metricsCollector.recordRequest(requestInfo);return result;}}
}//MetricsCollectorProxy使用举例
MetricsCollectorProxy proxy = new MetricsCollectorProxy();
IUserController userController = (IUserController) proxy.createProxy(new UserController());

实际上，Spring AOP 底层的实现原理就是基于动态代理。用户配置好需要给哪些类创建代理，并定义好在执行原始类的业务代码前后执行哪些附加功能。Spring 为这些类创建动态代理对象，并在 JVM 中替代原始类对象。原本在代码中执行的原始类的方法，被换作执行代理类的方法，也就实现了给原始类添加附加功能的目的。

总结

不要随意去修改别人已经写好的代码或者方法,如果需改修改,可以通过代理的方式来扩展该方法
代理类可以扩展原有类的功能
代理模式的实现可以通过组合或继承

思考

为什么不用原始类? (别人的代码不要随便改)
除了 Java 语言之外，在你熟悉的其他语言中，如何实现动态代理呢？
今天讲了两种代理模式的实现方法，一种是基于组合，一种基于继承，请对比一下两者的优缺点。
什么是动态代理?
如何实现动态代理?

参考

48 | 代理模式：代理在RPC、缓存、监控等场景中的应用

Java的三种代理模式 - 洋葱源码 - 博客园