Sentinel的注解支持 - @SentinelResource使用详解

爱写Bug的麦洛
• 阅读 1940

Hello,大家好,我是麦洛,今天带大家来了解一下Sentinel中@SentinelResource的使用方法 ,这篇文章主要向大家介绍一下以下内容

[TOC]

😀由于笔者水平有限,文章难免有不当之处,恳请读者不吝赐教并提出意见

目前公众号没有留言功能,如何找到我?🙈大家可以关注我的公众号:今日Java, 后台回复"加群"就可以获取到我的个人微信,同时也可以拉大家进交流群一起交流学习✌

@SentinelResource 注解

注意:注解方式埋点不支持 private 方法。

注解介绍

@SentinelResource 用于定义资源,并提供可选的异常处理和 fallback 配置项。

@SentinelResource 注解包含以下属性:

  • value:资源名称,必需项(不能为空)
  • entryTypeentry 类型,可选项(默认为 EntryType.OUT
  • blockHandler / blockHandlerClass: blockHandler 对应处理 BlockException 的函数名称,可选项。blockHandler 函数访问范围需要是 public,返回类型需要与原方法相匹配,参数类型需要和原方法相匹配并且最后加一个额外的参数,类型为 BlockExceptionblockHandler 函数默认需要和原方法在同一个类中。若希望使用其他类的函数,则可以指定 blockHandlerClass 为对应的类的 Class 对象,注意对应的函数必需为 static 函数,否则无法解析。
  • fallback/fallbackClassfallback 函数名称,可选项,用于在抛出异常的时候提供 fallback 处理逻辑。fallback 函数可以针对所有类型的异常(除了exceptionsToIgnore里面排除掉的异常类型)进行处理。fallback 函数签名和位置要求:
    • 返回值类型必须与原函数返回值类型一致;
    • 方法参数列表需要和原函数一致,或者可以额外多一个 Throwable 类型的参数用于接收对应的异常。
    • fallback 函数默认需要和原方法在同一个类中。若希望使用其他类的函数,则可以指定 fallbackClass 为对应的类的 Class 对象,注意对应的函数必需为 static 函数,否则无法解析。
  • defaultFallback(since 1.6.0):默认的 fallback 函数名称,可选项,通常用于通用的 fallback 逻辑(即可以用于很多服务或方法)。默认 fallback 函数可以针对所有类型的异常(除了exceptionsToIgnore里面排除掉的异常类型)进行处理。若同时配置了 fallbackdefaultFallback,则只有 fallback 会生效。defaultFallback 函数签名要求:
    • 返回值类型必须与原函数返回值类型一致;
    • 方法参数列表需要为空,或者可以额外多一个 Throwable 类型的参数用于接收对应的异常。
    • defaultFallback 函数默认需要和原方法在同一个类中。若希望使用其他类的函数,则可以指定 fallbackClass 为对应的类的 Class 对象,注意对应的函数必需为 static 函数,否则无法解析。
  • exceptionsToIgnore(since 1.6.0):用于指定哪些异常被排除掉,不会计入异常统计中,也不会进入 fallback 逻辑中,而是会原样抛出。

1.8.0 版本开始,defaultFallback 支持在类级别进行配置。

注:1.6.0 之前的版本 fallback 函数只针对降级异常(DegradeException)进行处理,不能针对业务异常进行处理

特别地,若 blockHandlerfallback 都进行了配置,则被限流降级而抛出 BlockException 时只会进入 blockHandler 处理逻辑。若未配置 blockHandlerfallbackdefaultFallback,则被限流降级时会将 BlockException 直接抛出(若方法本身未定义 throws BlockException 则会被 JVM 包装一层 UndeclaredThrowableException)。

注解使用

代码编写

Sentinel的注解支持 - @SentinelResource使用详解

SentinelController

/**
 * 注解 @SentinelResource学习
 * @author Milo Lee
 * @date 2021-03-23 11:33
 */
@RestController
public class SentinelController {

    @Autowired
    private ISentinelService service;

    @GetMapping(value = "/hello/{s}")
    public String apiHello(@PathVariable long s) {
        return service.hello(s);
    }
}

ISentinelService

/**
 * @author Milo Lee
 * @date 2021-03-23 11:34
 */
public interface ISentinelService {

    String hello (long s);
}

SentinelServiceImpl

/**
 * @author Milo Lee
 * @date 2021-03-23 11:34
 */
@Service
@Slf4j
public class SentinelServiceImpl implements ISentinelService {


    /**
     *Sentinel 提供了 @SentinelResource 注解用于定义资源
     * @param s
     * @return
     */
    @Override
    //value:资源名称,必需项(不能为空)
    //blockHandler 对应处理 BlockException 的函数名称
    //fallback  用于在抛出异常的时候提供 fallback 处理逻辑
    @SentinelResource(value = "hello", blockHandler = "exceptionHandler", fallback = "helloFallback")
    public String hello(long s) {
        log.error("hello:{}",s);
        return String.format("Hello at %d", s);
    }

    // Fallback 函数,函数签名与原函数一致或加一个 Throwable 类型的参数.
    public String helloFallback(long s) {
        log.error("helloFallback:{}",s);
        return String.format("Halooooo %d", s);
    }

    // Block 异常处理函数,参数最后多一个 BlockException,其余与原函数一致.
    public String exceptionHandler(long s, BlockException ex) {
        // Do some log here.
        log.error("exceptionHandler:{}",s);
        ex.printStackTrace();
        return "Oops, error occurred at " + s;
    }
}

启动我们的项目,访问我们的测试方法(多刷新几次,去看控制面板)

Sentinel的注解支持 - @SentinelResource使用详解

Sentinel的注解支持 - @SentinelResource使用详解

限流测试

现在我们为我们的资源:hello 配置一个流控规则,配置步骤如下图

Sentinel的注解支持 - @SentinelResource使用详解

配置成功:

Sentinel的注解支持 - @SentinelResource使用详解

回到我们的页面,快速刷新页面,我们会发现偶尔有如下信息显示,说明我们配置的流控规则成功进行了拦截

Sentinel的注解支持 - @SentinelResource使用详解

控制台日志:

Sentinel的注解支持 - @SentinelResource使用详解

根据我们上面的学习,如果超过我们配置的QPS,代码会抛出BlockException异常,为什么代码里面是FlowException,通过查看源码我们会发现FlowException其实是BlockException的子级

经过上面的测试,我们发现成功实现注解开发实现了限流

降级测试

降级测试之前,我们需要修改下我们的代码

前:

@SentinelResource(value = "hello", blockHandler = "exceptionHandler", fallback = "helloFallback")

后:

@SentinelResource(value = "hello",  fallback = "helloFallback")

配置流控规则

Sentinel的注解支持 - @SentinelResource使用详解

Sentinel的注解支持 - @SentinelResource使用详解

配置降级规则:

Sentinel的注解支持 - @SentinelResource使用详解

Sentinel的注解支持 - @SentinelResource使用详解

测试方法

根据我们配置的规则,如果qps>1,肯定会出发BlockException,这时候降级规则判断异常比例超过请求次数的20%,就会自动触发降级😛;

Sentinel的注解支持 - @SentinelResource使用详解

我的点击速率: 匀速 ------ 快速😂

大家观察这里的日志,在我刚开始匀速点击时候,并没有进入helloFallback方法,当我快速点击时候,进入了helloFallback方法,说明这时候降级规则生效,触发降级,进入回调函数helloFallback中;

Sentinel的注解支持 - @SentinelResource使用详解

今天的分享就到这里,谢谢大家

点赞
收藏
评论区
推荐文章
blmius blmius
3年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
待兔 待兔
3个月前
手写Java HashMap源码
HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程22
Spring Boot集成 Sentinel 实现接口流量控制
Hello,大家好,我是麦洛,今天带大家来了解一下SpringBoot如何继承Sentinel来实现接口流量控制Sentinel控制台搭建在我的上一篇文章阿里出品的Sentinel到底是个什么玩意?中,已经介绍过如何准备Sentinel控制台,大家可以直接参考;Sentinel客户端项目搭建首先我们来创建一个测试项目,这里初始化
手把手教大家实现一个电子签名
前言Hi,大家好,我是麦洛,最近在项目中遇到一个需求,需要做个html版的电子签名。周末休息整理下思路,顺便分享出来。😀由于笔者水平有限,文章难免有不当之处,恳请读者不吝赐教并提出意见由于公众号没有留言功能,如何找到我?🙈文章尾部我放置了自己的视频号,大家可以给我留言✌什么是电子签名?来自:百度百科电子签名是指中以电子形式所含、所附用于识别签名人身
Wesley13 Wesley13
3年前
Java日期时间API系列31
  时间戳是指格林威治时间1970年01月01日00时00分00秒起至现在的总毫秒数,是所有时间的基础,其他时间可以通过时间戳转换得到。Java中本来已经有相关获取时间戳的方法,Java8后增加新的类Instant等专用于处理时间戳问题。 1获取时间戳的方法和性能对比1.1获取时间戳方法Java8以前
Wesley13 Wesley13
3年前
00:Java简单了解
浅谈Java之概述Java是SUN(StanfordUniversityNetwork),斯坦福大学网络公司)1995年推出的一门高级编程语言。Java是一种面向Internet的编程语言。随着Java技术在web方面的不断成熟,已经成为Web应用程序的首选开发语言。Java是简单易学,完全面向对象,安全可靠,与平台无关的编程语言。
Stella981 Stella981
3年前
Docker 部署SpringBoot项目不香吗?
  公众号改版后文章乱序推荐,希望你可以点击上方“Java进阶架构师”,点击右上角,将我们设为★“星标”!这样才不会错过每日进阶架构文章呀。  !(http://dingyue.ws.126.net/2020/0920/b00fbfc7j00qgy5xy002kd200qo00hsg00it00cj.jpg)  2
Wesley13 Wesley13
3年前
35岁是技术人的天花板吗?
35岁是技术人的天花板吗?我非常不认同“35岁现象”,人类没有那么脆弱,人类的智力不会说是35岁之后就停止发展,更不是说35岁之后就没有机会了。马云35岁还在教书,任正非35岁还在工厂上班。为什么技术人员到35岁就应该退役了呢?所以35岁根本就不是一个问题,我今年已经37岁了,我发现我才刚刚找到自己的节奏,刚刚上路。
Python进阶者 Python进阶者
9个月前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这