Springcloud—B站学习总结—Springcloud Alibaba—@SentinelResource注解配置
按资源名称限流 (临时节点) (上)
代码实例:
@GetMapping("/byResource")
@SentinelResource(value = "byResource",blockHandler = "handleException")
public CommonResult byResource()
{
return new CommonResult(200,"按资源名称限流测试OK",new Payment(2020L,"serial001"));
}
public CommonResult handleException(BlockException exception)
{
return new CommonResult(444,exception.getClass().getCanonicalName()+"\t 服务不可用");
}
按URL地址限流
代码实例:
@GetMapping("/rateLimit/byUrl")
//这个没有blockHandler属性,没有兜底方法,所以使用系统默认的
@SentinelResource(value = "byUrl")
public CommonResult byUrl()
{
return new CommonResult(200,"按url限流测试OK",new Payment(2020L,"serial002"));
}
sentinel新增流控规则配置
总结:
1.sentinel配置流控规则可以使用红色圈圈里面的东西来配置流控规则的资源名
1.rest地址路径
2.@SentinelResource注解中的value属性
2.如果@SentinelResource注解中有blockHandler属性,那么发生流控规则就使用自己定义的,如果没有blockHandler属性,那么就使用系统默认的
上述限流兜底的方式会出现的问题
为了解决上述限流兜底的方式会出现的问题,我们来写客户自定义的限流的处理逻辑(中)
步骤:
1.自定义一个类CustomerBlockHandler
,在这个类中处理统一的跳转页面,限流提示,服务降级的说明
被兜底的方法
@GetMapping("/rateLimit/customerBlockHandler")
@SentinelResource(value = "customerBlockHandler",
blockHandlerClass = CustomerBlockHandler.class,
blockHandler = "handlerException2")
public CommonResult customerBlockHandler()
{
return new CommonResult(200,"按客戶自定义",new Payment(2020L,"serial003"));
}
兜底方法
public class CustomerBlockHandler
{
//public static,这个static是必须的,被兜底的方法返回值是什么我们的返回值就是什么,
//参数是BlockException exception
public static CommonResult handlerException(BlockException exception)
{
return new CommonResult(4444,"按客戶自定义,global handlerException----1");
}
public static CommonResult handlerException2(BlockException exception)
{
return new CommonResult(4444,"按客戶自定义,global handlerException----2");
}
}
进一步说明:
@SentinelResource 注解
注意:注解方式埋点不支持 private 方法。所以说使用注解@SentinelResource一般都用public
@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 函数签名要求:
(1).返回值类型必须与原函数返回值类型一致;
(2).方法参数列表需要为空,或者可以额外多一个 Throwable 类型的参数用于接收对应的异常。
(3).defaultFallback 函数默认需要和原方法在同一个类中。若希望使用其他类的函数,则可以指定 fallbackClass 为对应的类的 Class 对象,注意对应的函数必需为 static 函数,否则无法解析。
exceptionsToIgnore(since 1.6.0)
:用于指定哪些异常被排除掉,不会计入异常统计中,也不会进入 fallback 逻辑中,而是会原样抛出。
sentinel的三个核心API
由下图代码可知
针对某个资源名,如果逻辑正确就是OK的,假设违背了我们sentinel的限流规则/配置规则就会被异常BlockException
捕捉,最终退出结束