@SentinelResource注解如何使用?请你过目!
@SentinelResource注解如何使用?请你过目!
Hello,大家好,我是麦洛,今天带大家来了解一下Sentinel中@SentinelResource注解的使用方法 ,这篇文章主要向大家介绍一下以下内容
- @SentinelResource 注解
- 注解介绍
- 注解使用
?由于笔者水平有限,文章难免有不当之处,恳请读者不吝赐教并提出意见 目前公众号没有留言功能,如何找到我??大家可以关注我的公众号:今日Java, 后台回复"加群"就可以获取到我的个人微信,同时也可以拉大家进交流群一起交流学习✌
@SentinelResource 注解
注意：注解方式埋点不支持 private 方法。
注解介绍
@SentinelResource 用于定义资源，并提供可选的异常处理和 fallback 配置项。
@SentinelResource 注解包含以下属性：
value：资源名称，必需项（不能为空）entryType：entry类型，可选项（默认为EntryType.OUT）blockHandler/blockHandlerClass:blockHandler对应处理BlockException的函数名称，可选项。blockHandler函数访问范围需要是public，返回类型需要与原方法相匹配，参数类型需要和原方法相匹配并且最后加一个额外的参数，类型为BlockException。blockHandler函数默认需要和原方法在同一个类中。若希望使用其他类的函数，则可以指定blockHandlerClass为对应的类的Class对象，注意对应的函数必需为static函数，否则无法解析。fallback/fallbackClass：fallback函数名称，可选项，用于在抛出异常的时候提供fallback处理逻辑。fallback函数可以针对所有类型的异常（除了exceptionsToIgnore里面排除掉的异常类型）进行处理。fallback函数签名和位置要求：- 返回值类型必须与原函数返回值类型一致；
- 方法参数列表需要和原函数一致，或者可以额外多一个
Throwable类型的参数用于接收对应的异常。 fallback函数默认需要和原方法在同一个类中。若希望使用其他类的函数，则可以指定fallbackClass为对应的类的Class对象，注意对应的函数必需为static函数，否则无法解析。
defaultFallback（since 1.6.0）：默认的fallback函数名称，可选项，通常用于通用的fallback逻辑（即可以用于很多服务或方法）。默认fallback函数可以针对所有类型的异常（除了exceptionsToIgnore里面排除掉的异常类型）进行处理。若同时配置了fallback和defaultFallback，则只有fallback会生效。defaultFallback函数签名要求：- 返回值类型必须与原函数返回值类型一致；
- 方法参数列表需要为空，或者可以额外多一个
Throwable类型的参数用于接收对应的异常。 - defaultFallback 函数默认需要和原方法在同一个类中。若希望使用其他类的函数，则可以指定
fallbackClass为对应的类的Class对象，注意对应的函数必需为 static 函数，否则无法解析。
exceptionsToIgnore（since 1.6.0）：用于指定哪些异常被排除掉，不会计入异常统计中，也不会进入fallback逻辑中，而是会原样抛出。
1.8.0 版本开始，defaultFallback 支持在类级别进行配置。
注：1.6.0 之前的版本 fallback 函数只针对降级异常（
DegradeException）进行处理，不能针对业务异常进行处理。
特别地，若 blockHandler 和 fallback 都进行了配置，则被限流降级而抛出 BlockException 时只会进入 blockHandler 处理逻辑。若未配置 blockHandler、fallback 和 defaultFallback，则被限流降级时会将 BlockException 直接抛出（若方法本身未定义 throws BlockException 则会被 JVM 包装一层 UndeclaredThrowableException）。
注解使用
代码编写
代码结构
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;
}
}
启动我们的项目,访问我们的测试方法(多刷新几次,去看控制面板)
限流测试
现在我们为我们的资源:hello 配置一个流控规则,配置步骤如下图
配置成功:
回到我们的页面,快速刷新页面,我们会发现偶尔有如下信息显示,说明我们配置的流控规则成功进行了拦截
控制台日志:
根据我们上面的学习,如果超过我们配置的QPS,代码会抛出BlockException异常,为什么代码里面是FlowException,通过查看源码我们会发现FlowException其实是BlockException的子级
经过上面的测试,我们发现成功实现注解开发实现了限流
降级测试
降级测试之前,我们需要修改下我们的代码
前:
@SentinelResource(value = "hello", blockHandler = "exceptionHandler", fallback = "helloFallback")
后:
@SentinelResource(value = "hello", fallback = "helloFallback")
配置流控规则
配置降级规则:
测试方法
根据我们配置的规则,如果qps>1,肯定会出发BlockException,这时候降级规则判断异常比例超过请求次数的20%,就会自动触发降级?;
我的点击速率: 匀速 ---到--- 快速?
大家观察这里的日志,在我刚开始匀速点击时候,并没有进入helloFallback方法,当我快速点击时候,进入了helloFallback方法,说明这时候降级规则生效,触发降级,进入回调函数helloFallback中;
今天的分享就到这里,谢谢大家