基于责任链模式实现网关权限框架

前言:设计模式源于生活

责任链基本概念

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

责任链定义

使多个对象都有机会处理请求,从而避免了请求的发送者和接受者之间的耦合关系。将这些对象连成一条链,并沿着这条链传递该请求,直到有对象处理它为止。其过程实际上是一个递归调用。

要点:

1.有多个对象共同对一个任务进行处理。
2.这些对象使用链式存储结构,形成一个链,每个对象知道自己的下一个对象。
3.一个对象对任务进行处理,可以添加一些操作后将对象传递个下一个任务。也可以在此对象上结束任务的处理,并结束任务。
4.客户端负责组装链式结构,但是客户端不需要关心最终是谁来处理了任务。

责任链优缺点

优点:

职责链模式的最主要功能就是:动态组合,请求者和接受者解耦。
请求者和接受者松散耦合:请求者不需要知道接受者,也不需要知道如何处理。每个职责对象只负责自己的职责范围,其他的交给后继者。各个组件间完全解耦。
动态组合职责:职责链模式会把功能分散到单独的职责对象中,然后在使用时动态的组合形成链,从而可以灵活的分配职责对象,也可以灵活的添加改变对象职责。

缺点:

产生很多细粒度的对象:因为功能处理都分散到了单独的职责对象中,每个对象功能单一,要把整个流程处理完,需要很多的职责对象,会产生大量的细粒度职责对象。
不一定能处理:每个职责对象都只负责自己的部分,这样就可以出现某个请求,即使把整个链走完,都没有职责对象处理它。这就需要提供默认处理,并且注意构造链的有效性。

责任链应用场景

1.java过滤器的底层实现filter(例如:请求进来到服务端,filter会经过参数过滤、session过滤、表单过滤、请求头过滤等等)
2.erp审批流程(例如:项目组长->项目经理->项目总监->人事经理)
3.多重if判断问题

责任链模式环境流程图

1.抽象处理者(Handler)角色:定义出一个处理请求的接口。如果需要,接口可以定义 出一个方法以设定和返回对下家的引用。这个角色通常由一个Java抽象类或者Java接口实现。上图中Handler类的聚合关系给出了具体子类对下家的引用,抽象方法handleRequest()规范了子类处理请求的操作。
2.具体处理者(ConcreteHandler)角色:具体处理者接到请求后,可以选择将请求处理掉,或者将请求传给下家。由于具体处理者持有对下家的引用,因此,如果需要,具体处理者可以访问下家

接下来将通过两种基于责任链设计模式实现网关权限方式

两种方式POM都通用

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>responsiit_model</artifactId>
    <version>1.0-SNAPSHOT</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.1.RELEASE</version>
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>29.0-jre</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.12</version>
            <!--            <scope>provided</scope>-->
        </dependency>

        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.3.2</version>
        </dependency>
        <!-- mysql 依赖 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.11</version>
        </dependency>


    </dependencies>
</project>

第一种:基于内存,模板模式+工厂模式+责任链模式实现网关权限框架

抽象handler

/**
 * @Author: klm
 * @Description: 抽象网关
 */
public abstract class GatewayHandler {

    abstract public void service();

    protected GatewayHandler nextGatewayHandler;

    public void setNextGatewayHandler(GatewayHandler gatewayHandler) {
        this.nextGatewayHandler = gatewayHandler;
    }

    protected void nextService() {
        if (nextGatewayHandler != null) {
            nextGatewayHandler.service();
        }
    }
}

具体API限流handler

/**
 * @Author: klm
 * @Description: API接口限流Handler
 */
@Slf4j
public class CurrentLimitHandler extends GatewayHandler {

    @Override
    public void service() {
        log.info("第一关:API接口限流");
        nextService();
    }
}

具体黑名单限流Handler

/**
 * @Author: klm
 * @Description: 黑名单限流Handler
 */
@Slf4j
public class BlacklistHandler extends GatewayHandler {

    @Override
    public void service() {
        log.info("第二关:黑名单限流");
        nextService();
    }
}

具体拦截用户信息Handler

/**
 * @Author: klm
 * @Description: 拦截用户信息Handler
 */
@Slf4j
public class ConversationHandler extends GatewayHandler {

    @Override
    public void service() {
        log.info("第三关:拦截用户信息");
    }
}

工厂:初始化对象并设置引用执行顺序

/**
 * @Author: klm
 * @Description: 工厂
 */
public class FactoryHandler {

