Sentinel 提供了 @SentinelResource 注解用于定义资源,并提供了 AspectJ 的扩展用于自动定义资源、处理 BlockException 等。
@SentinelResource 用于定义资源,并提供可选的异常处理和 fallback 配置项。 @SentinelResource 注解包含以下属性:
-
value:资源名称,必需项(不能为空)
-
entryType:entry 类型,可选项(默认为 EntryType.OUT)
-
blockHandler / blockHandlerClass: blockHandler 对应处理 BlockException 的函数名称,可选项。blockHandler 函数访问范围需要是 public,返回类型需要与原方法相匹配,参数类型需要和原方法相匹配并且最后加一个额外的参数,类型为 BlockException。blockHandler 函数默认需要和原方法在同一个类中。若希望使用其他类的函数,则可以指定 blockHandlerClass 为对应的类的 Class 对象,注意对应的函数必需为 static 函数,否则无法解析。
-
fallback:fallback 函数名称,可选项,用于在抛出异常的时候提供 fallback 处理逻辑。fallback 函数可以针对所有类型的异常(除了 exceptionsToIgnore 里面排除掉的异常类型)进行处理。fallback 函数签名和位置要求:
1、返回值类型必须与原函数返回值类型一致;
2、方法参数列表需要和原函数一致,或者可以额外多一个 Throwable 类型的参数用于接收对应的异常。
3、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 逻辑中,而是会原样抛出。
注:1.6.0 之前的版本 fallback 函数只针对降级异常(DegradeException)进行处理,不能针对业务异常进行处理。
特别地,若 blockHandler 和 fallback 都进行了配置,则被限流降级而抛出 BlockException 时只会进入 blockHandler 处理逻辑。若未配置 blockHandler、fallback 和 defaultFallback,则被限流降级时会将 BlockException 直接抛出。
演示
增加资源:
@RequestMapping("/hello")
@SentinelResource(value = "HelloConsumer-hello", blockHandler = "helloHandle", blockHandlerClass = HelloHanldeErr.class)
public String hello(@RequestParam(value = "a") String a) {
return "hello,Consumer,port:" + port;
}
@Slf4j
public class HelloHanldeErr {
public static String helloHandle(String a, BlockException e) {
log.error("被限流",e);
return "系统正忙,请稍后重试";
}
}
helloHandle方法和hello参数相同,且返回值相同。除了helloHandle最后一个参数为BlockException类型。
在Sentinel dashboard中配置流控规则:
在浏览器中访问http://localhost:7001/consumer/hello?a=1,快速多点几次,看到系统正忙,请稍后重试
。限流规则已生效。上面的限流处理和controller在同一个类中, @SentinelResource可以不要blockHandlerClass属性。
修改:
@RequestMapping("/hello")
@SentinelResource(value = "HelloConsumer-hello", blockHandler = "helloHandle", blockHandlerClass = HelloHanldeErr.class)
public String hello(@RequestParam(value = "a") String a) {
int i = 10 / 0;
return "hello,Consumer,port:" + port;
}
重启后,在Sentinel dashboard中配置流控规则:
在浏览器中访问一次http://localhost:7001/consumer/hello?a=1,此时没有限流,看到:
在浏览器中快速访问http://localhost:7001/consumer/hello?a=1,发生限流后,看到系统正忙,请稍后重试
。可知blockHandler是处理限流,不处理出现异常
。
接下来看fallback属性:
@RequestMapping("/helloEx")
@SentinelResource(value = "HelloConsumer-helloEx", fallback = "helloBack", fallbackClass = HelloHanldeErr.class)
public String helloEx(@RequestParam(value = "a") String a) {
return "hello,Consumer,port:" + port;
}
@Slf4j
public class HelloHanldeErr {
public static String helloHandle(String a, BlockException e) {
log.error("被限流",e);
return "系统正忙,请稍后重试";
}
public static String helloBack(String a, Throwable e) {
log.error("出错", e);
return "系统出错";
}
}
在Sentinel dashboard配置流控规则:
在浏览器中快速访问http://localhost:7001/consumer/helloEx?a=1,发生限流时看到系统出错
。
修改:
@RequestMapping("/helloEx")
@SentinelResource(value = "HelloConsumer-helloEx", fallback = "helloBack", fallbackClass = HelloHanldeErr.class)
public String helloEx(@RequestParam(value = "a") String a) {
int i= 10 / 0;
return "hello,Consumer,port:" + port;
}
重启,不在Sentinel dashboard 中配置限流规则。访问http://localhost:7001/consumer/helloEx?a=1,看到系统出错
。可知fallback是处理出错或限流
。
修改:
@RequestMapping("/helloEx")
@SentinelResource(value = "HelloConsumer-helloEx", fallback = "helloBack", fallbackClass = HelloHanldeErr.class,blockHandler = "helloHandle", blockHandlerClass = HelloHanldeErr.class)
public String helloEx(@RequestParam(value = "a") String a) {
// int i= 10 / 0;
return "hello,Consumer,port:" + port;
}
重启后在sentinel dashboard中配置限流规则:
快速访问http://localhost:7001/consumer/helloEx?a=1,发生限流时,可看到系统正忙,请稍后重试
。
修改:
@RequestMapping("/helloEx")
@SentinelResource(value = "HelloConsumer-helloEx", fallback = "helloBack", fallbackClass = HelloHanldeErr.class,blockHandler = "helloHandle", blockHandlerClass = HelloHanldeErr.class)
public String helloEx(@RequestParam(value = "a") String a) {
int i= 10 / 0;
return "hello,Consumer,port:" + port;
}
重启后在Sentinel dashboard中配置流控规则:
访问一次http://localhost:7001/consumer/helloEx?a=1,此时没有限流,看到系统出错
。快速访问http://localhost:7001/consumer/helloEx?a=1,发生限流时,看到系统正忙,请稍后重试
。可知同时配置fallback和blockHandler时,fallback处理异常,blockHandler处理限流
。
最后看下defaultFallback:
@RequestMapping("/helloDefaultEx")
@SentinelResource(value = "HelloConsumer-helloDefaultEx", defaultFallback = "helloDefaultBack", fallbackClass = HelloHanldeErr.class)
public String helloDefaultEx(@RequestParam(value = "a") String a) {
// int i= 10 / 0;
return "hello,Consumer,port:" + port;
}
@Slf4j
public class HelloHanldeErr {
public static String helloHandle(String a, BlockException e) {
log.error("被限流",e);
return "系统正忙,请稍后重试";
}
public static String helloBack(String a, Throwable e) {
log.error("出错", e);
return "系统出错";
}
public static String helloDefaultBack(Throwable e) {
log.error("出错", e);
return "默认...系统出错";
}
}
在Sentinel dashboard中配置流控规则:
在浏览器中快速访问http://localhost:7001/consumer/helloDefaultEx?a=1,发生限流时,看到默认...系统出错
,可知defaultFallback可以处理限流
。
修改为:
@RequestMapping("/helloDefaultEx")
@SentinelResource(value = "HelloConsumer-helloDefaultEx", defaultFallback = "helloDefaultBack", fallbackClass = HelloHanldeErr.class)
public String helloDefaultEx(@RequestParam(value = "a") String a) {
int i= 10 / 0;
return "hello,Consumer,port:" + port;
}
重启后,不匹配流控规则,在浏览器中访问http://localhost:7001/consumer/helloDefaultEx?a=1,看到默认...系统出错
,可知defaultFallback可以处理异常
。
修改为:
@RequestMapping("/helloDefaultEx")
@SentinelResource(value = "HelloConsumer-helloDefaultEx", defaultFallback = "helloDefaultBack", fallbackClass = HelloHanldeErr.class, exceptionsToIgnore = ArithmeticException.class)
public String helloDefaultEx(@RequestParam(value = "a") String a) {
int i= 10 / 0;
return "hello,Consumer,port:" + port;
}
重启后,不匹配流控规则,在浏览器中访问http://localhost:7001/consumer/helloDefaultEx?a=1,看到:
当出现的异常出现在exceptionsToIgnore属性中,defaultFallback就不能处理异常。
修改为:
@RequestMapping("/helloDefaultEx")
@SentinelResource(value = "HelloConsumer-helloDefaultEx", defaultFallback = "helloDefaultBack", fallback = "helloBack", fallbackClass = HelloHanldeErr.class)
public String helloDefaultEx(@RequestParam(value = "a") String a) {
int i= 10 / 0;
return "hello,Consumer,port:" + port;
}
重启后,不匹配流控规则,在浏览器中访问http://localhost:7001/consumer/helloDefaultEx?a=1,看到系统出错
,可知fallback和defaultFallback同时出现优先使用fallback
。
修改为:
@RequestMapping("/helloDefaultEx")
@SentinelResource(value = "HelloConsumer-helloDefaultEx", defaultFallback = "helloDefaultBack", fallback = "helloBack", fallbackClass = HelloHanldeErr.class, exceptionsToIgnore = ArithmeticException.class)
public String helloDefaultEx(@RequestParam(value = "a") String a) {
int i= 10 / 0;
return "hello,Consumer,port:" + port;
}
重启后,不匹配流控规则,在浏览器中访问http://localhost:7001/consumer/helloDefaultEx?a=1,看到:
当出现的异常出现在exceptionsToIgnore属性中,fallback就不能处理异常。
修改为
@RequestMapping("/helloDefaultEx")
@SentinelResource(value = "HelloConsumer-helloDefaultEx", defaultFallback = "helloDefaultBack", fallbackClass = HelloHanldeErr.class, blockHandler = "helloHandle", blockHandlerClass = HelloHanldeErr.class)
public String helloDefaultEx(@RequestParam(value = "a") String a) {
// int i= 10 / 0;
return "hello,Consumer,port:" + port;
}
重启后在Sentinel dashboard中配置流控规则:
在浏览器中快速访问http://localhost:7001/consumer/helloDefaultEx?a=1,出现限流时,看到系统正忙,请稍后重试
。可知defaultFallback和blockHandler同时出现,出现限流时优先使用blockHandler
。
修改为
@RequestMapping("/helloDefaultEx")
@SentinelResource(value = "HelloConsumer-helloDefaultEx", defaultFallback = "helloDefaultBack", fallbackClass = HelloHanldeErr.class, blockHandler = "helloHandle", blockHandlerClass = HelloHanldeErr.class)
public String helloDefaultEx(@RequestParam(value = "a") String a) {
int i= 10 / 0;
return "hello,Consumer,port:" + port;
}
重启后在Sentinel dashboard中配置流控规则:
在浏览器中快速访问http://localhost:7001/consumer/helloDefaultEx?a=1,出现限流时,看到系统正忙,请稍后重试
。只访问一次,没有限流,出现异常,看到默认...系统出错
。可知defaultFallback和blockHandler同时出现,出现限流时优先使用blockHandler,defaultFallback处理异常
。