配置触发规则后的逻辑

背景信息

当应用触发流控、降级或系统规则时，默认抛出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函数，否则无法解析。

Web Servlet Filter

默认情况下，当请求被限流时会返回默认的提示页面，提示信息为：Blocked by Sentinel （flow limiting）。

您可以通过以下两种方式来设定自定义的跳转URL，当请求触发限流、降级或系统规则时会自动跳转至设定好的URL。

• 通过WebServletConfig.setBlockPage(blockPage)方法设定自定义的跳转URL。
• 通过UrlBlockHandler接口编写定制化的限流处理逻辑，然后将其注册至WebCallbackManager中来实现，详情可参见Web Servlet Filter扩展接口。

Dubbo Adapter