41 基于Sentinel的限流

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

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

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

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 分组维度进行限流。

（1）环境搭建

导入Sentinel 的响应依赖

<dependency>
    <groupId>com.alibaba.csp</groupId>
    <artifactId>sentinel-spring-cloud-gateway-adapter</artifactId>
    <version>x.y.z</version>
</dependency>
    

（2） 编写配置类

@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;
    }
    /**
    * 配置限流的异常处理器:SentinelGatewayBlockExceptionHandler
    */
    @Bean
    @Order(Ordered.HIGHEST_PRECEDENCE)
    public SentinelGatewayBlockExceptionHandler
        sentinelGatewayBlockExceptionHandler() {
        return new SentinelGatewayBlockExceptionHandler(viewResolvers,
        serverCodecConfigurer);
    }
    /**
    * 配置限流过滤器
    */
    @Bean
    @Order(Ordered.HIGHEST_PRECEDENCE)
    public GlobalFilter sentinelGatewayFilter() {
        return new SentinelGatewayFilter();
    }
    /**
    * 配置初始化的限流参数
    */
    @PostConstruct
    public void initGatewayRules() {
        Set<GatewayFlowRule> rules = new HashSet<>();
        rules.add(
        new GatewayFlowRule("order-service") //资源名称
        .setCount(1) // 限流阈值
        .setIntervalSec(1) // 统计时间窗口，单位是秒，默认是 1 秒
        );
        GatewayRuleManager.loadRules(rules);
        }
}

（3）网关配置

spring:
    application:
        name: api-gateway #指定服务名
    redis:
        host: 127.0.0.1
        port: 6379
        database: 0
    cloud:
        gateway:
            routes:
                - id: order-service
                uri: lb://shop-service-order
                predicates:
                - Path=/order-service/**
                filters:
                - RewritePath=/order-service/(?<segment>.*), /$\{segment}

在一秒钟内多次访问
http://localhost:8080/order-service/order/buy/1就可以看到限流启作用了。

（4）自定义异常提示

当触发限流后页面显示的是Blocked by Sentinel: FlowException。为了展示更加友好的限流提示， Sentinel支持自定义异常处理。

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

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

@PostConstruct
public void initBlockHandlers() {
BlockRequestHandler blockRequestHandler = new BlockRequestHandler() {
    public Mono<ServerResponse> handleRequest(ServerWebExchange
    serverWebExchange, Throwable throwable) {
    Map map = new HashMap<>();
    map.put("code", 001);
    map.put("message", "对不起,接口限流了");
    return ServerResponse.status(HttpStatus.OK).
    contentType(MediaType.APPLICATION_JSON_UTF8).
    body(BodyInserters.fromObject(map));
    }
    };
    GatewayCallbackManager.setBlockHandler(blockRequestHandler);
}

（5） 参数限流

上面的配置是针对整个路由来限流的，如果我们只想对某个路由的参数做限流，那么可以使用参数限流 方式：

rules.add(new GatewayFlowRule("order-service")
    .setCount(1)
    .setIntervalSec(1)
    .setParamItem(new GatewayParamFlowItem()
    .setParseStrategy(SentinelGatewayConstants.PARAM_PARSE_STRATEGY_URL_PARAM).setFi
    eldName("id")
    )
);

通过指定
PARAM_PARSE_STRATEGY_URL_PARAM表示从url中获取参数，setFieldName指定参数名称

（6） 自定义API分组

@PostConstruct
private void initCustomizedApis() {
    Set<ApiDefinition> definitions = new HashSet<>();
    ApiDefinition api1 = new ApiDefinition("product_api")
    .setPredicateItems(new HashSet<ApiPredicateItem>() {{
    //以/product-service/product 开头的请求
    add(new ApiPathPredicateItem().setPattern("/productoservice/product/**").
    setMatchStrategy(SentinelGatewayConstants.URL_MATCH_STRATEGY_PREFIX));
    }});
    ApiDefinition api2 = new ApiDefinition("order_api")
    .setPredicateItems(new HashSet<ApiPredicateItem>() {{
    ///order-service/order 完成的url路径匹配
    add(new ApiPathPredicateItem().setPattern("/order-service/order"));
}});
    definitions.add(api1);
    definitions.add(api2);
    GatewayApiDefinitionManager.loadApiDefinitions(definitions);
}