这个注解一次搞定限流与熔断降级：@SentinelResource

时间 2019-11-09

标签这个注解一次搞定限流熔断降级 sentinelresource 繁體版

原文原文链接

在以前的《使用Sentinel实现接口限流》一文中，咱们仅依靠引入Spring Cloud Alibaba对Sentinel的整合封装spring-cloud-starter-alibaba-sentinel，就完成了对全部Spring MVC接口的限流控制。然而，在实际应用过程当中，咱们可能须要限流的层面不只限于接口。可能对于某个方法的调用限流，对于某个外部资源的调用限流等都但愿作到控制。呢么，这个时候咱们就不得不手工定义须要限流的资源点，并配置相关的限流策略等内容了。前端

今天这篇咱们就来一块儿学习一下，如何使用@SentinelResource注解灵活的定义控制资源以及如何配置控制策略。java

自定义资源点

下面的例子基于您已经引入了Spring Cloud Alibaba Sentinel为基础，若是您还不会这些，建议优先阅读《使用Sentinel实现接口限流》。git

第一步：在应用主类中增长注解支持的配置：github

@SpringBootApplication
public class TestApplication {

    public static void main(String[] args) {
        SpringApplication.run(TestApplication.class, args);
    }

    // 注解支持的配置Bean
    @Bean
    public SentinelResourceAspect sentinelResourceAspect() {
        return new SentinelResourceAspect();
    }

}
复制代码

第二步：在须要经过Sentinel来控制流量的地方使用@SentinelResource注解，好比下面以控制Service逻辑层的某个方法为例：spring

@Slf4j
@Service
public class TestService {

    @SentinelResource(value = "doSomeThing")
    public void doSomeThing(String str) {
        log.info(str);
    }

}
复制代码

到这里一个须要被保护的方法就定义完成了。下面咱们分别说说，定义了资源点以后，咱们如何实现不一样的保护策略，包括：限流、降级等。后端

如何实现限流与熔断降级

在定义了资源点以后，咱们就能够经过Dashboard来设置限流和降级策略来对资源点进行保护了。同时，也能够经过@SentinelResource来指定出现限流和降级时候的异常处理策略。下面，就来一块儿分别看看限流和降级都是如何实现的。缓存

实现限流控制

第一步：在Web层调用这个被保护的方法：bash

@RestController
public class TestController {

    @Autowired
    private TestService testService;

    @GetMapping("/hello")
    public String hello() {
        estService.doSomeThing("hello " + new Date());
        return "didispace.com";
    }

}
复制代码

第二步：启动测试应用，启动Sentinel-Dashboard。发一个请求到/hello接口上，使得Sentinel-Dashboard上能够看到以下图所示的几个控制点：app

能够看到，除了如以前入门实例中那样有/hello资源点以外，多了一个doSomeThing资源点。能够经过界面为这个资源点设置限流规则，好比将其QPS设置为2。因为/hello资源不设置限流规则，因此只要请求/hello接口，就能够直接模拟调用doSomeThing资源，来观察限流规则是否生效。函数

下面能够经过任何你喜欢的工具来调用/hello接口，只要QPS超过2，那么就会出现以下的错误返回，表明限流策略生效了。

此时，服务端的控制台也会有对应的限流报错日志：

