Part 1 精讲设计模式

1.3 责任链模式

田超凡

2019年10月23日

转载请注明原作者

1.责任链模式

客户端发出一个请求，链上的对象都有机会来处理这一请求，而客户端不需要知道谁是具体的处理对象。这样就实现了请求者和接受者之间的解耦，并且在客户端可以实现动态的组合责任链。使编程更有灵活性。

责任链模式使多个对象都有机会处理请求，从而避免了请求的发送者和接受者之间的耦合关系。将这些对象连成一条链，并沿着这条链传递该请求，直到有对象处理它为止。其过程实际上是一个递归调用，实现原理类似链表数据结构(Linked List)实现原理

责任链模式特点主要是：

1、有多个对象共同对一个任务进行处理。

2、这些对象使用链式存储结构，形成一个链，每个对象知道自己的下一个对象。

3、一个对象对任务进行处理，可以添加一些操作后将对象传递个下一个任务。也可以在此对象上结束任务的处理，并结束任务。

4、客户端负责组装链式结构，但是客户端不需要关心最终是谁来处理了任务。

2.责任链模式架构图

场景引入：现在在支付服务中的动态网关假设有一个需求，需要对拦截的请求路由自定义拦截器按给定顺序进行拦截过滤，包括API接口限流、黑名单拦截、会话拦截和参数过滤，只有通过4个拦截过滤校验规则后才能转发请求到对应服务处理。

要求：1.拦截规则必须按顺序依次拦截校验，如果其中某一个不通过则程序直接返回提示操作失败，不再继续执行和服务转发，只有所有拦截规则都通过后才能进行路由的正常请求转发，交给对应服务处理请求。

2.需要考虑拦截规则会新增、变动、拦截规则可动态扩展的情况。

分析：这种情况可以基于责任链设计模式实现，通过定义一个抽象处理器来定义所有具体拦截处理器需要实现的行为规范(如定义具体的拦截规则、确保执行顺序)，然后定义抽象处理器的多个具体处理器来实现拦截过滤，同时确保拦截链执行顺序。

考虑到需要动态维护拦截规则的情况，可以使用数据库存储责任链模式信息，当责任链抽象处理器比较多的时候可以采用递归的方式进行责任链的批量加载和动态组装。

抽象出的网关拦截层结构草图设计图如下：

Part1_精讲设计模式_责任链模式

抽象处理者(Handler)角色：定义出一个处理请求的接口。如果需要，接口可以定义出一个方法以设定和返回对下家的引用。这个角色通常由一个Java抽象类或者Java接口实现。

具体处理者(ConcreteHandler)角色：具体处理者接到请求后，可以选择将请求处理掉，或者将请求传给下家。由于具体处理者持有对下家的引用，因此，如果需要，具体处理者可以访问下家。

3.责任链模式特点

优点：

职责链模式的最主要功能就是：动态组合，请求者和接受者解耦。

请求者和接受者松散耦合：请求者不需要知道接受者，也不需要知道如何处理。每个职责对象只负责自己的职责范围，其他的交给后继者。各个组件间完全解耦。

动态组合职责：职责链模式会把功能分散到单独的职责对象中，然后在使用时动态的组合形成链，从而可以灵活的分配职责对象，也可以灵活的添加改变对象职责。

缺点：

产生很多细粒度的对象，加重程序体积：因为功能处理都分散到了单独的职责对象中，每个对象功能单一，要把整个流程处理完，需要很多的职责对象，会产生大量的细粒度职责对象。

不一定能处理：每个职责对象都只负责自己的部分，这样就可以出现某个请求，即使把整个链走完，都没有职责对象处理它。这就需要提供默认处理，并且注意构造链的有效性。

4.责任链模式应用场景

多条件流程的拦截和权限控制
ERP系统审批流程 流程审批总经理、人事经理、项目经理
Java过滤器的底层实现Filter(javax.servlet.Filter接口)就是基于责任链模式实现的

比如：在Java过滤器中客户端发送请求到服务器端，过滤会经过参数过滤、session过滤、表单过滤、隐藏过滤、检测请求头过滤

