若默认配置不能满足您的需求时,您可以自定义应用触发流控、降级或系统规则后的逻辑。本文将介绍适用于 SDK 应用的逻辑配置方法。
背景信息
当应用触发流控、降级或系统规则时,默认抛出 BlockException
异常类的子类(触发流控规则,则抛出流控异常 FlowException
;触发降级规则,则抛出降级异常 DegradeException
)。
默认配置中,可以通过 BlockException.isBlockException(Throwable t);
方法判断是否为流控降级异常。
若默认配置不能满足您的需求,可通过以下几种方式配置应用触发触发流控、降级或系统规则后的逻辑:
- 注解方式:适用于使用自定义埋点的 Spring Boot 应用接入、自定义埋点接入和注解接入等方式。
- Web Servlet Filter:适用于使用 HTTP 埋点的 Spring Boot 应用接入和 Web 应用接入等方式。
- Dubbo Adapter:适用于 Dubbo 应用接入方式。
注解方式
若通过注解方式定义的资源,需要在 @SentinelResource
注解上给方法配置 fallback
函数以及 blockHandler
函数,来进行逻辑处理。
示例:
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;
}
}
相关配置:
value
:资源名称(必需项)。entryType
:entry 类型(可选项),默认为EntryType.OUT
。blockHandler
/blockHandlerClass
:blockHandler
对应处理BlockException
的函数名称,为可选项。blockHandler 函数访问范围需要是public
,返回类型需要与原方法相匹配,参数类型需要和原方法相匹配并且最后加一个额外的类型为BlockException
的参数。blockHandler 函数默认需要和原方法在同一个类中。若希望使用其它类的函数,则可以指定blockHandlerClass
为对应的类的Class
对象,对应的函数必需为 static 函数,否则无法解析。fallback
: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 函数,否则无法解析。
说明 若 blockHandler 和 fallback 都进行了配置,则被限流降级而抛出
BlockException
时只会进入 blockHandler
处理逻辑。若未配置 blockHandler
、fallback
和 defaultFallback
,则被限流降级时会将 BlockException
直接抛出。
Web Servlet Filter
默认情况下,当请求被限流时会返回默认的提示页面,提示信息为:Blocked by Sentinel (flow limiting)
。
您可以通过以下两种方式来设定自定义的跳转 URL,当请求触发限流、降级或系统规则时会自动跳转至设定好的 URL。
- 通过
WebServletConfig.setBlockPage(blockPage)
方法设定自定义的跳转 URL。 - 通过 UrlBlockHandler 接口编写定制化的限流处理逻辑,然后将其注册至 WebCallbackManager 中来实现,详情可参见Web Servlet Filter 扩展接口。
Dubbo Adapter
Sentinel Dubbo Adapter 支持配置全局的 fallback 函数,可以在 Dubbo 服务触发限流、降级或系统规则时进行相应的 fallback
处理。可通过以下两种方式来实现:
- 自定义 DubboFallback 接口,然后通过
DubboFallbackRegistry
注册。默认情况会直接将BlockException
包装后抛出。 - 配合Dubbo 的 fallback 机制来实现,详情请参见 Dubbo 的 fallback 机制 。
在文档使用中是否遇到以下问题
更多建议
匿名提交