Spring Cloud Alibaba Sentinel 网关流量控制之Spring Cloud Gateway实战

深碍√TFBOYSˉ_ 2024-04-17 05:30 107阅读 0赞

学习本篇文章之前如果你还没有了解过`Sentinel`是什么的话，请先学习一下[分布式系统的流量防卫兵Sentinel-入门指南][Sentinel-]。这样就这轻松学习`Spring Cloud Alibaba Sentinel`的使用。

## 1.简介 ##

Sentinel 支持对 `Spring Cloud Gateway`、`Zuul` 等主流的 API Gateway 进行限流。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9saWRvbmcxNjY1LmJsb2cuY3Nkbi5uZXQ_size_16_color_FFFFFF_t_70]  
Sentinel 1.6.0 引入了 `Sentinel API Gateway Adapter Common` 模块，此模块中包含网关限流的规则和自定义 API 的实体和管理逻辑：

*  GatewayFlowRule：网关限流规则，针对 API Gateway 的场景定制的限流规则，可以针对不同 route 或自定义的 API 分组进行限流，支持针对请求中的参数、Header、来源 IP 等进行定制化的限流。
 *  ApiDefinition：用户自定义的 API 定义分组，可以看做是一些 URL 匹配的组合。比如我们可以定义一个 API 叫 my\_api，请求 path 模式为 /foo/\*\* 和 /baz/\*\* 的都归到 my\_api 这个 API 分组下面。限流的时候可以针对这个自定义的 API 分组维度进行限流。

其中网关限流规则 GatewayFlowRule 的字段解释如下：

*  resource：资源名称，可以是网关中的 `route 名称`或者用户自定义的`API 分组名称`。
 *  resourceMode：规则是针对 `API Gateway` 的`route（RESOURCE_MODE_ROUTE_ID）`还是用户在 Sentinel 中定义的`API 分组（RESOURCE_MODE_CUSTOM_API_NAME）`，默认是`route`。
 *  grade：限流指标维度，同限流规则的`grade` 字段。
 *  count：限流阈值
 *  intervalSec：统计时间窗口，单位是秒，默认是`1 秒`（目前仅对参数限流生效）。

*  controlBehavior：流量整形的控制效果，同限流规则的 `controlBehavior` 字段，目前支持快速失败和匀速排队两种模式，默认是快速失败。
 *  burst：应对突发请求时额外允许的请求数目（目前仅对参数限流生效）。
 *  maxQueueingTimeoutMs：匀速排队模式下的最长排队时间，单位是毫秒，仅在匀速排队模式下生效。
 *  paramItem：参数限流配置。若不提供，则代表不针对参数进行限流，该网关规则将会被转换成普通流控规则；否则会转换成热点规则。其中的字段：
    
     *  parseStrategy：从请求中提取参数的策略，目前支持提取来源 IP`（PARAM_PARSE_STRATEGY_CLIENT_IP）`、`Host（PARAM_PARSE_STRATEGY_HOST）`、`任意 Header（PARAM_PARSE_STRATEGY_HEADER）`和`任意 URL 参数（PARAM_PARSE_STRATEGY_URL_PARAM）`四种模式。
    
     *  fieldName：若提取策略选择 Header 模式或 URL 参数模式，则需要指定对应的 `header 名称`或 `URL 参数名称`。
     *  pattern 和 matchStrategy：为后续参数匹配特性预留，目前未实现。

用户可以通过 `GatewayRuleManager.loadRules(rules)`手动加载网关规则，或通过 `GatewayRuleManager.register2Property(property)`注册动态规则源动态推送（推荐方式）。

## 2.网关流控实现原理 ##

当通过 `GatewayRuleManager` 加载网关流控规则`（GatewayFlowRule）`时，无论是否针对请求属性进行限流，Sentinel 底层都会将网关流控规则转化为热点参数规则`（ParamFlowRule）`，存储在`GatewayRuleManager` 中，与正常的热点参数规则相隔离。转换时 Sentinel 会根据请求属性配置，为网关流控规则设置参数索引（idx），并同步到生成的热点参数规则中。

外部请求进入 API Gateway 时会经过 Sentinel 实现的 `filter`，其中会依次进行 `路由/API 分组匹配`、`请求属性解析`和`参数组装`。Sentinel 会根据配置的网关流控规则来解析请求属性，并依照参数索引顺序组装参数数组，最终传入`SphU.entry(res, args)` 中。`Sentinel API Gateway Adapter Common` 模块向 `Slot Chain` 中添加了一个 `GatewayFlowSlot`，专门用来做网关规则的检查。`GatewayFlowSlot` 会从`GatewayRuleManager`中提取生成的热点参数规则，根据传入的参数依次进行规则检查。若某条规则不针对请求属性，则会在参数最后一个位置置入预设的常量，达到普通流控的效果。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9saWRvbmcxNjY1LmJsb2cuY3Nkbi5uZXQ_size_16_color_FFFFFF_t_70 1]

