22-职责链模式 VectorX

笔记来源:尚硅谷 Java 设计模式(图解+框架源码剖析)

[TOC]

职责链模式

1、OA 系统的采购审批项目

学校 OA 系统的采购审批项目,需求是

  • 1)采购员采购教学器材
  • 2)如果金额小于等于 5000,由教学主任审批(0 < x ≤ 5000)
  • 3)如果金额小于等于 10000,由院长审批(5000 < x ≤ 10000)
  • 4)如果金额小于等于 30000,由副校长审批(10000< x ≤ 30000)
  • 5)如果金额超过 30000 以上,有校长审批(30000 < x)

请设计程序完成采购审批项目

传统方案解决 OA 系统审批,传统的设计方案(类图)

image-20220117211918215

传统方案解决 OA 系统审批问题分析

  • 1)传统方式是:接收到一个采购请求后,根据采购金额来调用对应的Approver(审批人)完成审批
  • 2)传统方式的问题分析:客户端这里会使用到分支判断(比如switch)来对不同的采购请求处理,这样就存在如下问题
    • (1)如果各个级别的人员审批金额发生变化,在客户端的也需要变化
    • (2)客户端必须明确的知道有多少个审批级别和访问
  • 3)这样对一个采购请求进行处理和Approver(审批人)就存在强耦合关系,不利于代码的扩展和维护
  • 4)解决方案 =》职责链模式

2、职责链模式基本介绍

  • 1)职责链模式(Chain of Responsibility Pattern),又叫责任链模式:为请求创建了一个接收者对象的链(简单示意图)。

    image-20220117212306482

    这种模式对请求的发送者和接收者进行解耦

  • 2)职责链模式通常每个接收者都包含对另一个接收者的引用。如果一个对象不能处理该请求,那么它会把相同的请求传给下一个接收者,依此类推

  • 3)这种类型的设计模式属于行为型模式

原理类图

image-20220117212730422

职责链模式使多个对象都有机会处理请求,从而避免请求的发送者和接收者之间的耦合关系

将这个对象连成一条链,并沿着这条链传递该请求,直到有一个对象处理它为止

  • Handler抽象处理者:定义了一个处理请求的方法,同时含有另外一个Handler
  • ConcreteHandler具体处理者:处理自己负责的请求,同时可以访问它的后继者(即下一个处理者) ;如果可以处理请求,则进行处理,否则交给后继者去处理,从而形成一个职责链
  • Request含有很多属性,表示一个请求

3、职责链模式解决 OA 系统采购审批项目

UML 类图

image-20220117213428895

核心代码

请求类

/**
 * 采购申请类
 */
public class PurchaseRequest {
    private Integer id;
    private Float price;

    public PurchaseRequest(Integer id, Float price) {
        this.id = id;
        this.price = price;
    }

    public Integer getId() {
        return id;
    }

    public Float getPrice() {
        return price;
    }
}

抽象审批人对象

/**
 * 抽象审批人对象
 */
public abstract class Approver {
    protected Approver nextApprover;
    protected String name;

    public Approver(String name) {
        this.name = name;
    }

    /**
     * 设置后继者
     *
     * @param nextApprover
     */
    public void setNextApprover(Approver nextApprover) {
        this.nextApprover = nextApprover;
    }

    /**
     * 处理请求的方法
     */
    public abstract void processRequest(PurchaseRequest purchaseRequest);
}

具体审批人对象

/**
 * 教学主任审批人
 */
public class TeachDirectorApprover extends Approver {
    public TeachDirectorApprover(String name) {
        super(name);
    }

    @Override
    public void processRequest(PurchaseRequest purchaseRequest) {
        if (purchaseRequest.getPrice() <= 5000) {
            System.out.println("请求编号:" + purchaseRequest.getId() + ",处理人:" + this.name);
        } else {
            nextApprover.processRequest(purchaseRequest);
        }
    }
}
/**
 * 院长审批人
 */
public class DepartmentHeadApprover extends Approver {
    public DepartmentHeadApprover(String name) {
        super(name);
    }

    @Override
    public void processRequest(PurchaseRequest purchaseRequest) {
        if (purchaseRequest.getPrice() > 5000 && purchaseRequest.getPrice() <= 10000) {
            System.out.println("请求编号:" + purchaseRequest.getId() + ",处理人:" + this.name);
        } else {
            nextApprover.processRequest(purchaseRequest);
        }
    }
}
/**
 * 副校长审批人
 */
