本篇博客将为大家介绍SentinelAPI
1. SphU(官方文档)
1.1 概念
SphU
包含了 try-catch 风格的 API。用这种方式,当资源发生了限流之后会抛出 BlockException
。这个时候可以捕捉异常,进行限流之后的逻辑处理。
1.2 示例
第一步:在TestController 新建一个方法
@GetMapping("/test-sentinel-api")
public String testSentinelAPI(@RequestParam(required = false) String a){
// 定义个sentinel保护的资源,名称是test-sentinel-api
Entry entry = null;
String resourceName = "test-sentinel-api";
try {
entry = SphU.entry(resourceName);
// 被保护的业务逻辑
if (StringUtils.isBlank(a)){
throw new IllegalArgumentException("a is empty");
}
return a;
// 如果被保护的资源被限流或者降级了,就会抛BlockException异常
} catch (BlockException e) {
log.warn("限流,或者降级了",e);
return "限流,或者降级了";
} finally {
if (entry != null){
// 退出entry
entry.exit();
}
}
}
第二步:在浏览器请求一直请求接口
- 若请求的接口地址带参数,则一直返回
- 若请求的接口地址不带参数,则一直报IllegalArgumentException异常
第三步:添加流控规则
选择QPS,单机阈值为1
此时如果进行频繁的请求超过阈值怎接口返回
限流,或者降级了
2. 业务异常统计 Tracer (官方文档)
2.1 概念
业务异常记录类 Tracer
用于记录业务异常
2.2 示例
第一步:修改方法
@GetMapping("/test-sentinel-api")
public String testSentinelAPI(@RequestParam(required = false) String a){
// 定义个sentinel保护的资源,名称是test-sentinel-api
Entry entry = null;
String resourceName = "test-sentinel-api";
try {
entry = SphU.entry(resourceName);
// 被保护的业务逻辑
if (StringUtils.isBlank(a)){
throw new IllegalArgumentException("a is empty");
}
return a;
// 如果被保护的资源被限流或者降级了,就会抛BlockException异常
} catch (BlockException e) {
log.warn("限流,或者降级了",e);
return "限流,或者降级了";
}catch (IllegalArgumentException e2){
// 统计IllegalArgumentException 次数、占比等等
Tracer.trace(e2);
return "参数非法";
}finally {
if (entry != null){
// 退出entry
entry.exit();
}
}
}
第二步: 添加降级规则
为资源名test-sentinel-api 添加降级规则
降级策略:异常比例
异常比例:0.1
时间窗口:1
第三步:多次不带参数进行接口请求
返回:参数非法
3. 上下文工具类 ContextUtil(官方文档)
3.1 示例
第一步:修改代码
@GetMapping("/test-sentinel-api")
public String testSentinelAPI(@RequestParam(required = false) String a){
// 定义个sentinel保护的资源,名称是test-sentinel-api
Entry entry = null;
String resourceName = "test-sentinel-api";
ContextUtil.enter(resourceName,"test-wfw");
try {
entry = SphU.entry(resourceName);
// 被保护的业务逻辑
if (StringUtils.isBlank(a)){
throw new IllegalArgumentException("a is empty");
}
return a;
// 如果被保护的资源被限流或者降级了,就会抛BlockException异常
} catch (BlockException e) {
log.warn("限流,或者降级了",e);
return "限流,或者降级了";
} catch (IllegalArgumentException e2){
// 统计IllegalArgumentException 次数、占比等等
Tracer.trace(e2);
return "参数非法";
} finally {
if (entry != null){
// 退出entry
entry.exit();
}
ContextUtil.exit();
}
}
第二步:添加规则
针对资源名:test-sentinel-api添加规则
针对来源:test-wfw
阈值类型:QPS
单机阈值:1
第三步:快速请求接口
返回:限流,或者降级了