Spring Cloud Alibaba Sentinel - - ＞流控规则初体验

Sentinel 可以简单的分为 Sentinel 核心库 (sentinel-core依赖) 和 Dashboard (Sentinel控制台)。核心库不依赖 Dashboard，但是结合 Dashboard 可以取得最好的效果 (因为通过Sentinel控制台，我们可以更方便的设置规则，不仅效率提高了，还能进行实时监控，而无需编写java代码来设置规则)。 - - > 当然学习中还是以代码方式为准。

这篇文章主要介绍 Sentinel 核心库的使用。如果希望有一个最快最直接的了解，可以参考 新手指南 来获取一个最直观的感受。

我们说的资源，可以是任何东西，服务，服务里的方法，甚至是一段代码。使用 Sentinel 来进行资源保护，主要分为几个步骤:

1. 定义资源
2. 定义规则
3. 检验规则是否生效

先把可能需要保护的资源定义好（埋点），之后再配置规则。也可以理解为，只要有了资源，我们就可以在任何时候灵活地定义各种流量控制规则。在编码的时候，只需要考虑这个代码是否需要保护，如果需要保护，就将之定义为一个资源。

对于主流的框架，我们提供适配，只需要按照适配中的说明配置，Sentinel 就会默认定义提供的服务，方法等为资源。

注意：Sentinel 需要 JDK 1.8 或更高版本。

需要注意的是，Sentinel 并不是一定要在 Spring Cloud Alibaba 上使用的，我们可以单纯的去使用 Sentinel 核心库。它可以在分布式架构中使用，而不是一定要在微服务架构中使用。

如果您使用的是 Maven，只需在pom.xml中添加以下依赖项。

<dependency>
    <groupId>com.alibaba.csp</groupId>
    <artifactId>sentinel-core</artifactId>
</dependency>

Sentinel 的流控规则、降级规则等都是针对项目中的接口来进行设置的，需要依赖 web 接口，需要引入 web场景启动器 spring-boot-starter-web 依赖。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

创建一个接口，在接口中定义资源，资源名称一般和接口地址一致。

@GetMapping("/hello")
 public String hello(){
     Entry entry = null;
     try {
         // sentinel 针对资源进行限制的，通常这个资源名称会跟接口的地址名称保持一致
         entry = SphU.entry(RESOURCE_NAME);

         // 被保护的业务逻辑
         String str = "hello word";
         log.info("- - -> " + str + " <- - -");
         return str;
     } catch (BlockException e) {
         // 资源访问阻止，被限流 或 被降级
         // 进行相应的处理操作
         log.info("block");
         return "被流控了";
     } catch (Exception e) {
         // 若需要配置降级规则，需要通过这种方式记录业务异常
         Tracer.traceEntry(e, entry);
     }finally {
         if(entry != null){
             entry.exit();
         }
     }

     return null;
 }

接下来，通过流控规则来指定允许该资源通过的请求次数，例如下面的代码定义了资源 HelloWorld 每秒最多只能通过 1 个请求。

@PostConstruct // Spring的初始化方法
private static void initFlowRules(){
    // 流控规则
    List<FlowRule> rules = new ArrayList<>();
    // 流控
    FlowRule rule = new FlowRule();
    // 设置受保护的资源（即为哪个资源进行流量控制）
    rule.setResource(RESOURCE_NAME);
    // 设置流控规则 QPS
    rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
    // 设置受保护的资源阈值
    // Set limit QPS to 20，设置每秒的访问数为20，超过20的部分就会进行限流
    //rule.setCount(20);
    // Set limit QPS to 1，设置每秒的访问数为1，超过1的部分就会到catch(BlockException e)里去
    rule.setCount(1);
    rules.add(rule);

    // 加载配置好的规则
    FlowRuleManager.loadRules(rules);
}

完成上面 3 步，Sentinel 就能够正常工作了。更多的信息可以参考 使用文档。

完整代码

@RestController
@Slf4j
public class HelloController {

    private static final String RESOURCE_NAME = "hello";
    private static final String USER_RESOURCE_NAME = "user";
    private static final String DEGRADE_RESOURCE_NAME = "degrade";

    /**
     * 进行Sentinel流控规则
     *
     * Sentinel 所有的规则都是针对于接口来的，准确点说是针对资源来设置的
     */
    @GetMapping("/hello")
    public String hello(){
        Entry entry = null;
        try {
            // sentinel 针对资源进行限制的，通常这个资源名称会跟接口的地址名称保持一致
            entry = SphU.entry(RESOURCE_NAME);

            // 被保护的业务逻辑，如果是RPC调用远程服务的接口，那么这里被保护的就是RPC远程服务接口
            String str = "hello word";
            log.info("- - -> " + str + " <- - -");
            // 如果没有被流控，则正常返回
            return str;
        } catch (BlockException e) {
            // 资源访问阻止，被限流 或 被降级
            // 进行相应的处理操作
            log.info("block");
            // 如果被流控了，则返回被流控了
            return "被流控了";
        } catch (Exception e) {
            // 若需要配置降级规则，需要通过这种方式记录业务异常
            Tracer.traceEntry(e, entry);
        }finally {
            if(entry != null){
                entry.exit();
            }
        }

        return null;
    }


    @PostConstruct // Spring的初始化方法
    private static void initFlowRules(){
        // 流控规则
        List<FlowRule> rules = new ArrayList<>();
        // 流控
        FlowRule rule = new FlowRule();
        // 设置受保护的资源（即为哪个资源进行流量控制）
        rule.setResource(RESOURCE_NAME);
        // 设置流控规则 QPS
        rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
        // 设置受保护的资源阈值
        // Set limit QPS to 20，设置每秒的访问数为20，超过20的部分就会进行限流
        //rule.setCount(20);
        // Set limit QPS to 1，设置每秒的访问数为1，超过1的部分就会到catch(BlockException e)里去
        rule.setCount(1);
        rules.add(rule);

        // 加载配置好的规则
        FlowRuleManager.loadRules(rules);
    }

}