职责链模式的原理和实现

职责链模式的英文翻译是 Chain Of Responsibility Design Pattern。在 GoF 的《设计模式》中的定义为：

Avoid coupling the sender of a request to its receiver by giving more than one object a chance to handle the request. Chain the receiving objects and pass the request along the chain until an object handles it.

翻译成中文就是：将请求的发送和接收解耦，让多个接收对象都有机会处理这个请求。将这些接收对象串成一条链，并沿着这条链传递这个请求，直到链上的某个接收对象能够处理它为止。

在职责链模式中，多个处理器（也就是刚刚定义中说的“接收对象”）依次处理同一个请求。一个请求先经过 A 处理器处理，然后再把请求传递给 B 处理器，B 处理器处理完后再传递给 C 处理器，以此类推，形成一个链条。链条上的每个处理器各自承担各自的处理职责，所以叫作职责链模式。
捕获.PNG
下面我们来看看职责链模式的代码实现。职责链模式有多种实现方式，这里介绍两种比较常用的。第一种实现方式如下所示。其中，Handler 是所有处理器类的抽象父类，handleRequest() 是抽象方法。每个具体的处理器类（HandlerA、HandlerB）的 handleRequest() 函数的代码结构类似，如果它能处理该请求，就不继续往下传递；如果不能处理，则交由后面的处理器来处理。HandlerChain 是处理器链，从数据结构的角度来看，它就是一个记录了链头、链尾的链表。其中，记录链尾是为了方便添加处理器。

  1. public abstract class Handler {
  2.     protected Handler successor = null;
  3.     public void setSuccessor(Handler successor) {
  4.         this.successor = successor;
  5.     }
  7.     public abstract void handleRequest();
  8. }
  10. public class HandlerA extends Handler {
  11.     @Override
  12.     public void handleRequest() {
  13.         boolean handled = false;
  14.         //...
  15.         if (!handled && successor != null) {
  16.             // 链式调用
  17.             successor.handleRequest();
  18.         }
  19.     }
  20. }
  22. public class HandlerB extends Handler {
  23.     @Override
  24.     public void handleRequest() {
  25.         boolean handled = false;
  26.         //...
  27.         if (!handled && successor != null) {
  28.             successor.handleRequest();
  29.         } 
  30.     }
  31. }
  33. public class HandlerChain {
  34.     private Handler head = null;
  35.     private Handler tail = null;
  37.     public void addHandler(Handler handler) {
  38.         handler.setSuccessor(null);
  39.         if (head == null) {
  40.             head = handler;
  41.             tail = handler;
  42.             return;
  43.         }
  44.         // 从尾部添加新的处理器
  45.         tail.setSuccessor(handler);
  46.         tail = handler;
  47.     }
  49.     public void handleRequest() {
  50.         if (head != null) {
  51.             head.handleRequest();
  52.         }
  53.     }
  54. }
  56. public class Application {
  57.     public static void main(String[] args) {
  58.         HandlerChain chain = new HandlerChain();
  59.         chain.addHandler(new HandlerA());
  60.         chain.addHandler(new HandlerB());
  61.         chain.handleRequest();
  62.     }
  63. }

实际上，上面的代码实现不够优雅。处理器类的 handleRequest() 函数，不仅包含自己的业务逻辑，还包含对下一个处理器的调用，也就是代码中的 successor.handleRequest()。一个不熟悉这种代码结构的程序员，在添加新的处理器类的时候，很有可能忘记在 handleRequest() 函数中调用 successor.handleRequest()，这就会导致代码出现 bug。

针对这个问题，我们对代码进行重构，利用模板模式，将调用 successor.handleRequest() 的逻辑从具体的处理器类中剥离出来，放到抽象父类中。这样具体的处理器类只需要实现自己的业务逻辑就可以了。重构之后的代码如下所示：

  1. public abstract class Handler {
  2.     protected Handler successor = null;
  3.     public void setSuccessor(Handler successor) {
  4.         this.successor = successor;
  5.     }
  6.     // 固化链式调用的逻辑
  7.     public final void handleRequest() {
  8.         boolean handled = doHandle();
  9.         if (successor != null && !handled) {
  10.             successor.handleRequest();
  11.         }
  12.     }
  13.     // 子类实现
  14.     protected abstract boolean doHandle();
  15. }

