Spring Cloud Alibaba Sentinel 是目前主流并開源的流量控制和系統保護組件，它提供了強大的限流、熔斷、熱點限流、授權限流和系統保護及監控等功能。使用它可以輕松的保護我們微服務，在高并發環境下的正常運行。

那么，當程序觸發了限流和熔斷規則時，如何自定義返回的異常信息呢？這是我們接下來要解決的問題。

0.概述

Spring Cloud Alibaba Sentinel 有以下 3 種自定義異常的實現方式：

1. 自定義局部異常
2. 自定義（Sentinel）全局異常
3. 自定義系統異常

以上這 3 種實現方式，都可以重新定義 Sentinel 的異常返回信息，它們的具體實現如下。

1.自定義局部異常

自定義局部異常是在使用 @SentinelResource 注解時，直接定義的 blockHandler 異常方法，如下代碼所示：

@SentinelResource(value = "/user/getuser",
            blockHandler = "myBlockHandler")
@RequestMapping("getuser")
public String getUser(Integer uid) {
    return "User:" + uid;
}

/**
 * 定義限流/熔斷等異常
 */
public String myBlockHandler(Integer uid, BlockException e) {
    String msg = "未知異常";
    if (e instanceof FlowException) {
        msg = "請求被限流了";
    } else if (e instanceof ParamFlowException) {
        msg = "請求被熱點參數限流";
    } else if (e instanceof DegradeException) {
        msg = "請求被降級了";
    } else if (e instanceof AuthorityException) {
        msg = "沒有權限訪問";
    }
    return msg;
}

注意事項

在定義 blockHandler 方法時，需要注意以下 3 個問題：

1. 自定義的 blockHandler 方法的返回值，必須要和原方法（使用 @SentinelResource 注解修飾的方法）的返回值保持一致。
2. 自定義的 blockHandler 方法的參數必須和原方法參數保持一致。
3. 自定義的 blockHandler 方法的方法參數中必須包含 BlockException 參數。

如果不滿足以上事項中的任何一項，那么就不能正常匹配到自定義的 blockHandler 方法，并且程序也會報錯。

2.自定義全局異常

自定義 Sentinel 全局異常需要實現 BlockExceptionHandler 類，并重寫 handle 方法，如下代碼所示：

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 jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;

@Component
public class SentinelExceptionHandler implements BlockExceptionHandler {
    @Override
    public void handle(HttpServletRequest request, HttpServletResponse response, BlockException e) throws Exception {
        String msg = "未知異常";
        int status = HttpStatus.TOO_MANY_REQUESTS.value();
        if (e instanceof FlowException) {
            msg = "請求被限流了";
        } else if (e instanceof ParamFlowException) {
            msg = "請求被熱點參數限流";
        } else if (e instanceof DegradeException) {
            msg = "請求被降級了";
        } else if (e instanceof AuthorityException) {
            msg = "沒有權限訪問";
            status = HttpStatus.UNAUTHORIZED.value();
        }
        response.setContentType("application/json;charset=utf-8");
        response.setStatus(status);
        response.getWriter().println("{\"msg\": " + msg + ", \"code\": " + status + "}");
    }
}

自定義 Sentinel 全局異常是在執行 Sentinel 控制臺設置的限流和熔斷異常時，執行的全局自定義異常方法。

但是，如果是程序中出現的 Sentinel 報錯信息，例如使用熱點限流時，因為要配合使用 @SentinelResource 注解時，此時只自定義了 value 屬性，未定義局部 blockHandler 方法，此時系統就會報錯，但這個時候并不會執行 Sentinel 全局自定義異常，而是程序報錯，此時就需要使用系統自定義異常來重新定義異常信息了。

3.自定義系統異常

自定義系統異常需要新建一個異常類，并且使用 @RestControllerAdvice 注解修飾此類，并配合 @ExceptionHandler 注解來完成全局系統異常的獲取和定義，具體實現代碼如下：

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 org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import java.util.HashMap;
import java.util.Map;


@RestControllerAdvice
public class CustomExceptionHandler {

    /**
     * 限流全局異常
     */
    @ExceptionHandler(FlowException.class)
    public Map handlerFlowException(){
        return new HashMap(){{
            put("code", HttpStatus.TOO_MANY_REQUESTS.value());
            put("msg", "被限流");
        }};
    }

    /**
     * 熔斷全局異常
     */
    @ExceptionHandler(DegradeException.class)
    public Map handlerDegradeException(){
        return new HashMap(){{
            put("code", HttpStatus.TOO_MANY_REQUESTS.value());
            put("msg", "被熔斷");
        }};
    }

    /**
     * 熱點限流異常
     */
    @ExceptionHandler(ParamFlowException.class)
    public Map handlerparamFlowException(){
        return new HashMap(){{
            put("code", HttpStatus.TOO_MANY_REQUESTS.value());
            put("msg", "熱點限流");
        }};
    }

    /**
     *  Sentinel 權限攔截全局異常
     */
    @ExceptionHandler(AuthorityException.class)
    @ResponseBody
    public Map handlerAuthorityException(){
        return new HashMap(){{
            put("code", HttpStatus.UNAUTHORIZED.value());
            put("msg", "暫無權限");
        }};
    }
}

此時，只要是系統中出現的 Sentinel 報錯信息，都會被此方法所捕獲，并通過自定義的代碼完成自定義異常信息的返回。

小結

Sentinel 有 3 種自定義異常的實現：自定義局部異常、自定義（Sentinel）全局異常、自定義系統異常。自定義局部異常作用范圍比較小，需要給每個資源單獨設置才行；而自定義全局異常作用范圍比較大，但如果是程序報錯，也不會執行其方法，所以需要配合系統異常同時來完成自定義異常的返回。

PS：如果這 3 種自定義異常同時存在，那么它的執行優先級是：自定義局部異常 > 自定義全局異常 > 自定義系統異常。

本文已收錄到我的面試小站 www.javacn.site，其中包含的內容有：Redis、JVM、并發、并發、MySQL、Spring、Spring MVC、Spring Boot、Spring Cloud、MyBatis、設計模式、消息隊列等模塊。

總結

以上是生活随笔為你收集整理的3种Sentinel自定义异常，你用过几种？的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。