public class ViceChancellorApprover extends Approver {
    public ViceChancellorApprover(String name) {
        super(name);
    }

    @Override
    public void processRequest(PurchaseRequest purchaseRequest) {
        if (purchaseRequest.getPrice() > 10000 && purchaseRequest.getPrice() <= 30000) {
            System.out.println("请求编号:" + purchaseRequest.getId() + ",处理人:" + this.name);
        } else {
            nextApprover.processRequest(purchaseRequest);
        }
    }
}
/**
 * 副校长审批人
 */
public class ChancellorApprover extends Approver {
    public ChancellorApprover(String name) {
        super(name);
    }

    @Override
    public void processRequest(PurchaseRequest purchaseRequest) {
        if (purchaseRequest.getPrice() > 30000) {
            System.out.println("请求编号:" + purchaseRequest.getId() + ",处理人:" + this.name);
        } else {
            nextApprover.processRequest(purchaseRequest);
        }
    }
}

测试代码

//创建一个请求
PurchaseRequest purchaseRequest = new PurchaseRequest(1, 31000.0f);

//创建相关的审批人
TeachDirectorApprover teachDirectorApprover = new TeachDirectorApprover("童主任");
DepartmentHeadApprover departmentHeadApprover = new DepartmentHeadApprover("王院长");
ViceChancellorApprover viceChancellorApprover = new ViceChancellorApprover("钱副校长");
ChancellorApprover chancellorApprover = new ChancellorApprover("郑校长");

//设置后继者(处理人形成环形)
teachDirectorApprover.setNextApprover(departmentHeadApprover);
departmentHeadApprover.setNextApprover(viceChancellorApprover);
viceChancellorApprover.setNextApprover(chancellorApprover);
chancellorApprover.setNextApprover(teachDirectorApprover);

//发起一个请求
teachDirectorApprover.processRequest(purchaseRequest); //请求编号:1,处理人:郑校长

4、职责链模式在 SpringMVC 框架应用的源码分析

SpringMVCHandlerExecutionChain类就使用到了职责链模式

首先,需要了解下SpringMVC基本的请求流程,如下图所示

image-20220118185936255

首先,当用户会发起一个request请求到后台,这个request请求首先会经过DispatcherServletDispatcherServlet对象首先会遍历接收到的HandlerMapping集合,然后再找到对应的HandlerMapping集合,并得到HandlerExecutionChain对象。这个HandlerExecutionChain对象内部包含了一些拦截器。拿到HandlerInterceptor拦截器过后,有以下几个操作

  • 首先会调用HandlerInterceptor中的preHandle()方法
  • 然后会调用HandlerInterceptor中的postHandle()方法
  • 最后会调用HandlerInterceptor中的afterCompletion()方法

现在对SpringMVC 进行源码分析,首先需要引入SpringMVC相关依赖

<properties>
    <maven.compiler.source>8</maven.compiler.source>
    <maven.compiler.target>8</maven.compiler.target>
    <org.springframework.version>4.3.7.RELEASE</org.springframework.version>
</properties>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-core</artifactId>
    <version>${org.springframework.version}</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-beans</artifactId>
    <version>${org.springframework.version}</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context</artifactId>
    <version>${org.springframework.version}</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-web</artifactId>
    <version>${org.springframework.version}</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>${org.springframework.version}</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-expression</artifactId>
    <version>${org.springframework.version}</version>
</dependency>
<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>servlet-api</artifactId>
    <version>2.5</version>
    <scope>provided</scope>
</dependency>

接下来,我们对其如何调用HandlerInterceptor拦截器中的这三个方法一探究竟吧

1)在DispatcherServlet中找到doDispatch()方法,发现该方法中定义了一个HandlerExecutionChain对象

image-20220118193853864

在后续的代码逻辑中,调用了getHandler()方法,接收一个processedRequest请求对象作为参数,得到初始化的HandlerExecutionChain对象

image-20220118193939093

直接对mappedHandler对象进行高亮,方便我们更加直观地看到mappedHandler是如何调用上述所说的preHandle()postHandle()afterCompletion()三个方法的

image-20220118202141860