## 3.Spring Cloud Gateway 的支持 ##

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

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

### 3.1 使用时需引入以下模块（以 Maven 为例）： ###

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-actuator</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-webflux</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-gateway</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
    
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-sentinel-gateway</artifactId>
                <version>2.1.0.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
                <version>2.1.0.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>com.alibaba.csp</groupId>
                <artifactId>sentinel-transport-simple-http</artifactId>
                <version>1.6.3</version>
            </dependency>
            <dependency>
                <groupId>com.alibaba.csp</groupId>
                <artifactId>sentinel-spring-cloud-gateway-adapter</artifactId>
                <version>1.6.3</version>
            </dependency>

### 3.2 添加SentinelGatewayFilter和SentinelGatewayBlockExceptionHandler实例 ###

使用时只需注入对应的 `SentinelGatewayFilter` 实例以及 `SentinelGatewayBlockExceptionHandler` 实例即可。

@Configuration
    public class GatewayConfiguration { 
    
        private final List<ViewResolver> viewResolvers;
        private final ServerCodecConfigurer serverCodecConfigurer;
    
        public GatewayConfiguration(ObjectProvider<List<ViewResolver>> viewResolversProvider,
                                    ServerCodecConfigurer serverCodecConfigurer) { 
            this.viewResolvers = viewResolversProvider.getIfAvailable(Collections::emptyList);
            this.serverCodecConfigurer = serverCodecConfigurer;
        }
    
        @Bean
        @Order(Ordered.HIGHEST_PRECEDENCE)
        public SentinelGatewayBlockExceptionHandler sentinelGatewayBlockExceptionHandler() { 
            // Register the block exception handler for Spring Cloud Gateway.
            return new SentinelGatewayBlockExceptionHandler(viewResolvers, serverCodecConfigurer);
        }
    
        @Bean
        @Order(-1)
        public GlobalFilter sentinelGatewayFilter() { 
            return new SentinelGatewayFilter();
        }
    }

### 3.3 添加application.yml和bootstrap.yml配置 ###

#### application.yml ####

server:
      port: 9022 #提供者的端口
    management:
      endpoints:
        web:
          exposure:
            include: '*'
    logging:
      level:
        org.springframework.cloud.gateway: trace
        org.springframework.http.server.reactive: debug
        org.springframework.web.reactive: debug
        reactor.ipc.netty: debug
    
    spring:
      application:
        name: spring-cloud-gateway-service
      main:
        allow-bean-definition-overriding: true

###### bootstrap.yml配置 ######

