概述

Spring Cloud Alibaba默认为Sentinel整合了Servlet、RestTemplate、FeignClient和Spring WebFlux。它不仅补全了Hystrix在Servlet和RestTemplate这一块的空白，而且还完全兼容Hystrix在FeignClient中限流降级的用法，并支持灵活配置和调整流控规则。

Sentinel接入Spring Cloud

导入pom依赖

<dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
            <version>2.1.2.RELEASE</version>
        </dependency>

创建接口、指定限流资源

@SentinelResource(value = "hello", blockHandler = "blockHandlerHello")
    @GetMapping("/say")
    public String hello() {
        return "hello, Mic";
    }

    public String blockHandlerHello(BlockException e) {
        return "被限流了";
    }

在上述代码中，配置限流资源有几种情况：

  • Sentinel stater在默认情况下会为所有的HTTP服务提供限流埋点，所以如果只想对HTTP服务进行限流，那么只需要添加依赖即可，不需要修改任何代码。
  • 如果想要对特定的方法进行限流或者降级，则需要通过@SentinelResource注解来实现限流资源的定义。
  • 可以通过SphU.entry()方法来配置资源。

代码方式配置流控规则

可以借助Sentinel的InitFunc SPI扩展接口来实现，只需要实现自己的InitFunc接口，并在方法中编写规则加载的逻辑即可。

public class FlowRuleInitFunc implements InitFunc {
    @Override
    public void init() throws Exception {
        List<FlowRule> rules = new ArrayList<>();
        FlowRule rule = new FlowRule();
        rule.setCount(1);
        rule.setResource("hello");
        rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
        rule.setLimitApp("default");
        rules.add(rule);
        FlowRuleManager.loadRules(rules);
    }
}

SPI是扩展点机制，如果需要被Sentinel加载，那么还要在resource目录下创建META-INF/services/com.alibaba.csp.sentinel.init.InitFunc文件，文件内容就是自定义扩展点的全路径。

com.study.nacos.nacosstudy.config.FlowRuleInitFunc

spring 集成rocket主从 spring集成sentinel_spring


按照上述配置好之后，在初次访问任意资源的时候，Sentinel就会自动加载hello资源的流控规则。

限流测试

启动服务后，访问http://localhost:8080/say方法，当访问频率超过设定阈值时，就会触发限流。

使用Dashboard方式配置流控

基于Sentinel Dashboard来配置流控规则，可以实现流控规则的动态配置，执行步骤如下。

启动Sentinel Dashboard

在application.properties中添加如下配置

spring.application.name=spring-cloud-sentinel-sample
spring.cloud.sentinel.transport.dashboard=127.0.0.1:8080

spring.cloud.sentinel.transport.dashboard指向的是Sentinel Dashboard的服务器地址，可以实现流控数据的监控和流控规则的分发。

提供一个REST接口

@GetMapping("/dash")
    public String dash() {
        return "Hello Dash";
    }

此处不需要添加任何资源埋点，在默认情况下Sentinel Starter会对所有HTTP请求进行限流。
启动服务后，此时访问http://localhost:8080/dash，由于没有配置流控规则，所以不存在限流行为。

至此，Spring Cloud集成Sentinel就配置完成了，接下来，进入Sentinel Dashboard来实现流控规则的配置。

dashboard看板配置限流规则

  • 进入spring.application.name对应的菜单，访问“簇点链路”，在该列表下可以看到/dash这个REST接口的资源名称。
  • 针对/dash这个资源名称，可以在图中最右边的操作栏单击“流控”按钮设置流控规则。
  • 新增完成之后，再次访问http://localhost:8080/dash接口，当QPS超过1时，就可以看到限流的效果，并获得如下输出：
Blocked by Sentinel (flow limiting)

自定义URL限流异常

修改异常返回值

在默认情况下，URL触发限流后会直接返回

Blocked by Sentinel (flow limiting)

在实际应用中，大都采用JSON格式的数据，所以如果希望修改触发限流之后的返回结果形式，则可以通过自定义限流异常来处理，实现BlockExceptionHandler 并且重写handle方法。

@Service
public class CustomUrlBlockHandler implements BlockExceptionHandler {

    @Override
    public void handle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, BlockException e) throws Exception {
        httpServletResponse.setHeader("Content-Type", "application/json;charset=UTF-8");
        String message = "{\"code\":999,\"msg\":\"访问人数过多\"}";
        httpServletResponse.getWriter().write(message);
    }
}

测试结果：

spring 集成rocket主从 spring集成sentinel_HTTP_02

异常返回降级页面

还有一种场景是，当触发限流之后，我们希望直接跳转到一个降级页面，可以通过下面这个配置来实现。

spring.cloud.sentinel.servlet.block-page={url}

URL资源清洗

Sentinel中HTTP服务的限流默认有Sentinel-Web-Servlet包中的CommonFilter来实现，从代码中可以看到，这个Filter会把每个不同的URL都作为不同的资源来处理。
在下面这段代码中，提供了一个携带{id}参数的REST风格API，对于每一个不同的{id}，URL也都不一样，所以在默认情况下Sentinel会把所有的URL当做资源来进行流控。

@GetMapping("/clean/{id}")
    public String clean(@PathVariable("id") int id) {
        return "Hello clean " + id;
    }

这会导致两个问题：

  • 限流统计不准确，实际需求是控制clean方法总的QPS，结果统计的是每个URL的QPS。
  • 导致Sentinel中资源数量过多，默认资源数量的阈值时6000，对于多处的资源规则将不会生效。
    针对这个问题可以通过UrlCleaner接口来实现资源清洗，也就是对于/clean/{id}这个URL，我们可以同一归集到/clean/* 资源下，具体配置代码如下，实现UrlCeaner接口，并重写clean方法即可。
@Service
public class CustomUrlBlockHandler implements BlockExceptionHandler, UrlCleaner {

    @Override
    public void handle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, BlockException e) throws Exception {
        httpServletResponse.setHeader("Content-Type", "application/json;charset=UTF-8");
        String message = "{\"code\":999,\"msg\":\"访问人数过多\"}";
        httpServletResponse.getWriter().write(message);
    }

    @Override
    public String clean(String s) {
        if (StringUtils.isEmpty(s)) {
            return s;
        }
        if (s.startsWith("/clean/")) {
            return "/clean/*";
        }
        return s;
    }
}

参考

阿里限流神器Sentinel夺命连环 17 问？