概念

Gateway是整个应用的大门,是整个集群的入口,我们订单服务集群,商品服务集群等等集群都是由Gateway调用的,那我们其实可以在Gateway访问商品服务集群或者订单服务集群之前来使用sentinel进行流控

从 1.6.0 版本开始，Sentinel 提供了 Spring Cloud Gateway 的适配模块，可以提供两种资源维度的限流：

  • route 维度：即在 Spring 配置文件中配置的路由条目，资源名为对应的 routeId
  • 自定义 API 维度：用户可以利用 Sentinel 提供的 API 来自定义一些 API 分组

代码地址

https://gitee.com/zjj19941/ZJJ_Neaten5.10/tree/master/ZJJ_Gateway/demo10

代码

pom依赖

  1. <!-- gateway接入sentinel  -->
  2. <dependency>
  3.   <groupId>com.alibaba.cloud</groupId>
  4.   <artifactId>spring-cloud-alibaba-sentinel-gateway</artifactId>
  5. </dependency>
  7. <dependency>
  8.   <groupId>com.alibaba.cloud</groupId>
  9.   <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
  10. </dependency>

yaml配置

  1. server:
  2.   port: 8888
  3. spring:
  4.   application:
  5.     name: mall-gateway-sentinel-demo
  6.   main:
  7.     allow-bean-definition-overriding: true
  8.   #配置nacos注册中心地址
  9.   cloud:
  10.     nacos:
  11.       discovery:
  12.         server-addr: zjj101:8848
  14.     sentinel:
  15.       transport:
  16.         # 添加sentinel的控制台地址
  17.         dashboard: zjj101:8855
  18.         # 指定应用与Sentinel控制台交互的端口，应用本地会起一个该端口占用的HttpServer
  19.         #port: 8719
  21.     gateway:
  22.       # 是否开启网关
  23.       enabled: true
  24.       #设置路由：路由id、路由到微服务的uri、断言
  25.       routes:
  26.         - id: order_route  #路由ID，全局唯一，建议配合服务名
  27.           uri: lb://mall-order  #lb 整合负载均衡器ribbon,loadbalancer
  28.           predicates:
  29.             - Path=/order/**

配置限流异常处理器和限流过滤器

  2. @Configuration
  3. public class GatewayConfiguration {
  5.     private final List<ViewResolver> viewResolvers;
  6.     private final ServerCodecConfigurer serverCodecConfigurer;
  8.     public GatewayConfiguration(ObjectProvider<List<ViewResolver>> viewResolversProvider,
  9.                                 ServerCodecConfigurer serverCodecConfigurer) {
  10.         this.viewResolvers = viewResolversProvider.getIfAvailable(Collections::emptyList);
  11.         this.serverCodecConfigurer = serverCodecConfigurer;
  12.     }
  14.     /**
  15.      * 限流异常处理器
  16.      *
  17.      * @return
  18.      */
  19.     @Bean
  20.     @Order(Ordered.HIGHEST_PRECEDENCE)
  21.     public SentinelGatewayBlockExceptionHandler sentinelGatewayBlockExceptionHandler() {
  22.         // Register the block exception handler for Spring Cloud Gateway.
  23.         return new SentinelGatewayBlockExceptionHandler(viewResolvers, serverCodecConfigurer);
  24.     }
  26.     /**
  27.      * 限流过滤器
  28.      *
  29.      * @return
  30.      */
  31.     @Bean
  32.     @Order(Ordered.HIGHEST_PRECEDENCE)
  33.     public GlobalFilter sentinelGatewayFilter() {
  34.         return new SentinelGatewayFilter();
  35.     }
  38.     @PostConstruct
  39.     public void doInit() {
  40. //        //初始化自定义的API
  41.         //   initCustomizedApis();
  42. //        //初始化网关限流规则
  43. //        initGatewayRules();
  44. //        //自定义限流异常处理器
  45.         initBlockRequestHandler();
  46.     }
  49.     private void initCustomizedApis() {
  50.         Set<ApiDefinition> definitions = new HashSet<>();
  51.         // 资源保护名user_service_api    Path:/user/**
  52.         ApiDefinition api = new ApiDefinition("user_service_api")
  53.                 .setPredicateItems(new HashSet<ApiPredicateItem>() {{
  54.                     add(new ApiPathPredicateItem().setPattern("/user/**")
  55.                             .setMatchStrategy(SentinelGatewayConstants.URL_MATCH_STRATEGY_PREFIX));
  56.                 }});
  57.         definitions.add(api);
  58.         GatewayApiDefinitionManager.loadApiDefinitions(definitions);
  59.     }
  61.     private void initGatewayRules() {
  62.         Set<GatewayFlowRule> rules = new HashSet<>();
  63.         //resource：资源名称，可以是网关中的 route 名称或者用户自定义的 API 分组名称。
  64.         //count：限流阈值
  65.         //intervalSec：统计时间窗口，单位是秒，默认是 1 秒。
  66.         rules.add(new GatewayFlowRule("order_route")
  67.                 .setCount(1)
  68.                 .setIntervalSec(1)
  69.         );
  70.         rules.add(new GatewayFlowRule("user_service_api")
  71.                 .setCount(2)
  72.                 .setIntervalSec(1)
  73.         );
  75.         // 加载网关规则
  76.         GatewayRuleManager.loadRules(rules);
  77.     }
  79.     /**
  80.      * 自定义异常处理器
  81.      */
  82.     private void initBlockRequestHandler() {
  83.         BlockRequestHandler blockRequestHandler = new BlockRequestHandler() {
  84.             @Override
  85.             public Mono<ServerResponse> handleRequest(ServerWebExchange exchange, Throwable t) {
  86.                 HashMap<String, String> result = new HashMap<>();
  87.                 result.put("code", String.valueOf(HttpStatus.TOO_MANY_REQUESTS.value()));
  88.                 result.put("msg", "你已经被限流了");
  90.                 return ServerResponse.status(HttpStatus.TOO_MANY_REQUESTS)
  91.                         .contentType(MediaType.APPLICATION_JSON)
  92.                         .body(BodyInserters.fromValue(result));
  93.             }
  94.         };
  95.         //设置自定义异常处理器
  96.         GatewayCallbackManager.setBlockHandler(blockRequestHandler);
  97.     }
  99. }

测试

image.png

当postman访问超过阈值的时候会触发 自定义异常处理器 配置的返回值
image.png