spring:
      cloud:
        gateway:
          enabled: true
          discovery:
            locator:
              lower-case-service-id: true
          routes:
            # Add your routes here.
            - id: aliyun_route
              uri: https://www.aliyun.com/
              predicates:
                - Path=/product/**
            - id: httpbin_route
              uri: https://httpbin.org
              predicates:
                - Path=/httpbin/**
              filters:
                - RewritePath=/httpbin/(?<segment>.*), /$\{ segment}
            #认证服务路由
            - id: auth-service
              predicates:
                - Path=/auth-service/**
              uri: lb://spring-cloud-nacos-auth-service
              filters:
                - StripPrefix=1
        sentinel:
          datasource.ds2.file:
            file: "classpath: gateway.json"
            ruleType: gw-flow
          datasource.ds1.file:
            file: "classpath: api.json"
            ruleType: gw-api-group
        nacos:
          discovery:
            server-addr: 192.168.10.200:8848

其中两个规则：api.json和gateway.json

##### api.json #####

[
      { 
        "apiName": "some_customized_api",
        "predicateItems": [
          { 
            "pattern": "/product/baz"
          },
          { 
            "pattern": "/product/foo/**",
            "matchStrategy": 1
          },
          { 
            "items": [
              { 
                "pattern": "/spring-cloud/**"
              },
              { 
                "pattern": "/spring-cloud-alibaba/**"
              }
            ]
          }
        ]
      },
      { 
        "apiName": "another_customized_api",
        "predicateItems": [
          { 
            "pattern": "/ahas"
          }
        ]
      }
    ]

##### gateway.json #####

[
      { 
        "resource": "some_customized_api",
        "count": 1
      },
      { 
        "resource": "httpbin_route",
        "count": 0,
        "paramItem": { 
          "parseStrategy": 2,
          "fieldName": "Spring-Cloud-Alibaba"
        }
      },
      { 
        "resource": "httpbin_route",
        "count": 0,
        "paramItem": { 
          "parseStrategy": 3,
          "fieldName": "name"
        }
      }
    ]

### 3.4 添加 API 分组和route 维度 ###

同时自定义了一些 API 分组：

private void initCustomizedApis() { 
            Set<ApiDefinition> definitions = new HashSet<>();
            ApiDefinition api1 = new ApiDefinition("some_customized_api")
                .setPredicateItems(new HashSet<ApiPredicateItem>() { { 
                    add(new ApiPathPredicateItem().setPattern("/ahas"));
                    add(new ApiPathPredicateItem().setPattern("/product/**")
                        .setMatchStrategy(SentinelGatewayConstants.URL_MATCH_STRATEGY_PREFIX));
                }});
            ApiDefinition api2 = new ApiDefinition("another_customized_api")
                .setPredicateItems(new HashSet<ApiPredicateItem>() { { 
                    add(new ApiPathPredicateItem().setPattern("/**")
                        .setMatchStrategy(SentinelGatewayConstants.URL_MATCH_STRATEGY_PREFIX));
                }});
            definitions.add(api1);
            definitions.add(api2);
            GatewayApiDefinitionManager.loadApiDefinitions(definitions);
        }

同时也定义一些route纬度：

private void initGatewayRules() { 
            Set<GatewayFlowRule> rules = new HashSet<>();
            rules.add(new GatewayFlowRule("aliyun_route")
                .setCount(10)
                .setIntervalSec(1)
            );
            rules.add(new GatewayFlowRule("aliyun_route")
                .setCount(2)
                .setIntervalSec(2)
                .setBurst(2)
                .setParamItem(new GatewayParamFlowItem()
                    .setParseStrategy(SentinelGatewayConstants.PARAM_PARSE_STRATEGY_CLIENT_IP)
                )
            );
            rules.add(new GatewayFlowRule("httpbin_route")
                .setCount(10)
                .setIntervalSec(1)
                .setControlBehavior(RuleConstant.CONTROL_BEHAVIOR_RATE_LIMITER)
                .setMaxQueueingTimeoutMs(600)
                .setParamItem(new GatewayParamFlowItem()
                    .setParseStrategy(SentinelGatewayConstants.PARAM_PARSE_STRATEGY_HEADER)
                    .setFieldName("X-Sentinel-Flag")
                )
            );
            rules.add(new GatewayFlowRule("httpbin_route")
                .setCount(1)
                .setIntervalSec(1)
                .setParamItem(new GatewayParamFlowItem()
                    .setParseStrategy(SentinelGatewayConstants.PARAM_PARSE_STRATEGY_URL_PARAM)
                    .setFieldName("pa")
                )
            );
            rules.add(new GatewayFlowRule("httpbin_route")
                .setCount(2)
                .setIntervalSec(30)
                .setParamItem(new GatewayParamFlowItem()
                    .setParseStrategy(SentinelGatewayConstants.PARAM_PARSE_STRATEGY_URL_PARAM)
                    .setFieldName("type")
                    .setPattern("warn")
                    .setMatchStrategy(SentinelGatewayConstants.PARAM_MATCH_STRATEGY_CONTAINS)
                )
            );
    
            rules.add(new GatewayFlowRule("some_customized_api")
                .setResourceMode(SentinelGatewayConstants.RESOURCE_MODE_CUSTOM_API_NAME)
                .setCount(5)
                .setIntervalSec(1)
                .setParamItem(new GatewayParamFlowItem()
                    .setParseStrategy(SentinelGatewayConstants.PARAM_PARSE_STRATEGY_URL_PARAM)
                    .setFieldName("pn")
                )
            );
            /** * 手动加载网关规则 */
            GatewayRuleManager.loadRules(rules);
        }

那么这里面的 route ID（如 product\_route）和 API name（如 some\_customized\_api）都会被标识为 Sentinel 的资源。比如访问网关的 URL 为 `http://localhost:9022/product/ahas`的时候，对应的统计会加到 `product_route`和 `some_customized_api` 这两个资源上面，而 `http://localhost:8090/httpbin/json` 只会对应到 `httpbin_route` 资源上面。

您可以在 `GatewayCallbackManager` 注册回调进行定制：

*  `setBlockHandler`：注册函数用于实现自定义的逻辑处理被限流的请求，对应接口为 `BlockRequestHandler`。默认实现为 `DefaultBlockRequestHandler`，当被限流时会返回类似于下面的错误信息：`Blocked by Sentinel: FlowException`。