    public static GatewayHandler getCurrentLimitHandler() {
        //初始化对象
        GatewayHandler currentLimitHandler = new CurrentLimitHandler();
        GatewayHandler blacklistHandler = new BlacklistHandler();
        GatewayHandler conversationHandler = new ConversationHandler();

        //设置引用,执行顺序设置
        currentLimitHandler.setNextGatewayHandler(blacklistHandler);
        blacklistHandler.setNextGatewayHandler(conversationHandler);
        return currentLimitHandler;
    }
}

测试类,执行一波,看看效果

public class test {
    public static void main(String[] args) {
        GatewayHandler currentLimitHandler = FactoryHandler.getCurrentLimitHandler();
        currentLimitHandler.service();
    }
}

代码还有需要改进的地方

改进点:在每个handler处理器里面,都会要执行一次nextService()方法,执行下一个Handler,但是这种行为比较冗余,low所以我们改造一波
抽象Handler改造点

抽象Handler改造点

/**
 * @Author: klm
 * @Description: 抽象网关
 */
public abstract class GatewayHandler {

    //改造点1:将访问修饰符改为只有子类才能使用,不再进行公开使用
    protected abstract void service();

    protected GatewayHandler nextGatewayHandler;

    public void setNextGatewayHandler(GatewayHandler gatewayHandler) {
        this.nextGatewayHandler = gatewayHandler;
    }

    //改造点3:将执行下一次操作的行为,改为我们的入口操作
    protected void nextService() {
        if (nextGatewayHandler != null) {
//            nextGatewayHandler.service();
            nextGatewayHandler.execute();
        }
    }

    //改造点2:抽出一个模板:用于外部调用的入口
    public void execute() {
        service();

        nextService();
    }
}

具体执行的handler,其他的handler也需要去掉冗余,我这里就不显示

/**
 * @Author: klm
 * @Description: 黑名单限流Handler
 */
@Slf4j
public class BlacklistHandler extends GatewayHandler {

    @Override
    public void service() {
        log.info("第二关:黑名单限流");
        //改造点4:注释掉,去掉冗余操作
//        nextService();
    }
}

测试类

/**
 * @Author: klm
 * @Description:
 */
public class test {
    public static void main(String[] args) {
        GatewayHandler currentLimitHandler = FactoryHandler.getCurrentLimitHandler();
//        currentLimitHandler.service();
        currentLimitHandler.execute();
    }
}

第二种:基于Mysql,模板模式+责任链模式实现网关权限框架

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


-- 查询第一个
SELECT id as id ,handler_name as handlerName,handler_id as handlerId,prev_handler_id as prevHandlerId,next_handler_id as nextHandlerId FROM gateway_handler gh where gh.prev_handler_id is null;

SELECT id as id ,handler_name as handlerName,handler_id as handlerId,prev_handler_id as prevHandlerId,next_handler_id as nextHandlerId FROM gateway_handler gh where gh.handler_id = 'blacklistHandler';

entity类

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

}

mapper类

/**
 * @Author: klm
 * @Description:
 */
@Repository
public interface GatewayHandlerMapper {

    /**
     * 获取第一个执行的handler
     *
     * @return
     */
    @Select("SELECT id as id ,handler_name as handlerName,handler_id as handlerId,prev_handler_id as prevHandlerId," +
            "next_handler_id as nextHandlerId FROM gateway_handler gh " +
            "where gh.prev_handler_id is null;")
    GatewayHandlerEntity getFirstGatewayHandler();

    /**
     * 获取下一个执行的handler
     *
     * @param handlerId
     * @return
     */
    @Select("SELECT id as id ,handler_name as handlerName,handler_id as handlerId,prev_handler_id as prevHandlerId," +
            "next_handler_id as nextHandlerId FROM gateway_handler gh " +
            "where gh.handler_id = #{handlerId};")
    GatewayHandlerEntity getNextGatewayHandler(@Param("handlerId") String handlerId);
}

service类

/**
 * @Author: klm
 * @Description:
 */
public interface GatewayHandlerService {

    /**
     * db责任链模式
     *
     * @return
     */
    GatewayHandler getGatewayHandler();
}

service实现类

/**
 * @Author: klm
 * @Description:
 */
@Service
@Slf4j
public class GatewayHandlerServiceImpl implements GatewayHandlerService {

    @Autowired
    private GatewayHandlerMapper gatewayHandlerMapper;