我们再来看第二种实现方式，代码如下所示。这种实现方式更加简单。HandlerChain 类用数组来保存所有的处理器，并在 HandlerChain 的 handleRequest() 函数中依次调用每个处理器的 handleRequest() 函数。

  1. public interface IHandler {
  2.     boolean handle();
  3. }
  5. public class HandlerA implements IHandler {
  6.     @Override
  7.     public boolean handle() {
  8.         boolean handled = false;
  9.         //...
  10.         return handled;
  11.     }
  12. }
  14. public class HandlerB implements IHandler {
  15.     @Override
  16.     public boolean handle() {
  17.         boolean handled = false;
  18.         //...
  19.         return handled;
  20.     }
  21. }
  23. public class HandlerChain {
  24.     private List<IHandler> handlers = new ArrayList<>();
  25.     public void addHandler(IHandler handler) {
  26.         this.handlers.add(handler);
  27.     }
  29.     public void handle() {
  30.         for (IHandler handler : handlers) {
  31.             boolean handled = handler.handle();
  32.             if (handled) {
  33.                 break;
  34.             }
  35.         }
  36.     }
  37. }
  39. public class Application {
  40.     public static void main(String[] args) {
  41.         HandlerChain chain = new HandlerChain();
  42.         chain.addHandler(new HandlerA());
  43.         chain.addHandler(new HandlerB());
  44.         chain.handle();
  45.     }
  46. }

在 GoF 给出的定义中，如果处理器链上的某个处理器能够处理这个请求，那就不会继续往下传递请求。实际上，职责链模式还有一种变体，那就是请求会被所有的处理器都处理一遍，不存在中途终止的情况。这种变体也有两种实现方式：用链表存储或用数组存储处理器，跟上面的两种实现方式类似。

职责链模式的应用场景

我们前面多次讲过，应用设计模式主要是为了应对代码的复杂性，让其满足开闭原则，提高代码的扩展性。除此之外，职责链模式常用在框架的开发中，为框架提供扩展点，让框架的使用者在不修改框架源码的情况下，基于扩展点添加新的功能。实际上，更具体点来说，职责链模式最常用来开发框架的过滤器和拦截器。下面我们就通过 Servlet Filter、Spring Interceptor 这两个 Java 开发中常用的组件，来具体讲讲它在框架开发中的应用。

1. Servlet Filter

Servlet Filter 是 Java Servlet 规范中定义的组件，翻译成中文就是过滤器，它可以实现对 HTTP 请求的过滤功能，比如鉴权、限流、记录日志、验证参数等等。它的工作原理如下图所示：
1.png
在实际项目中，如果我们想添加一个自定义的过滤器，我们只需要定义一个实现 javax.servlet.Filter 接口的过滤器类，并且将它配置在 web.xml 配置文件中。Web 容器启动的时候，就会读取 web.xml 中的配置，创建对应的过滤器对象。当有请求到来的时候，会先经过过滤器，然后才由 Servlet 来处理。

  1. public class LogFilter implements Filter {
  2.     @Override
  3.     public void init(FilterConfig filterConfig) throws ServletException {
  4.         // 在创建Filter时自动调用，
  5.         // 其中filterConfig包含这个Filter的配置参数，比如name之类的（从配置文件中读取的）
  6.     }
  8.     @Override
  9.     public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
  10.         System.out.println("拦截客户端发送来的请求.");
  11.         chain.doFilter(request, response);
  12.         System.out.println("拦截发送给客户端的响应.");
  13.     }
  15.     @Override
  16.     public void destroy() {
  17.         // 在销毁Filter时自动调用
  18.     }
  19. }

可以看到，添加过滤器非常方便，不需要修改任何代码，定义一个实现 javax.servlet.Filter 的类，再改改配置就搞定了，完全符合开闭原则。那 Servlet Filter 是如何做到如此好的扩展性的呢？它利用的就是职责链模式，我们来分析下它的源码，详细地看看它底层是如何实现的。

前面我们讲到，职责链模式的实现包含处理器接口（IHandler）或抽象类（Handler），以及处理器链（HandlerChain）。对应到 Servlet Filter，javax.servlet.Filter 就是处理器接口，FilterChain 就是处理器链。不过，Servlet 只是一个规范，并不包含具体的实现，所以，Servlet 中的 FilterChain 只是一个接口定义。具体的实现类由遵从 Servlet 规范的 Web 容器来提供，比如，ApplicationFilterChain 类就是 Tomcat 提供的 FilterChain 的实现类，源码如下所示。

  2. public final class ApplicationFilterChain implements FilterChain {
  3.     private int pos = 0; //当前执行到了哪个filter
  4.     private int n; //filter的个数
  5.     private ApplicationFilterConfig[] filters;
  6.     private Servlet servlet;
  8.     @Override
  9.     public void doFilter(ServletRequest request, ServletResponse response) {
  10.         if (pos < n) {
  11.             ApplicationFilterConfig filterConfig = filters[pos++];
  12.             Filter filter = filterConfig.getFilter();
  13.             filter.doFilter(request, response, this);
  14.         } else {
  15.             // filter都处理完毕后，执行servlet
  16.             servlet.service(request, response);
  17.         }
  18.     }
  20.     public void addFilter(ApplicationFilterConfig filterConfig) {
  21.         for (ApplicationFilterConfig filter:filters)
  22.             if (filter==filterConfig)
  23.                 return;
  25.         if (n == filters.length) {//扩容
  26.             ApplicationFilterConfig[] newFilters = new ApplicationFilterConfig[n + INCREMENT];
  27.             System.arraycopy(filters, 0, newFilters, 0, n);
  28.             filters = newFilters;
  29.         }
  30.         filters[n++] = filterConfig;
  31.     }
  32. }

