Sentinel自定义阻断异常处理类

目录

BlockException 异常类及其子类

BlockException异常默认处理类

自定义BlockException异常处理

---

参考：

Spring Cloud Alibaba Sentinel（二）自定义熔断异常类_CodingAnHour-CSDN博客

Spring Cloud Alibaba 服务容错 Sentinel 入门 | 码农家园 (codenong.com)

在使用sentinel进行限流降级处理时，sentinel在发生blockException时默认返回仅仅是一句Blocked by Sentinel (flow limiting)，而我们大部分的应用一般都会统一返回一个固定json格式的数据，因此需要对spring-cloud-starter-alibaba-sentinel中的部分源码进行一些扩展来满足需求。

BlockException 异常类及其子类

先来对 BlockException 异常做个简单的了解，在被 Sentinel block 的时候，就会抛出它。BlockException 是一个异常抽象基类，其有 5 个实现类，刚好对应 Sentinel 的 5 种流量控制手段，如下图所示：

旁白君：暂时找不到 block 适合翻译成什么单词，相对最贴切的可能是阻塞...

BlockException异常默认处理类

在 SentinelWebInterceptor 拦截器中，当请求满足配置的 Sentinel block 的条件时，Sentinel 会抛出 BlockException 异常。通过定义 BlockExceptionHandler 接口的实现类，可以实现对 BlockException 的异常处理。

默认情况下，BlockExceptionHandler 有一个默认的 DefaultBlockExceptionHandler 实现类，返回 Block 字符串提示。这个类是默认处理异常阻塞的，代码如下：

//Default handler for the blocked request
​
public class DefaultBlockExceptionHandler implements BlockExceptionHandler {
​
  @Override
  public void handle(HttpServletRequest request, HttpServletResponse response, BlockException e) throws Exception {
    // ... 省略其它代码
​
    PrintWriter out = response.getWriter();
    out.print("Blocked by Sentinel (flow limiting)");
  }
​
}

显然，在我们使用 SpringMVC 提供 Restful API 时，直接返回字符串提示是不合适的，因为一般是返回 JSON 字符串，例如说：

{
    "code": 1024,
    "msg": "Blocked by Sentinel (flow limiting)"
}

自定义BlockException异常处理

通过实现BlockExceptionHandler接口来自定义BlockException异常处理

因此，从源码中查看只要实现BlockExceptionHandler类可以自定义异常处理，只需要判断handle方法中BlockException 参数是否分别是FlowException、DegradeException、SystemBlockException等

等的示例即可，代码如下仅供参考:

import com.alibaba.csp.sentinel.adapter.spring.webmvc.callback.BlockExceptionHandler;
import com.alibaba.csp.sentinel.slots.block.BlockException;
import com.alibaba.csp.sentinel.slots.block.authority.AuthorityException;
import com.alibaba.csp.sentinel.slots.block.degrade.DegradeException;
import com.alibaba.csp.sentinel.slots.block.flow.FlowException;
import com.alibaba.csp.sentinel.slots.block.flow.param.ParamFlowException;
import com.alibaba.csp.sentinel.slots.system.SystemBlockException;
import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.MediaType;
import org.springframework.stereotype.Component;
​
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
​
/**
 * 自定义熔断异常类
 */
@Slf4j  // log日志
@Component // 注入到spring容器中
public class MyBlockExceptionHandler implements BlockExceptionHandler {
​
    @Override
    public void handle(HttpServletRequest request, HttpServletResponse response, BlockException e) throws Exception {
        log.info("UrlBlockHandler.....................................");
        // 自定义封装的类，可以定义
        Result restObject = null;
​
        if (e instanceof FlowException) {
            // 限流
            restObject = ResultUtils.wrapFail(5001,"接口限流");
        } else if (e instanceof DegradeException) {
            // 降级
            restObject = ResultUtils.wrapFail(5002,"服务降级");
        } else if (e instanceof ParamFlowException) {
            // 热点参数
            restObject = ResultUtils.wrapFail(5003,"热点参数限流");
        } else if (e instanceof SystemBlockException) {
            // 系统保护
            restObject = ResultUtils.wrapFail(5004,"触发系统保护规则");
        } else if (e instanceof AuthorityException) {
            // 授权规则
            restObject = ResultUtils.wrapFail(5005,"授权规则不通过");
        }
​
        //返回json数据
        response.setStatus(200);
        response.setCharacterEncoding("utf-8");
        response.setContentType(MediaType.APPLICATION_JSON_VALUE);
        //springmvc 的一个json转换类 （jackson）
        new ObjectMapper().writeValue(response.getWriter(), restObject);
        //重定向
        //response.sendRedirect("http://www.baidu.com");
    }
}