    @Override
    public GatewayHandler getGatewayHandler() {

        //获取头节点
        GatewayHandlerEntity firstGatewayHandler = gatewayHandlerMapper.getFirstGatewayHandler();
        if (Objects.isNull(firstGatewayHandler)) {
            log.info("未配置头节点,请注意");
            return null;
        }

        String handlerId = firstGatewayHandler.getHandlerId();
        if (StringUtils.isEmpty(handlerId)) {
            log.info("未配置头节点,请注意");
            return null;
        }

        //从容器中获取bean对象
        GatewayHandler bean = SpringUtils.getBean(handlerId, GatewayHandler.class);
        if (Objects.isNull(bean)) {
            log.info("容器中未找到");
            return null;
        }

        //下一节点名称
        String nextHandlerId = firstGatewayHandler.getNextHandlerId();

        //记录当前对象
        GatewayHandler currentBean = bean;
        while (!StringUtils.isEmpty(nextHandlerId)) {

            //从容器获取下一个执行handler
            GatewayHandler nextBean = SpringUtils.getBean(nextHandlerId, GatewayHandler.class);
            if (Objects.isNull(nextBean)) {
                break;
            }

            //查询db获取下一个handlerid
            GatewayHandlerEntity nextGatewayHandler = gatewayHandlerMapper.getNextGatewayHandler(nextHandlerId);
            if (Objects.isNull(nextGatewayHandler)) {
                break;
            }
            nextHandlerId = nextGatewayHandler.getNextHandlerId();


            currentBean.setNextGatewayHandler(nextBean);
            currentBean = nextBean;
        }

        return bean;
    }
}

抽象handler

/**
 * @Author: klm
 * @Date: 2020/8/5 09:41
 * @Description:
 */
public abstract class GatewayHandler {

    protected abstract void doService();

    protected GatewayHandler nextGatewayHandler;

    public void setNextGatewayHandler(GatewayHandler gatewayHandler) {
        this.nextGatewayHandler = gatewayHandler;
    }

    protected void nextService() {
        if (nextGatewayHandler != null) {
//            nextGatewayHandler.doService();
            nextGatewayHandler.execute();
        }
    }

    public void execute() {
        doService();

        nextService();
    }
}

具体API接口限流Handler

/**
 * @Author: klm
 * @Description:
 */
@Component
@Slf4j
public class CurrentLimitHandler extends GatewayHandler {

    @Override
    public void doService() {
        log.info("第一关:API接口限流");
//        nextService();
    }
}

具体黑名单限流Handler

/**
 * @Author: klm
 * @Description:
 */
@Component
@Slf4j
public class BlacklistHandler extends GatewayHandler {

    @Override
    public void doService() {
        log.info("第二关:黑名单限流");
//        nextService();
    }
}

具体拦截用户信息Handler

/**
 * @Author: klm
 * @Description:
 */
@Component
@Slf4j
public class ConversationHandler extends GatewayHandler {

    @Override
    public void doService() {
        log.info("第三关:拦截用户信息");
    }
}

SpringUtils类

/**
 * @Author: klm
 * @Description:
 */
@Component
public class SpringUtils implements ApplicationContextAware {

    private static ApplicationContext applicationContext;

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext = applicationContext;
    }

    //获取applicationContext
    public static ApplicationContext getApplicationContext() {
        return applicationContext;
    }

    //通过name获取 Bean.
    public static Object getBean(String name){
        return getApplicationContext().getBean(name);
    }

    //通过class获取Bean.
    public static <T> T getBean(Class<T> clazz){
        return getApplicationContext().getBean(clazz);
    }

    //通过name,以及Clazz返回指定的Bean
    public static <T> T getBean(String name,Class<T> clazz){
        return getApplicationContext().getBean(name, clazz);
    }

}

controller类

/**
 * @Author: klm
 * @Description:
 */
@RestController
public class GatewayHandlerController {

    @Autowired
    private GatewayHandlerService gatewayHandlerService;

    @GetMapping("/test")
    public void test() {
        GatewayHandler gatewayHandler = gatewayHandlerService.getGatewayHandler();
        gatewayHandler.execute();
    }
}

application.yml文件

###服务启动端口号
server:
  port: 8080

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


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

访问网页:执行localhost:8080/test
执行效果图


©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,928评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,192评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,468评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,186评论 1 286
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,295评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,374评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,403评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,186评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,610评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,906评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,075评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,755评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,393评论 3 320
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,079评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,313评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,934评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,963评论 2 351