【奇思妙想】如何給網關設計一款專屬的權限控制【責任鏈設計模式】

什麼是責任鏈模式

客戶端發出一個請求，鏈上的對象都有機會來處理這一請求，而客戶端不需要知道誰是具體的處理對象。這樣就實現了請求者和接受者之間的解耦，並且在客戶端可以實現動態的組合職責鏈。使編程更有靈活性。

關鍵點

1、有多個對象共同對一個任務進行處理。
2、這些對象使用鏈式存儲結構，形成一個鏈，每個對象知道自己的下一個對象。
3、一個對象對任務進行處理，可以添加一些操作後將對象傳遞個下一個任務。也可以在此對象上結束任務的處理，並結束任務。
4、客戶端負責組裝鏈式結構，但是客戶端不需要關心最終是誰來處理了任務。

責任鏈模式環境

1.抽象處理者(Handler)角色：定義出一個處理請求的接口
2.具體處理者(ConcreteHandler)角色：具體處理者接到請求後，可以選擇將請求處理掉，或者將請求傳給下家。

責任鏈模式優缺點

優點：
職責鏈模式的最主要功能就是：動態組合，請求者和接受者解耦。
請求者和接受者鬆散耦合：請求者不需要知道接受者，也不需要知道如何處理。每個職責對象只負責自己的職責範圍，其他的交給後繼者。各個組件間完全解耦。
動態組合職責：職責鏈模式會把功能分散到單獨的職責對象中，然後在使用時動態的組合形成鏈，從而可以靈活的分配職責對象，也可以靈活的添加改變對象職責。

缺點：
產生很多細粒度的對象：因爲功能處理都分散到了單獨的職責對象中，每個對象功能單一，要把整個流程處理完，需要很多的職責對象，會產生大量的細粒度職責對象。
不一定能處理：每個職責對象都只負責自己的部分，這樣就可以出現某個請求，即使把整個鏈走完，都沒有職責對象處理它。這就需要提供默認處理，並且注意構造鏈的有效性。

責任鏈模式應用場景

1.多條件流程判斷 權限控制
2.ERP系統 流程審批 總經理、人事經理、項目經理
3.Java過濾器的底層實現Filter 
比如：在Java過濾器中客戶端發送請求到服務器端，過濾會經過參數過濾、session過濾、表單過濾、隱藏過濾、檢測請求頭過濾

網關權限控制責任鏈模式

在網關作爲微服務程序的入口，攔截客戶端所有的請求實現權限控制 ，比如先判斷Api接口限流、黑名單、用戶會話信息攔截。

Api接口限流→黑名單攔截→用戶會話信息攔截

GatewayHandler抽象角色

/**
 * @title: GatewayHandler
 */
public abstract class GatewayHandler {
    /**
     * 執行下一個handler
     */
    protected GatewayHandler nextGatewayHandler;
    public void setNextGatewayHandler(GatewayHandler nextGatewayHandler) {
        this.nextGatewayHandler = nextGatewayHandler;
    }

    //實現的handler 處理方案 強制必須實現
    public abstract void service();

    protected void nextService() {
        if (nextGatewayHandler != null)
            // 指向下一關
            nextGatewayHandler.service();
    }
}

具體Handler實現

@Slf4j
@Component
public class CurrentLimitHandler extends GatewayHandler {
    @Override
    public void service() {
        log.info("第一關 API接口限流操作.....");
        //指向下一關
        nextService();
    }
}

@Component
@Slf4j
public class BlacklistHandler extends GatewayHandler {
    @Override
    public void service() {
        log.info("第二關 黑名單攔截.......");
        //指向下一關
        nextService();
    }
}

@Component
@Slf4j
public class ConversationHandler extends GatewayHandler {
    @Override
    public void service() {
        log.info("第三關 用戶的會話信息攔截.......");
        }
}

基於數據庫實現

相關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);

Utils

@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);
    }

}

GatewayHandlerService

/**
 * @title: GatewayHandlerService
 */
