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

2020-08-08 本文已影响0人 Sunny捏

前言:设计模式源于生活

责任链基本概念

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

责任链定义

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

要点:

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
执行效果图

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

前言:设计模式源于生活

责任链基本概念

责任链定义

要点:

责任链优缺点

优点:

缺点:

责任链应用场景

责任链模式环境流程图

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

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

抽象handler

具体API限流handler

具体黑名单限流Handler

具体拦截用户信息Handler

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

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

代码还有需要改进的地方

抽象Handler改造点

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

测试类

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

db sql文件

entity类

mapper类

service类

service实现类

抽象handler

具体API接口限流Handler

具体黑名单限流Handler

具体拦截用户信息Handler

SpringUtils类

controller类

application.yml文件

猜你喜欢

热点阅读