最终,我们找到这样两段代码,很像上述所说的preHandle()postHandle()两个方法

if (!mappedHandler.applyPreHandle(processedRequest, response)) {
    return;
}

mappedHandler.applyPostHandle(processedRequest, response, mv);

首先会执行mappedHandlerapplyPreHandle()方法:如果返回为false,则判断成立,后续代码不再执行;否则继续往下执行,调用mappedHandlerapplyPostHandle()方法

我们对applyPreHandle()applyPostHandle()方法进行源码追踪

2)先看下applyPreHandle()方法的源码

boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) throws Exception {
    HandlerInterceptor[] interceptors = getInterceptors();
    if (!ObjectUtils.isEmpty(interceptors)) {
        for (int i = 0; i < interceptors.length; i++) {
            HandlerInterceptor interceptor = interceptors[i];
            if (!interceptor.preHandle(request, response, this.handler)) {
                triggerAfterCompletion(request, response, null);
                return false;
            }
            this.interceptorIndex = i;
        }
    }
    return true;
}

可以发现,applyPreHandle方法内部首先会拿到一组interceptors拦截器,当拦截器数组不为空时,进行如下处理:

  • 首先对interceptors拦截器进行了for循环遍历,拿到每一个具体的interceptor拦截器
  • 接着调用了interceptorpreHandle()方法,如果返回false,则执行triggerAfterCompletion()方法并进行return,此方法结束;否则继续执行相关处理

3)接着看下triggerAfterCompletion()方法的源码

void triggerAfterCompletion(HttpServletRequest request, HttpServletResponse response, Exception ex)
    throws Exception {

    HandlerInterceptor[] interceptors = getInterceptors();
    if (!ObjectUtils.isEmpty(interceptors)) {
        for (int i = this.interceptorIndex; i >= 0; i--) {
            HandlerInterceptor interceptor = interceptors[i];
            try {
                interceptor.afterCompletion(request, response, this.handler, ex);
            }
            catch (Throwable ex2) {
                logger.error("HandlerInterceptor.afterCompletion threw exception", ex2);
            }
        }
    }
}

可以发现,其中逻辑跟applyPreHandle()方法很相似:先对一组interceptors拦截器进行遍历,再执行interceptor单个拦截器的afterCompletion()方法

4)最后看下applyPostHandle()方法的源码

void applyPostHandle(HttpServletRequest request, HttpServletResponse response, ModelAndView mv) throws Exception {
    HandlerInterceptor[] interceptors = getInterceptors();
    if (!ObjectUtils.isEmpty(interceptors)) {
        for (int i = interceptors.length - 1; i >= 0; i--) {
            HandlerInterceptor interceptor = interceptors[i];
            interceptor.postHandle(request, response, this.handler, mv);
        }
    }
}

同样可以发现,其中逻辑跟上述方法也基本一致:先对一组interceptors拦截器进行遍历,再执行interceptor单个拦截器的postHandle()方法

通过对上述SpringMVC的源码分析,这里进行简单的梳理总结

  • SpringMVC请求的流程图中,执行了拦截器相关方法,如interceptor.preHandler()
  • 在处理SpringMVC请求时,使用到职责链模式和适配器模式
  • HandlerExecutionChain:主要负责请求拦截器的执行和请求处理,但是本身不处理请求,只是将请求分配给 链上注册处理器 执行。这是职责链实现方式,减少职责链本身与处理逻辑之间的耦合,规范了处理流程
  • HandlerExecutionChain:维护了Handlerlnterceptor的集合,可以向其中注册相应的拦截器

5、职责链模式的注意事项和细节

  • 1)将请求和处理分开,实现解耦,提高系统的灵活性
  • 2)简化了对象,使对象不需要知道链的结构
  • 3)性能会受到影响,特别是在链比较长的时候,因此需控制链中最大节点数量,一般通过在Handler中设置一个最大节点数量,在setNext()方法中判断是否已经超过阀值,超过则不允许该链建立,避免出现超长链无意识地破坏系统性能
  • 4)调试不方便。采用了类似递归的方式,调试时逻辑可能比较复杂
  • 5)最佳应用场景:有多个对象可以处理同一个请求时,比如:多级请求、请假 / 加薪等审批流程、Java Web 中 Tomcat 对Encoding的处理、拦截器