@Service
public class GatewayHandlerService {
    @Autowired
    private GatewayHandlerMapper gatewayHandlerMapper;
    private GatewayHandler firstGatewayHandler;
    /**
     * 獲取數據庫第一個handeler封裝
     */
    public GatewayHandler getFirstGatewayHandler() {
        if (firstGatewayHandler != null) {
            return firstGatewayHandler;
        }
        //1.【第一個實體】
        GatewayHandlerEntity firstGatewayHandlerEntity = gatewayHandlerMapper.getFirstGatewayHandler();
        if(firstGatewayHandlerEntity==null){ return null; }
        //2.【第一個HandlerId】
        String firstHhandlerId = firstGatewayHandlerEntity.getHandlerId();
        //3.【第二個HandlerId】
        String secondHandlerId = firstGatewayHandlerEntity.getNextHandlerId();
        //4.【第一個bean對象】
        GatewayHandler firstGatewayHandler = SpringUtils.getBean(firstHhandlerId, GatewayHandler.class);
        //5.【tmpHandler爲第一個bean對象】
        GatewayHandler tmpHandler=firstGatewayHandler;
        //如果下一個HandlerId不爲null，則繼續
        while (!StringUtils.isBlank(secondHandlerId)){
            //6.【第二個bean對象】->11.【第三個bean對象】
            GatewayHandler secondGatewayHandler = SpringUtils.getBean(secondHandlerId, GatewayHandler.class);
            //7.【設置第一個bean對象的next爲第二個bean對象】->12.【設置第二個bean對象的next爲第三個bean對象】
            tmpHandler.setNextGatewayHandler(secondGatewayHandler);
            //8.【第二個實體】->13.【第三個實體】
            GatewayHandlerEntity secondHandlerEntity = gatewayHandlerMapper.getByHandler(secondHandlerId);
            if (secondHandlerEntity==null){ break; }
            //9.【第三個HandlerId】->14.【第四個HandlerId】此時爲null，後面會退出循環
            secondHandlerId=secondHandlerEntity.getNextHandlerId();
            //10.【tmpHandler爲第二個bean對象】->15.【tmpHandler爲第三個bean對象】
            tmpHandler=secondGatewayHandler;
        }
        //16.賦值
        this.firstGatewayHandler=firstGatewayHandler;
        //17.返回第一個firstHandler對象
        return  firstGatewayHandler;
    }
}

數據庫訪問層

GatewayHandlerMapper

public interface GatewayHandlerMapper {

    /**
     * 獲取第一個GatewayHandler
     */
    @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);

}

Entity層

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

}

Controller層

/**
 * @title: HandlerController
 */
@RestController
public class HandlerController {
    @Autowired
    private GatewayHandlerService gatewayHandlerService;

    @RequestMapping("/client")
    public String client() {
        GatewayHandler firstGatewayHandler = gatewayHandlerService.getFirstGatewayHandler();
        firstGatewayHandler.service();
        return "success";
    }
}

相關配置信息

版權@須臾之餘https://my.oschina.net/u/3995125

application.yml

###服務啓動端口號
server:
  port: 8080

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


####打印MyBatias日誌
logging:
  level:
    ### 開發環境使用DEBUG 生產環境info或者error
    com.xuyu.mapper: DEBUG

Maven依賴信息

 <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.1.RELEASE</version>
    </parent>
    <dependencies>
        <!-- sprinboot web -->
        <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>
        <!-- mysql -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
    </dependencies>

啓動類

/**
 * @title: AppHandler
 */
@SpringBootApplication
@MapperScan("com.xuyu.mapper")
@EnableAutoConfiguration
public class AppHandler {
    public static void main(String[] args) {
        SpringApplication.run(AppHandler.class);
        
    }
}

效果

2019-05-09 23:33:33.136  INFO 40524 --- [nio-8080-exec-6] c.xuyu.handler.impl.CurrentLimitHandler  : 第一關 API接口限流操作.....
2019-05-09 23:33:33.136  INFO 40524 --- [nio-8080-exec-6] com.xuyu.handler.impl.BlacklistHandler   : 第二關 黑名單攔截.......
2019-05-09 23:33:33.136  INFO 40524 --- [nio-8080-exec-6] c.xuyu.handler.impl.ConversationHandler  : 第三關 用戶的會話信息攔截.......

版權

本文參考：螞蟻課堂：http://www.mayikt.com