Sentinel 提供了@SentinelResource注解用于定义资源,并提供了AspectJ的扩展用于自定义资源,处理BlockException等.
如果使用AspectJ需要引入
com.alibaba.csp
sentinel-annotation-aspectj
1.6.2
@SentinelResource注解
用于定义资源,并提供可选的异常处理和fallback配置项.
@SentinelResource注解包含以下属性:
value:
资源名称,必须项(唯一,不能为空)
entryType:
entry类型,可选项(默认为EntryType.OUT)
EntryType.IN 入口流量
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直接抛出
public class TestService {
// 对应的 `handleException` 函数需要位于 `ExceptionUtil` 类中，并且必须为 static 函数.
@SentinelResource(value = "test", blockHandler = "handleException", blockHandlerClass = {ExceptionUtil.class})
public void test() {
System.out.println("Test");
}
// 原函数
@SentinelResource(value = "hello", blockHandler = "exceptionHandler", fallback = "helloFallback")
public String hello(long s) {
return String.format("Hello at %d", s);
}
// Fallback 函数，函数签名与原函数一致或加一个 Throwable 类型的参数.
public String helloFallback(long s) {
return String.format("Halooooo %d", s);
}
// Block 异常处理函数，参数最后多一个 BlockException，其余与原函数一致.
public String exceptionHandler(long s, BlockException ex) {
// Do some log here.
ex.printStackTrace();
return "Oops, error occurred at " + s;
}
}
从1.4.0版本开始,注解方式定义资源支持自动统计业务异常,无须手动调用Tracer.trace(ex)来记录业务异常.
配置
AspectJ
若使用了AspectJ,那么需要在aop.xml文件中引入对应的AspectJ:
Spring AOP
需要通过配置的方式将SentinelResourceAspect注册为一个Spring Bean
@Configuration
public class SentinelAspectConfiguration {
@Bean
public SentinelResourceAspect sentinelResourceAspect() {
return new SentinelResourceAspect();
}
}