Spring Cloud Alibaba入门实践(十七)-Sentinel之自定义异常返回

通过以上几篇博客，对Sentinel提供的各种规则也有了初步的了解，但是可以发现，如果只是依靠页面的返回结果，我们根本就不知道到底触发了哪种容错规则。

所以接下来需要自定义异常返回，让开发者可以知道触发的到底是哪种规则

先新建一个SentinelExceptionHandler类，内容如下：

package com.example.mallorder.exception;

import com.alibaba.csp.sentinel.adapter.servlet.callback.UrlBlockHandler;
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.alibaba.fastjson.JSON;
import org.springframework.stereotype.Component;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@Component
public class SentinelExceptionHandler implements UrlBlockHandler {

    @Override
    public void blocked(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, BlockException e) throws IOException {
        //BlockException 异常接口,包含Sentinel的五个异常
        // FlowException 限流异常
        // DegradeException 降级异常
        // ParamFlowException 参数限流异常
        // AuthorityException 授权异常
        // SystemBlockException 系统负载异常
        httpServletResponse.setContentType("application/json;charset=utf-8");
        ResponseData data = null;
        if (e instanceof FlowException) {
            data = new ResponseData(-1, "流控规则被触发......");
        } else if (e instanceof DegradeException) {
            data = new ResponseData(-2, "降级规则被触发...");
        } else if (e instanceof AuthorityException) {
            data = new ResponseData(-3, "授权规则被触发...");
        } else if (e instanceof ParamFlowException) {
            data = new ResponseData(-4, "热点规则被触发...");
        } else if (e instanceof SystemBlockException) {
            data = new ResponseData(-5, "系统规则被触发...");
        }
        httpServletResponse.getWriter().write(JSON.toJSONString(data));
    }
}
/**
 * 定义下返回类，如果项目有自己的返回类，那么就用自己项目定义的返回类统一处理，这里是为了方便测试
 */
class ResponseData {
    private int code;
    private String message;

    public ResponseData(int code, String message) {
        this.code = code;
        this.message = message;
    }

    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

然后使用各种规则限制资源，测试下，可以发现抛出来的异常已经比较清晰了，如下：



不过发现热点规则没法给出具体异常提示，甚至都没走到这个异常类的逻辑中，个人建议，直接使用全局异常处理即可，简单示例如下：

import com.alibaba.csp.sentinel.slots.block.flow.param.ParamFlowException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice
public class ExcpetionHandler {

    @ExceptionHandler(ParamFlowException.class)
    public ResponseData test() {
        return new ResponseData(-4, "热点规则被触发...");
    }
}

然后测试热点规则，可以发现热点规则被触发时，给出的提示也能够展示出来了：

所以综合使用体验下来，个人建议直接使用全局异常处理来定义Sentinel中各个异常的具体返回结果，反正知道了Sentinel大概会抛出哪几种规则异常，那针对这些异常进行捕获，处理起来也是很方便的。