4.在微服务架构中，尤其是涉及到支付的电商项目中，网关作为微服务程序的入口，拦截客户端所有的请求实现权限控制非常重要，当拦截规则比较多的时候，一般都采用的是责任链模式，比如先判断Api接口限流、黑名单、用户会话、参数过滤。

Api接口限流→黑名单拦截→用户会话→参数过滤

5.SpringMVC源码中的HandleInterceptor、HandleFactory、HandleAdapter、HandleMappingAdapter、HandleInterceptorAdapter等处理器都是基于责任链设计模式实现的。

GatewayHandler抽象角色

public abstract class GatewayHandler {
    protected GatewayHandler nextGatewayHandler;

    /**
     * 处理业务逻辑
     *
     * @return true 表示继续执行 false表示不继续执行..
     */
    public abstract void service();

    public void setHandler(GatewayHandler gatewayHandler) {
        this.nextGatewayHandler = gatewayHandler;
    }
    protected void nextService(){
         if(nextGatewayHandler!=null){
             nextGatewayHandler.service();;
         }
    }
}

具体处理器Handler实现

@Component
public class CurrentLimitHandler extends GatewayHandler {
    @Override
    public void service() {
        System.out.println("第一关网关限流判断....");
        nextService();
    }
}

@Component
public class ConversationHandler extends GatewayHandler {
    @Override
    public void service() {
        System.out.println("第三关用户会话拦截判断....");
        nextService();
    }
}

@Component
public class BlacklistHandler extends GatewayHandler {
    @Override
    public void service() {
        System.out.println("第二关黑名单拦截判断....");
        nextService();
    }
}

FactoryHandler 责任链工厂类，实现责任链动态组装

public class FactoryHandler {

    public static GatewayHandler getFirstGatewayHandler() {
        GatewayHandler gatewayHandler1 = new CurrentLimitHandler();
        GatewayHandler gatewayHandler2 = new BlacklistHandler();
        gatewayHandler1.setNextGatewayHandler(gatewayHandler2);
        GatewayHandler gatewayHandler3 = new ConversationHandler();
        gatewayHandler2.setNextGatewayHandler(gatewayHandler3);
        return gatewayHandler1;
    }
}

【可选】基于数据库实现

相关SQL语句

CREATE TABLE `gateway_handler` (

`ID` int(11) NOT NULL AUTO_INCREMENT COMMENT '主键ID',

`handler_name` varchar(32) DEFAULT NULL COMMENT 'handler名称',

`handler_id` varchar(32) DEFAULT NULL COMMENT 'handler主键id',

`prev_handler_id` varchar(32) DEFAULT NULL,

`next_handler_id` varchar(32) DEFAULT NULL COMMENT '下一个handler',

PRIMARY KEY (`ID`)

) ENGINE=InnoDB AUTO_INCREMENT=19 DEFAULT CHARSET=utf8 COMMENT='权限表';

-- ----------------------------

-- Records of gateway_handler

-- ----------------------------

INSERT INTO `gateway_handler` VALUES ('16', 'Api接口限流', 'currentLimitHandler', null, 'blacklistHandler');

INSERT INTO `gateway_handler` VALUES ('17', '黑名单拦截', 'blacklistHandler', 'currentLimitHandler', 'conversationHandler');

INSERT INTO `gateway_handler` VALUES ('18', '会话验证', 'conversationHandler', 'blacklistHandler', null);

GatewayHandlerService

@Component
public class GatewayHandlerService {
    @Autowired
    private GatewayHandlerMapper gatewayHandlerMapper;
    private GatewayHandler firstGatewayHandler;