ApplicationFilterChain 中的 doFilter() 函数的代码实现比较有技巧，实际上是一个递归调用。这样实现主要是为了在一个 doFilter() 方法中，支持双向拦截，既能拦截客户端发送来的请求，也能拦截发送给客户端的响应。

2. Spring Interceptor

Spring Interceptor 是一个功能上跟 Servlet Filter 非常类似的东西，都用来实现对 HTTP 请求进行拦截处理。它们不同之处在于，Servlet Filter 是 Servlet 规范的一部分，实现依赖于 Web 容器。Spring Interceptor 是 Spring MVC 框架的一部分，由 Spring MVC 框架来提供实现。客户端发送的请求，会先经过 Servlet Filter，然后再经过 Spring Interceptor，最后到达具体的业务代码中。
捕获.PNG
在实际项目中，我们该如何使用 Spring Interceptor 呢？下面提供一个例子，LogInterceptor 实现的功能跟 LogFilter 完全相同，只是实现方式上稍有区别。LogFilter 对请求和响应的拦截是在 doFilter() 一个函数中实现的，而 LogInterceptor 对请求的拦截在 preHandle() 中实现，对响应的拦截在 postHandle() 中实现。

  1. public class LogInterceptor implements HandlerInterceptor {
  3.     @Override
  4.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
  5.         System.out.println("拦截客户端发送来的请求.");
  6.         return true; // 继续后续的处理
  7.     }
  9.     @Override
  10.     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
  11.         System.out.println("拦截发送给客户端的响应.");
  12.     }
  14.     @Override
  15.     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
  16.         System.out.println("这里总是被执行.");
  17.     }
  18. }

同样，我们还是来剖析一下 Spring Interceptor 底层是如何实现的。当然，它也是基于职责链模式实现的。其中，HandlerExecutionChain 类是职责链模式中的处理器链。它的实现相较于 Tomcat 中的 ApplicationFilterChain 来说，逻辑更加清晰，不需要使用递归来实现，主要是因为它将请求和响应的拦截拆分到了两个函数中实现。

  1. public class HandlerExecutionChain {
  2.     private final Object handler;
  3.     private HandlerInterceptor[] interceptors;
  5.     public void addInterceptor(HandlerInterceptor interceptor) {
  6.         initInterceptorList().add(interceptor);
  7.     }
  9.     boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) throws Exception {
  10.         HandlerInterceptor[] interceptors = getInterceptors();
  11.         if (!ObjectUtils.isEmpty(interceptors)) {
  12.             for (int i = 0; i < interceptors.length; i++) {
  13.                 HandlerInterceptor interceptor = interceptors[i];
  14.                 if (!interceptor.preHandle(request, response, this.handler)) {
  15.                     triggerAfterCompletion(request, response, null);
  16.                     return false;
  17.                 }
  18.             }
  19.         }
  20.         return true;
  21.     }
  23.     void applyPostHandle(HttpServletRequest request, HttpServletResponse response, ModelAndView mv) throws Exception {
  24.         HandlerInterceptor[] interceptors = getInterceptors();
  25.         if (!ObjectUtils.isEmpty(interceptors)) {
  26.             for (int i = interceptors.length - 1; i >= 0; i--) {
  27.                 HandlerInterceptor interceptor = interceptors[i];
  28.                 interceptor.postHandle(request, response, this.handler, mv);
  29.             }
  30.         }
  31.     }
  33.     void triggerAfterCompletion(HttpServletRequest request, HttpServletResponse response, Exception ex)
  34.         throws Exception {
  35.         HandlerInterceptor[] interceptors = getInterceptors();
  36.         if (!ObjectUtils.isEmpty(interceptors)) {
  37.             for (int i = this.interceptorIndex; i >= 0; i--) {
  38.                 HandlerInterceptor interceptor = interceptors[i];
  39.                 try {
  40.                     interceptor.afterCompletion(request, response, this.handler, ex);
  41.                 } catch (Throwable ex2) {
  42.                     logger.error("HandlerInterceptor.afterCompletion threw exception", ex2);
  43.                 }
  44.             }
  45.         }
  46.     }
  47. }

在 Spring 框架中，DispatcherServlet 的 doDispatch() 方法来分发请求，它在真正的业务逻辑执行前后，执行 HandlerExecutionChain 中的 applyPreHandle() 和 applyPostHandle() 函数，用来实现拦截的功能。