sentinel-1.8版本找不到UrlBlockHandler接口，如何自定义错误页面？

最新推荐文章于 2023-09-14 09:05:01 发布

原创最新推荐文章于 2023-09-14 09:05:01 发布 · 930 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#微服务

微服务入门到入土专栏收录该内容

38 篇文章

订阅专栏

本文介绍了如何在 Sentinel 1.8 版本中实现自定义错误页面，由于官方已将 `UrlBlockHandler` 接口更改为 `BlockExceptionHandler`，因此需要继承新的接口来处理不同类型的流控、降级等异常。示例代码展示了如何创建一个 `BlockExceptionHandler` 实现类，根据不同的异常类型返回不同的错误信息，并利用 Jackson 进行 JSON 序列化响应。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、背景

最近在学习springcloud alibaba时候，模拟使用sentinel进行流量管理控制，在自定义错误页面时，网上很多使用老版本sentinel的教程，都是通过继承UrlBlockHandler这个方法来实现。然而我的sentinel版本是1.8，其中找到这个接口。最后发现官方将UrlBlockHandler接口改成了BlockExceptionHandler接口。

二、解决方案

实现BlockExceptionHandler接口

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.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * 自定义错误页面
 *
 * @author Saint
 */
 @Component
public class MyUrlBlockHandler implements BlockExceptionHandler {
    @Override
    public void handle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, BlockException e) throws Exception {
        ErrorMsg msg = null;
        if (e instanceof FlowException) {
            msg = ErrorMsg.builder()
                    .msg("呀，我被限流了！")
                    .status(101).build();
        } else if (e instanceof DegradeException) {
            msg = ErrorMsg.builder()
                    .msg("呀，我被降级了！")
                    .status(102).build();
        } else if (e instanceof ParamFlowException) {
            msg = ErrorMsg.builder()
                    .msg("呀，我被热点参数限流了！")
                    .status(103).build();
        } else if (e instanceof SystemBlockException) {
            msg = ErrorMsg.builder()
                    .msg("呀，系统规则（负载/...不满足要求）！")
                    .status(104).build();
        } else if (e instanceof AuthorityException) {
            msg = ErrorMsg.builder()
                    .msg("呀，授权规则不通过！")
                    .status(105).build();
        }

        // http状态码
        httpServletResponse.setStatus(500);
        httpServletResponse.setCharacterEncoding("utf-8");
        httpServletResponse.setHeader("Content-Type", "application/json;charset=utf-8");
        httpServletResponse.setContentType("application/json;charset=utf-8");
        // spring mvc自带的json操作工具jackson
        new ObjectMapper()
                .writeValue(
                        httpServletResponse.getWriter(),
                        msg
                );
    }
}

@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
class ErrorMsg {
    private Integer status;

    private String msg;
}