Java的代理模式你真的了解嗎

更新時間：2022年04月06日 17:08:03 作者：就是不掉頭發(fā)

這篇文章主要為大家詳細介紹了Java的代理模式，結構型模式主要總結了一些類或對象組合在一起的經典結構，這些經典的結構可以解決特定應用場景的問題，包括：代理模式、橋接模式、裝飾器模式、適配器模式、門面模式、組合模式、享元模式

代理模式原理解析

代理模式（Proxy Design Pattern），它在不改變原始類（或者叫被代理類）代碼的情況下，通過引入代理類來給原始類附加功能。

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數據...
  }
}

上面代碼有兩個問題，第一，性能計數器框架代碼侵入到業(yè)務代碼中，跟業(yè)務高度耦合。如果需要替換這個框架，成本比較大。第二，收集接口請求的代碼跟業(yè)務代碼無關，不應該放到一個類中。業(yè)務類最好職責更加單一，只負責業(yè)務處理。
現在改成代理模式：

public interface IUserController {
  UserVo login(String telephone, String password);
  UserVo register(String telephone, String password);
}

public class UserController implements IUserController {
  //...省略其他屬性和方法...

  @Override
  public UserVo login(String telephone, String password) {
    //...省略login邏輯...
    //...返回UserVo數據...
  }

  @Override
  public 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();
  }

  @Override
  public 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;
  }

  @Override
  public 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());

按照基于接口而非實現編程的設計思想，將原始類對象替換為代理類對象的時候，剛剛的代理模式代碼實現中，代理類和原始類需要實現相同的接口。但是如果原始類沒有定義接口，并且原始類代碼并不是我們開發(fā)維護的，也不能重新定義一個接口，這種情況下，如何實現代理模式呢？
對于這種外部類的擴展，一般都采用繼承的方式。讓代理類繼承原始類，然后擴展附加功能。代碼如下：

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

動態(tài)代理的原理解析

另外，剛剛的代碼實現還是有點問題。一方面，我們需要在代理類中，將原始類中的所有方法，都要重新實現一遍，而且為每個方法都附加相似的代碼邏輯。另一方面，如果要添加功能的類不止有一個，我們需要針對每個類都創(chuàng)建一個代理類。
如果有50個要添加附加功能的原始類，那我們就要創(chuàng)建50個對應的代理類，導致項目中的類個數成倍增加，提高維護成本。而且每個代理類的代碼都有點重復，增加開發(fā)成本，這種問題該如何解決？

可以使用動態(tài)代理（Dynamic Proxy），Java動態(tài)代理實現。

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

    @Override
    public 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());