### 3.5 添加服务的启动类 ###

package com.lidong.gateway;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    /** * 开启服务发现 */
    
    @SpringBootApplication
    public class SentinelGatewayApplication { 
    
        public static void main(String[] args) { 
            SpringApplication.run(SentinelGatewayApplication.class, args);
        }
    
    }

### 3.6 添加控制台 ###

<dependency>
                <groupId>com.alibaba.csp</groupId>
                <artifactId>sentinel-transport-simple-http</artifactId>
                <version>1.6.3</version>
    </dependency>

添加启动参数

-Dcsp.sentinel.app.type=1 -Dcsp.sentinel.dashboard.server=localhost:8080 -Dproject.name=gateway-sentinel

csp.sentinel.app.type=1 代表网关类型

### 3.7启动网关服务 ###

java -jar gateway-sentinel.jar  -Dcsp.sentinel.app.type=1 -Dcsp.sentinel.dashboard.server=localhost:8080 -Dproject.name=gateway-sentinel

然后通过网关访问

[http://localhost:9022/product/ahas][http_localhost_9022_product_ahas]

我们就可以看到如下的界面，转发到阿里云的ahas的产品页面  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9saWRvbmcxNjY1LmJsb2cuY3Nkbi5uZXQ_size_16_color_FFFFFF_t_70 2]

### 3.8 控制台查看 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9saWRvbmcxNjY1LmJsb2cuY3Nkbi5uZXQ_size_16_color_FFFFFF_t_70 3]  
Sentinel 1.6.3 引入了网关流控控制台的支持，用户可以直接在 Sentinel 控制台上查看 API Gateway 实时的 `route` 和`自定义 API` 分组监控，管理网关规则和 API 分组配置。

我们可以在控制台配置自定义的 API 分组，将一些 URL 匹配模式归为一个 API 分组：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9saWRvbmcxNjY1LmJsb2cuY3Nkbi5uZXQ_size_16_color_FFFFFF_t_70 4]  
然后我们可以在控制台针对预设的 route ID 或自定义的 API 分组配置网关流控规则

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9saWRvbmcxNjY1LmJsb2cuY3Nkbi5uZXQ_size_16_color_FFFFFF_t_70 5]

到这里一个简单spring-cloud-alibaba-sentinel-gateway网关的案例基本上就完成了。

本案例的源代码已经上传github :[https://github.com/lidong1665/spring-cloud-learning-example/tree/master/spring-cloud-gateway-service-sentinel][https_github.com_lidong1665_spring-cloud-learning-example_tree_master_spring-cloud-gateway-service-sentinel]

最后想一起交流技术的可以加我wx:  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9saWRvbmcxNjY1LmJsb2cuY3Nkbi5uZXQ_size_16_color_FFFFFF_t_70 6]

[Sentinel-]: https://blog.csdn.net/u010046908/article/details/100012953
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9saWRvbmcxNjY1LmJsb2cuY3Nkbi5uZXQ_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/1841643a07df4e80812dbb3589397adc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9saWRvbmcxNjY1LmJsb2cuY3Nkbi5uZXQ_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/8e4e5aca98864d908af781ebc7d47559.png
[http_localhost_9022_product_ahas]: http://localhost:9022/product/ahas
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9saWRvbmcxNjY1LmJsb2cuY3Nkbi5uZXQ_size_16_color_FFFFFF_t_70 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/8113ad7705ab4c768bb207d1b65c9523.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9saWRvbmcxNjY1LmJsb2cuY3Nkbi5uZXQ_size_16_color_FFFFFF_t_70 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/b9dc03fd3e2e499dbe13081e5d6c20ed.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9saWRvbmcxNjY1LmJsb2cuY3Nkbi5uZXQ_size_16_color_FFFFFF_t_70 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/9867ad08d1cf4009a074b3d5105509f2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9saWRvbmcxNjY1LmJsb2cuY3Nkbi5uZXQ_size_16_color_FFFFFF_t_70 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/a5adccb9c1d74628a4c69aaf045b3765.png
[https_github.com_lidong1665_spring-cloud-learning-example_tree_master_spring-cloud-gateway-service-sentinel]: https://github.com/lidong1665/spring-cloud-learning-example/tree/master/spring-cloud-gateway-service-sentinel
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9saWRvbmcxNjY1LmJsb2cuY3Nkbi5uZXQ_size_16_color_FFFFFF_t_70 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/13a03af4a4834d3980ea0ae09da88236.png