    public GatewayHandler getDbFirstGatewayHandler() {
        if (this.firstGatewayHandler != null) {
            return this.firstGatewayHandler;
        }
        // 1.查询数据库第一个handler配置
        GatewayHandlerEntity firstGatewayHandlerEntity = gatewayHandlerMapper.getFirstGatewayHandler();
        if (firstGatewayHandlerEntity == null) {
            return null;
        }
        String firstBeanHandlerId = firstGatewayHandlerEntity.getHandlerId();
        if (StringUtils.isEmpty(firstBeanHandlerId)) {
            return null;
        }
        // 2.从SpringBoot容器获取第一个handler对象
        GatewayHandler firstGatewayHandler = SpringUtils.getBean(firstBeanHandlerId, GatewayHandler.class);
        if (firstGatewayHandler == null) {
            return null;
        }
        // 3. 获取下一个handlerBeanId
        String nextBeanHandlerId = firstGatewayHandlerEntity.getNextHandlerId();
        // 定义临时循环遍历指针
        GatewayHandler tempNextGatewayHandler = firstGatewayHandler;
        while (!StringUtils.isEmpty(nextBeanHandlerId)) {
            // 4.从SpringBoot容器获取下一个handler对象
            GatewayHandler nextGatewayHandler = SpringUtils.getBean(nextBeanHandlerId, GatewayHandler.class);
            if (nextGatewayHandler == null) {
                break;
            }
            // 5.从数据库查询该hanlder信息
            GatewayHandlerEntity nextGatewayHandlerEntity = gatewayHandlerMapper.getByHandler(nextBeanHandlerId);
            if (nextGatewayHandlerEntity == null) {
                break;
            }
            // 6.设置下一个white循环遍历hanlderid
            nextBeanHandlerId = nextGatewayHandlerEntity.getNextHandlerId();
            tempNextGatewayHandler.setNextGatewayHandler(nextGatewayHandler);
            tempNextGatewayHandler = nextGatewayHandler;
        }
        this.firstGatewayHandler = firstGatewayHandler;
        return firstGatewayHandler;
    }
}

【可选】数据库访问层

GatewayHandlerMapper

public interface GatewayHandlerMapper {

   /**
    * 获取第一个GatewayHandler
    *
    * @return
    */
   @Select("SELECT handler_name AS handlerName,handler_id AS handlerid ,prev_handler_id AS prevhandlerid ,next_handler_id AS nexthandlerid FROM gateway_handler WHERE prev_handler_id is null;;")
   public GatewayHandlerEntity getFirstGatewayHandler();

   @Select("SELECT handler_name AS handlerName,handler_id AS handlerid ,prev_handler_id AS prevhandlerid ,next_handler_id AS nexthandlerid   FROM gateway_handler WHERE handler_id=#{handlerId}")
   public GatewayHandlerEntity getByHandler(String handlerId);

}

@Data
public class GatewayHandlerEntity implements Serializable, Cloneable {
   /** 主键ID */
   private Integer id;
   /** handler名称 */
   private String handlerName;
   /** handler主键id */
   private String handlerId;
   /** 下一个handler */
   private String nextHandlerId;

}

相关配置信息

application.yml

###服务启动端口号
server:
  port: 8080
#spring:
####数据库相关连接
# datasource:
#    username: root
#    password: root
#    driver-class-name: com.mysql.jdbc.Driver
#    url: jdbc:mysql://127.0.0.1:3306/design_pattern?useUnicode=true&characterEncoding=UTF-8

spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/design_pattern?useUnicode=true&characterEncoding=UTF-8
    username: root
    password: root
    driver-class-name: com.mysql.jdbc.Driver

####打印MyBatias日志
logging:
  level:
  ### 开发环境使用DEBUG 生产环境info或者error
   com.mayikt.member.mapper: DEBUG

Maven依赖信息

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.0.1.RELEASE</version>
</parent>
<dependencies>
    
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.16.10</version>
    </dependency>
    <dependency>
        <groupId>commons-lang</groupId>
        <artifactId>commons-lang</artifactId>
        <version>2.6</version>
    </dependency>
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>1.1.1</version>
    </dependency>
    
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>

</dependencies>

个人补充：责任链设计模式优点明显，对于多个拦截规则按顺序拦截过滤的时候扩展性和移植复用性非常强，对于大规模拦截规则的过滤和动态维护，也可以使用数据库存储责任链模式对象数据并基于递归算法实现批量加载。但是缺点就是粒度太细导致新增很多具体处理器来实现对应的拦截规则定义(拦截规则比较少的情况下，缺点可以忽略不计)。

窍门：责任链模式采用链表数据结构来确保具体处理器的执行顺序，只需要获取第一个责任链具体处理器就可以一次执行完整个责任链。