SpringCloud集成Sentinel实践-蒲公英云

文章目录

- - - （一）接入SpringCloud
    - （二）配置流控规则
    - （三）基于Sentinel Dashboard来实现流控配置
    - （四）自定义URL限流异常
    - （五）URL资源清洗

（一）接入SpringCloud

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

创建SpringBoot项目，引入如下依赖

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
            <version>2.1.1.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

创建一个测试接口，对外提供一个测试断点/hello,代码如下，其中SentinelResource表示当前方法标识为一个资源，value对应的是资源名称，blockHandler 为触发限流后调用的处理逻辑，这里对应的即是下面的myBlockHandler方法，注意该方法必须是public修饰

@RestController
public class DemoController { 
    @SentinelResource(value = "Maynard", blockHandler = "myBlockHandler")
    @GetMapping("/hello")
    public String test() { 
        return "hello Maynard";
    }
    public String myBlockHandler(BlockException exception) { 
        return "The system is current limited";
    }
}

注意事项：

Sentinel starter在默认情况下会为所有的HTTP服务提供限流埋点，所以如果只想对HTTP服务进行限流，那么只需要添加依赖即可，不需要修改任何代码。

2、如果想要对特定的方法进行限流或者降级，则需要通过@SentinalResouce注解来实现限流资源的定义。

3、可以通过SphU.entry (）方法来配置资源。

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

（二）配置流控规则

创建一个类实现InitFunc 接口，重写init方法，其中FlowRule标识一个限流策略，这里设置了资源名称Maynard，设置了以QPS流控判断方式，并且为了手动测试方便设置了count=1，即每秒QPS=1就触发限流

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

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

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

启动服务后，访问http://localhost:8080/hello方法，当访问频率超过设定阈值时，就会触发限流。上述配置过程是基于手动配置来加载流控规则的，还有一种方式就是通过Sentinel Dashboard来进行配置。
在这里插入图片描述

（三）基于Sentinel Dashboard来实现流控配置

Sentinel Dashboard管理后台能够进行可视化方式构建流控规则，实现流控规则动态配置，如何启动Sentinel Dashboard不再赘述

Spring:
  application:
    name: sentinel-demo
  cloud:
    sentinel:
      transport:
        dashboard: 127.0.0.1:7777

spring.cloud.sentinel.transport.dashboard指向的是Sentinel Dashboard的服务器地址，可以实现流控数据的监控和流控规则的分发，构建测试endpoint，然后在Dashboard中找到对应的断点，新增流控规则

在这里插入图片描述

新增规则中的所有配置信息，实际就是FlowRule中对应的属性配置，为了演示效果，把单机阈值设置为1。新增完成之后，再次访问http://localhost:8080/dash接口，当QPS超过1时，就可以看到限流的效果

（四）自定义URL限流异常

在之前的案例中，当发生限流后是直接调用某个方法，然后返回的也是该方法返回信息，在实际应用中，大都采用JSON格式的数据，所以如果希望修改触发限流之后的返回结果形式则可以通过自定义限流异常来处理，实现UrlBlockHandler并且重写blocked方法:
在这里插入图片描述
还有一种场景是，当触发限流之后，我们希望直接跳转到一个降级页面，可以通过下面这个配置来实现。

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

（五）URL资源清洗

Sentinel中HTTP服务的限流默认由Sentinel-Web-Servlet包中的CommonFilter来实现，从代码中可以看到，这个Filter会把每个不同的URL都作为不同的资源来处理。
在下面这段代码中，提供了一个携带(id}参数的REST风格API，对于每一个不同的[id),URL也都不一样，所以在默认情况下Sentinel会把所有的URL当作资源来进行流控。
在这里插入图片描述
以上情况会存在俩个问题：
1、限流统计不准确，实际需要时控制某个/xxx下总的QPS，而不区分具体的ID，结果统计的事细分后每个/XX/111 请求类似的QPS
2、导致Sentinel中资源数量过多，默认资源数量的阈值是6000，对于多出的资源规则将不会生效

针对这个问题，可以通过UrlCleaner接口来实现资源清洗，也就是对于/XX/{id}这个URL，可以统一的汇聚划分到/XXX下

@Service
public class CustomerUrlCleaner implements UrlCleaner { 
    @Override
    public String clean(String originUrl) { 
        if (StringUtils.isEmpty(originUrl)) { 
            return originUrl;
        }
        if (originUrl.startsWith("/XXXX/")) { 
            return "/XXXX/*";
        }
        return originUrl;
    }
}