Sentinel集成Gateway

小忠呐
133 阅读5分钟

开启掘金成长之旅！这是我参与「掘金日新计划 · 2 月更文挑战」的第 17 天，点击查看活动详情

每日英语：

Action is the foundational key to all success.

行动是一切成功的关键。 -巴勃罗·毕加索

Sentinel集成Gateway

我们的项目流量入口是SpringCloud Gateway，因此我们重点讲一下Sentinel集成Gateway。

Sentinel对网关支持

Sentinel 支持对 Spring Cloud Gateway、Zuul 等主流的 API Gateway 进行限流。

58381714-266d7980-7ff3-11e9-8617-d0d7c325d703.png

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：参数值的匹配模式，只有匹配该模式的请求属性值会纳入统计和流控；若为空则统计该请求属性的所有值。（1.6.2 版本开始支持）
    • matchStrategy：参数值的匹配策略，目前支持精确匹配（PARAM_MATCH_STRATEGY_EXACT）、子串匹配（PARAM_MATCH_STRATEGY_CONTAINS）和正则匹配（PARAM_MATCH_STRATEGY_REGEX）。（1.6.2 版本开始支持）

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

集成Sentinel

我们如果想要让微服务网关集成Sentinel，需要引入依赖包，使用时只需注入对应的 SentinelGatewayFilter 实例以及 SentinelGatewayBlockExceptionHandler 实例即可。

依赖:

<!--Sentinel-->
<dependency>
    <groupId>com.alibaba.csp</groupId>
    <artifactId>sentinel-spring-cloud-gateway-adapter</artifactId>
    <version>1.8.0</version>
</dependency>

实例引入：创建配置类com.xz.mall.api.config.GatewayConfiguration:

@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;
    }
​
    /**
     * 限流的异常处理器
     * @return
     */
    @Bean
    @Order(Ordered.HIGHEST_PRECEDENCE)
    public SentinelGatewayBlockExceptionHandler sentinelGatewayBlockExceptionHandler() {
        return new SentinelGatewayBlockExceptionHandler(viewResolvers, serverCodecConfigurer);
    }
​
    /***
     * Sentinel路由处理核心过滤器
     * @return
     */
    @Bean
    @Order(-1)
    public GlobalFilter sentinelGatewayFilter() {
        return new SentinelGatewayFilter();
    }
}

此时集成就完成了。

配置/API定义

1)API定义

正如前面所说，ApiDefinition用户自定义的 API 定义分组，可以看做是一些 URL 匹配的组合。比如我们可以定义一个 API 叫 my_api，请求 path 模式为 /foo/** 和 /baz/** 的都归到 my_api 这个 API 分组下面。限流的时候可以针对这个自定义的 API 分组维度进行限流。

我们在配置类com.xz.mall.api.config.GatewayConfiguration创建Api：

/***
 * Api定义
 */
private void initCustomizedApis() {
    //Api集合
    Set<ApiDefinition> definitions = new HashSet<ApiDefinition>();
    ApiDefinition cartApi = new ApiDefinition("mall_cart_api")
            .setPredicateItems(new HashSet<ApiPredicateItem>() {{
                add(new ApiPathPredicateItem().setPattern("/cart/list"));
                add(new ApiPathPredicateItem().setPattern("/cart/*")
                        //参数值的匹配策略
                        // 精确匹配（PARAM_MATCH_STRATEGY_EXACT）
                        // 子串匹配（PARAM_MATCH_STRATEGY_CONTAINS）
                        // 正则匹配（PARAM_MATCH_STRATEGY_REGEX）
                        .setMatchStrategy(SentinelGatewayConstants.URL_MATCH_STRATEGY_PREFIX));
            }});
    definitions.add(cartApi);
    //加载Api
    GatewayApiDefinitionManager.loadApiDefinitions(definitions);
}

2)规则创建

GatewayFlowRule网关限流规则，针对 API Gateway 的场景定制的限流规则，可以针对不同 route 或自定义的 API 分组进行限流，支持针对请求中的参数、Header、来源 IP 等进行定制化的限流。

我们在配置类com.xz.mall.api.config.GatewayConfiguration创建配置：

/***
 * 规则定义
 */
private void initGatewayRules() {
    //网关限流规则
    Set<GatewayFlowRule> rules = new HashSet<GatewayFlowRule>();
​
    //商品微服务规则配置
    //资源名称，可以是网关中的 route 名称或者用户自定义的 API 分组名称
    rules.add(new GatewayFlowRule("goods_route")
            //限流阈值
            .setCount(2)
            //应对突发请求时额外允许的请求数目。
            .setBurst(2)
            //统计时间窗口，单位是秒，默认是 1 秒。
            .setIntervalSec(1)
            //限流行为
            //CONTROL_BEHAVIOR_RATE_LIMITER 匀速排队
            //CONTROL_BEHAVIOR_DEFAULT 快速失败(默认)
            .setControlBehavior(RuleConstant.CONTROL_BEHAVIOR_RATE_LIMITER)
            //匀速排队模式下的最长排队时间，单位是毫秒，仅在匀速排队模式下生效。
            .setMaxQueueingTimeoutMs(1000)
    );
    //API 【mall_cart_api】限流配置
    rules.add(new GatewayFlowRule("mall_cart_api")
            //限流阈值
            .setCount(3)
            //统计时间窗口，单位是秒，默认是 1 秒。
            .setIntervalSec(1)
    );
    //加载网关规则
    GatewayRuleManager.loadRules(rules);
}

3)配置/Api加载

上面两个方法创建了API并且创建了配置，但并没有在程序启动加载，我们可以采用@PostConstruct注解实现加载调用，在com.xz.mall.api.config.GatewayConfiguration中创建方法：

/***
 * 初始化加载Api和规则
 */
@PostConstruct
public void doInit() {
    initCustomizedApis();
    initGatewayRules();
}

总结

本篇主要介绍了一下Sentinel如何集成Gateway。

avatar
文章
阅读
粉丝