经典设计模式之责任链模式【给网关设计一款专属的权限控制】
1、什么是责任链设计模式
客户端发出一个请求,链上的对象都有机会来处理这一请求,而客户端不需要知道谁是具体的处理对象。这样就实现了请求者和接受者之间的解耦,并且在客户端可以实现动态的组合职责链,使编程更有灵活性。
定义:使多个对象都有机会处理请求,从而避免了请求的发送者和接受者之间的耦合关系。将这些对象连成一条链,并沿着这条链传递该请求,直到有对象处理它为止。其过程实际上是一个递归调用。
2、要点
1、有多个对象共同对一个任务进行处理。
2、这个对象使用链式存储结构,形成了一个链,每个对象知道自己的下一个对象。
3、一个对象对任务进行处理,可以添加一些操作之后将任务传递给下一个对象。也可以在此对象上结束任务对处理,并结束任务。
4、客户端负责组装链式结构,但是客户端不需要关心最终是谁来处理了任务。
3、责任链设计模式应用场景
1、多条件流程判断 权限控制
2、ERP系统 流程审批 总经理、人事经理、项目经理
3、Java过滤器的底层实现Filter
比如:在Java过滤器中客户端发送请求到服务器端,过滤会经过参数过滤、session过滤、表单过滤、隐藏过滤、检测请求头过滤。
4、图例说明
1、抽象处理者(Handler)角色:定义出一个处理请求的接口。
2、具体处理者(ConcreteHandler)角色:具体处理者接到请求后,可以选择将请求处理掉,或者将请求传给下家。
5、责任链模式优缺点
优点:
职责链模式的最主要功能就是:动态组合,请求者和接受者解耦。
请求者和接受者松散耦合:请求者不需要知道接受者,也不需要知道如何处理。每个职责对象只负责自己的职责范围,其他的交给后继者。各个组件间完全解耦。
动态组合职责:职责链模式会把功能分散到单独的职责对象中,然后在使用时动态的组合形成链,从而可以灵活的分配职责对象,也可以灵活的添加改变对象职责。
缺点:
产生很多细粒度的对象:因为功能处理都分散到了单独的职责对象中,每个对象功能单一,要把整个流程处理完,需要很多的职责对象,会产生大量的细粒度职责对象。
不一定能处理:每个职责对象都只负责自己的部分,这样就可以出现某个请求,即使把整个链走完,都没有职责对象处理它。这就需要提供默认处理,并且注意构造链的有效性。
6、网关权限控制责任链模式
在网关作为微服务程序的入口,拦截客户端所有的请求实现权限控制 ,比如先判断Api接口限流、黑名单、用户会话、参数过滤。
Api接口限流→黑名单拦截→用户会话→参数过滤
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>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.6</version>
</dependency>
</dependencies>
GatewayHandler 抽象角色
/**
* @Classname GatewayHandler
* @Description TODO
* @Date 2019/5/15 11:42
* @Created by mark
*/
public abstract class GatewayHandler {
//下一个handler
protected GatewayHandler nextGatewayHandler;
//实现handler的处理方案 强制实现
public abstract void service();
public void setNextGatewayHandler(GatewayHandler nextGatewayHandler){
this.nextGatewayHandler = nextGatewayHandler;
}
//指向下一关
protected void nextService(){
if(nextGatewayHandler != null){
nextGatewayHandler.service();
}
}
}
具体Handler实现
@Slf4j
@Component
public class CurrentLimitHandler extends GatewayHandler {
@Override
public void service() {
log.info("第一关 API接口限流操作.....");
nextService();
}
}
@Slf4j
@Component
public class BlacklistHandler extends GatewayHandler {
@Override
public void service() {
log.info("第二关 黑名单拦截.......");
nextService();
}
}
@Slf4j
@Component
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);
service层
@Service
public class GatewayHandlerService {
@Autowired
private GatewayHandlerMapper gatewayHandlerMapper;
//防止每次进来都要查询数据库,减少与数据库的交互
private GatewayHandler firstGatewayHandler;
public GatewayHandler getFirstGatewayHandler(){
if(!Objects.isNull(firstGatewayHandler)){
return firstGatewayHandler;
}
//1、获取第一个实体
GatewayHandlerEntity firstGatewayHandlerEntity = gatewayHandlerMapper.getFirstGatewayHandler();
if(Objects.isNull(firstGatewayHandlerEntity)){
return null;
}
//2、第一个实体的handlerId
String firstHandlerId = firstGatewayHandlerEntity.getHandlerId();
//3、下一个实体的handlerId
String nextHandlerId = firstGatewayHandlerEntity.getNextHandlerId();
//4、获取第一个的bean对象
GatewayHandler firstGatewayHandler = SpringUtils.getBean(firstHandlerId, GatewayHandler.class);
GatewayHandler tempGatewayHandler = firstGatewayHandler;
while (StringUtils.isNotBlank(nextHandlerId)){
//5、查找下一个handler
GatewayHandler nextGatewayHandler = SpringUtils.getBean(nextHandlerId, GatewayHandler.class);
//6、查找下一个entity
GatewayHandlerEntity nextGatewayHandlerEntity = gatewayHandlerMapper.getByHandler(nextHandlerId);
if(Objects.isNull(nextGatewayHandlerEntity)){
break;
}
//循环给nextHandlerId赋值
nextHandlerId = nextGatewayHandlerEntity.getNextHandlerId();
tempGatewayHandler.setNextGatewayHandler(nextGatewayHandler);
tempGatewayHandler = nextGatewayHandler;
}
//赋值
this.firstGatewayHandler = firstGatewayHandler;
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 {
/**
* 主键ID
*/
private Integer id;
/**
* handler名称
*/
private String handlerName;
/**
* handler主键id
*/
private String handlerId;
/**
* 上一个handler
*/
private String prevHandlerId;
/**
* 下一个handler
*/
private String nextHandlerId;
}
工具类 SpringUtils
@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);
}
}
控制层
@RestController
public class HandlerController {
@Autowired
private GatewayHandlerService gatewayHandlerService;
@RequestMapping("/client")
public String client() {
GatewayHandler firstGatewayHandler = gatewayHandlerService.getFirstGatewayHandler();
firstGatewayHandler.service();
return "success";
}
}
配置相关信息 application.yml
###服务启动端口号
server:
port: 8080
spring:
datasource:
url: jdbc:mysql://127.0.0.1:3306/design_pattern?useUnicode=true&characterEncoding=UTF-8
username: root
password: 123456
driver-class-name: com.mysql.jdbc.Driver
####打印MyBatias日志
logging:
level:
### 开发环境使用DEBUG 生产环境info或者error
com.xwhy.mapper: DEBUG
启动类
@SpringBootApplication
@MapperScan("com.xwhy.mapper")
public class HandlerApp {
public static void main(String[] args) {
SpringApplication.run(HandlerApp.class,args);
}
}
运行效果
2019-05-15 14:38:10.449 INFO 40524 --- [nio-8080-exec-6] c.xuyu.handler.impl.CurrentLimitHandler : 第一关 API接口限流操作.....
2019-05-15 14:38:10.449 INFO 40524 --- [nio-8080-exec-6] com.xuyu.handler.impl.BlacklistHandler : 第二关 黑名单拦截.......
2019-05-15 14:38:10.449 INFO 40524 --- [nio-8080-exec-6] c.xuyu.handler.impl.ConversationHandler : 第三关 用户的会话信息拦截.......