2019-06-27 11:30:43.514  INFO 36898 --- [nio-8001-exec-3] c.d.a.sentinel.service.TestService       : aaa
2019-06-27 11:30:43.905 ERROR 36898 --- [nio-8001-exec-4] o.a.c.c.C.[.[.[/].[dispatcherServlet]    : Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception [Request processing failed; nested exception is java.lang.reflect.UndeclaredThrowableException] with root cause

com.alibaba.csp.sentinel.slots.block.flow.FlowException: null
复制代码

实现限流的异常处理

默认状况下，Sentinel对控制资源的限流处理是直接抛出异常，也就是上一节中贴出的日志内容。在没有合理的业务承接或者前端对接状况下能够这样，可是正常状况为了更好的用户业务，都会实现一些被限流以后的特殊处理，咱们不但愿展现一个生硬的报错。那么只须要基于上面的例子作一些加工，好比：

@Slf4j
@Service
public class TestService {

    @SentinelResource(value = "doSomeThing", blockHandler = "exceptionHandler")
    public void doSomeThing(String str) {
        log.info(str);
    }

    // 限流与阻塞处理
    public void exceptionHandler(String str, BlockException ex) {
        log.error( "blockHandler：" + str, ex);
    }
    
}
复制代码

主要作了两件事：

经过@SentinelResource注解的blockHandler属性制定具体的处理函数
实现处理函数，该函数的传参必须与资源点的传参同样，而且最后加上BlockException异常参数；同时，返回类型也必须同样。

若是熟悉Hystrix的读者应该会发现，这样的设计与HystrixCommand中定义fallback很类似，仍是很容易理解的。

完成上面的改动以后，再尝试访问接口（注意限流规则须要配置好），此时前端就不会返回异常信息了，后端会打印exceptionHandler中定义的日志输出。而在实际应用的时候，只要根据业务须要对限流请求作缓存或者前端提示等均可以基于此方法来实现。

实现熔断降级

@SentinelResource注解除了能够用来作限流控制以外，还能实现与Hystrix相似的熔断降级策略。下面就来具体看看如何使用吧。

第一步：与限流控制同样，使用@SentinelResource注解标记资源点，好比：

@Slf4j
@Service
public class TestService {

    @SentinelResource(value = "doSomeThing2")
    public void doSomeThing2(String str) {
        log.info(str);
        throw new RuntimeException("发生异常");
    }

}
复制代码

这里在TestService类中建立了一个新的方法，并使用@SentinelResource将该资源命名为doSomeThing2。该方法会抛出异常，以配合后续制定基于异常比例的降级策略（相似Hystrix）。Sentinel相比Hystrix更丰富，还有基于响应时间和异常数的降级策略。

第二步：在Web层调用这个被保护的方法：

@RestController
public class TestController {

    @Autowired
    private TestService testService;

    @GetMapping("/hello2")
    public String hello2() {
        testService.doSomeThing2("hello2 " + new Date());
        return "didispace.com";
    }

}
复制代码

第三步：启动测试应用，启动Sentinel-Dashboard。发一个请求到/hello2接口上，使得Sentinel-Dashboard上能够看到名为doSomeThing2的资源点。而后点击”降级“按钮，为该资源设置降级规则。这里使用异常比例策略，比例设置为0.5（即：50%的异常率），时间窗口设置为2（秒）。

第四步：验证熔断降级，根据上面的降级策略配置，当doSomeThing2方法的调用QPS >= 5，若是异常率超过50%，那么后续2秒内的调用将直接出发熔断降级，默认状况会直接抛出DegradeException异常，好比：

2019-06-27 17:49:58.913 ERROR 99863 --- [nio-8001-exec-2] o.a.c.c.C.[.[.[/].[dispatcherServlet]    : Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception [Request processing failed; nested exception is java.lang.reflect.UndeclaredThrowableException] with root cause

com.alibaba.csp.sentinel.slots.block.degrade.DegradeException: null
复制代码

熔断的降级处理

在Sentinel中定义熔断的降级处理方法很是简单，与Hystrix很是类似。只须要使用@SentinelResource注解的fallback属性来指定具体的方法名便可。这里也须要注意传参与返回必须一致。好比：

@Slf4j
@Service
public class TestService {

    // 熔断与降级处理
    @SentinelResource(value = "doSomeThing2", fallback = "fallbackHandler")
    public void doSomeThing2(String str) {
        log.info(str);
        throw new RuntimeException("发生异常");
    }

    public void fallbackHandler(String str) {
        log.error("fallbackHandler：" + str);
    }
}
复制代码

完成上面的改造以后，重启应用，并设置doSomeThing2资源的熔断降级策略（使用异常百分比），而后频繁的请求/hello2接口。在QPS>=5以后，因为这个接口一直在抛出异常，因此必定会知足熔断降级条件，这时候就会执行fallbackHandler方法，不断的打印以下日志：

2019-06-27 23:44:19.432 ERROR 58471 --- [nio-8001-exec-1] c.d.a.sentinel.service.TestService       : fallbackHandler：hello2 Thu Jun 27 23:44:19 CST 2019
2019-06-27 23:44:19.599 ERROR 58471 --- [nio-8001-exec-2] c.d.a.sentinel.service.TestService       : fallbackHandler：hello2 Thu Jun 27 23:44:19 CST 2019
2019-06-27 23:44:19.791 ERROR 58471 --- [nio-8001-exec-3] c.d.a.sentinel.service.TestService       : fallbackHandler：hello2 Thu Jun 27 23:44:19 CST 2019
2019-06-27 23:44:19.975 ERROR 58471 --- [nio-8001-exec-4] c.d.a.sentinel.service.TestService       : fallbackHandler：hello2 Thu Jun 27 23:44:19 CST 2019
2019-06-27 23:44:20.168 ERROR 58471 --- [nio-8001-exec-5] c.d.a.sentinel.service.TestService       : fallbackHandler：hello2 Thu Jun 27 23:44:20 CST 2019
复制代码

代码示例

本文介绍内容的客户端代码，示例读者能够经过查看下面仓库中的alibaba-sentinel-annotation项目：

Github：github.com/dyc87112/Sp…
Gitee：gitee.com/didispace/S…

若是您对这些感兴趣，欢迎star、follow、收藏、转发给予支持！