网关 Spring Cloud Gateway 统一全局异常处理

---

💨 作者:laker，因为喜欢LOL滴神faker，又是NBA湖人队🏀（laker）粉丝儿（主要是老詹的粉丝儿），本人又姓李，故取笔名：laker
❤️喜欢分享自己工作中遇到的问题和解决方案，以及一些读书笔记和心得分享。
🌰本人创建了微信公众号【Java大厂面试官】，用于和大家交流分享
🏰 个人微信【lakernote】，加作者备注下暗号：cv之道。

---

本文Spring Cloud Gateway 版本：2020.0.0

前言

Spring Cloud Gateway异常默认返回如下：

浏览器访问：

PostMan访问：

{
  "timestamp": "2021-01-06T04:56:53.092+00:00",
  "path": "/get2",
  "status": 404,
  "error": "Not Found",
  "message": null,
  "requestId": "b3e60f38-4"
}

看看如何实现统一异常处理。

Spring Cloud Gateway 中的全局异常处理不能直接使用 @ControllerAdvice，可以通过跟踪异常信息的抛出，找到对应的源码，自定义一些处理逻辑来匹配业务的需求。

网关是给接口做代理转发的，后端对应的是 REST API，返回数据格式是 JSON。如果不做处理，当发生异常时，Gateway 默认给出的错误信息是页面，不方便前端进行异常处理。

所以我们需要对异常信息进行处理，并返回 JSON 格式的数据给客户端。下面先看实现的代码，后面再跟大家讲一下需要注意的地方。

自定义异常处理逻辑

参考：DefaultErrorWebExceptionHandler默认异常处理类

自定义异常处理逻辑，代码如下所示。

public class JsonExceptionHandler extends DefaultErrorWebExceptionHandler {

    public JsonExceptionHandler(ErrorAttributes errorAttributes, WebProperties.Resources resources,
                                ErrorProperties errorProperties, ApplicationContext applicationContext) {
        super(errorAttributes, resources, errorProperties, applicationContext);
    }
    /**
     * 获取异常属性
     */
    @Override
    protected Map<String, Object> getErrorAttributes(ServerRequest request, boolean includeStackTrace) {
        int code = 500;
        Throwable error = super.getError(request);
        if (error instanceof org.springframework.cloud.gateway.support.NotFoundException) {
            code = 404;
        }
        return response(code, this.buildMessage(request, error));
    }

    /**
     * 指定响应处理方法为JSON处理的方法
     *
     * @param errorAttributes
     */
    @Override
    protected RouterFunction<ServerResponse> getRoutingFunction(ErrorAttributes errorAttributes) {
        return RouterFunctions.route(RequestPredicates.all(), this::renderErrorResponse);
    }

    /**
     * 根据code获取对应的HttpStatus
     *
     * @param errorAttributes
     */
    @Override
    protected HttpStatus getHttpStatus(Map<String, Object> errorAttributes) {
        int statusCode = (int) errorAttributes.get("code");
        return HttpStatus.valueOf(statusCode);
    }

    /**
     * 构建异常信息
     *
     * @param request
     * @param ex
     * @return
     */
    private String buildMessage(ServerRequest request, Throwable ex) {
        StringBuilder message = new StringBuilder("Failed to handle request [");
        message.append(request.methodName());
        message.append(" ");
        message.append(request.uri());
        message.append("]");
        if (ex != null) {
            message.append(": ");
            message.append(ex.getMessage());
        }
        return message.toString();
    }

    /**
     * 构建返回的JSON数据格式
     *
     * @param status       状态码
     * @param errorMessage 异常信息
     * @return
     */
    public static Map<String, Object> response(int status, String errorMessage) {
        Map<String, Object> map = new HashMap<>();
        map.put("code", status);
        map.put("message", errorMessage);
        map.put("data", null);
        return map;
    }
}

覆盖默认的配置

参考：ErrorWebFluxAutoConfiguration

覆盖默认的配置，代码如下所示。

@Configuration
@EnableConfigurationProperties({ServerProperties.class,
        WebProperties.class})
public class ErrorHandlerConfiguration {


    private final ServerProperties serverProperties;

    public ErrorHandlerConfiguration(ServerProperties serverProperties) {
        this.serverProperties = serverProperties;
    }

    @Bean
    @Order(-1)
    public ErrorWebExceptionHandler errorWebExceptionHandler(ErrorAttributes errorAttributes,
                                                             org.springframework.boot.autoconfigure.web.ResourceProperties resourceProperties,
                                                             WebProperties webProperties, ObjectProvider<ViewResolver> viewResolvers,
                                                             ServerCodecConfigurer serverCodecConfigurer, ApplicationContext applicationContext) {
        DefaultErrorWebExceptionHandler exceptionHandler = new JsonExceptionHandler(errorAttributes,
                resourceProperties.hasBeenCustomized() ? resourceProperties : webProperties.getResources(),
                this.serverProperties.getError(), applicationContext);
        exceptionHandler.setViewResolvers(viewResolvers.orderedStream().collect(Collectors.toList()));
        exceptionHandler.setMessageWriters(serverCodecConfigurer.getWriters());
        exceptionHandler.setMessageReaders(serverCodecConfigurer.getReaders());
        return exceptionHandler;
    }
}

1. 异常时如何返回 JSON 而不是 HTML？

在 org.springframework.boot.autoconfigure.web.reactive.error.DefaultErrorWeb-Exception-Handler 中的 getRoutingFunction() 方法就是控制返回格式的，源代码如下所示。

@Override
protected RouterFunction getRoutingFunction(ErrorAttributes errorAttributes) {
return RouterFunctions.route(acceptsTextHtml(), this::renderErrorView).andRoute(RequestPredicates.all(), this::renderErrorResponse);
}

这里优先是用 HTML 来显示的，如果想用 JSON 显示改动就可以了，具体代码如下所示。

protected RouterFunction getRoutingFunction(ErrorAttributes errorAttributes) {
return RouterFunctions.route(RequestPredicates.all(),this::renderErrorResponse);
}

2. getHttpStatus 需要重写

原始的方法是通过 status 来获取对应的 HttpStatus 的，具体代码如下所示。

protected HttpStatus getHttpStatus(Map<String, Object> errorAttributes) {
int statusCode = (int) errorAttributes.get(“status”);
return HttpStatus.valueOf(statusCode);
}

如果我们定义的格式中没有 status 字段的话，就会报错，因为找不到对应的响应码。要么返回数据格式中增加 status 子段，要么重写，在笔者的操作中返回的是 code，所以要重写，代码如下所示。

@Override
protected HttpStatus getHttpStatus(Map<String, Object> errorAttributes) {
int statusCode = (int) errorAttributes.get(“code”);
return HttpStatus.valueOf(statusCode);
}

验证

无论是网页还是PostMan

{
	"code": 404,
	"message": "Failed to handle request [GET http://localhost:8080/get]: 404 NOT_FOUND"
}

有些小伙伴回复说没起作用，可以参考下源码获取

• 关注公众号【Java大厂面试官】，回复【gateway】

参考：

http://c.biancheng.net/view/5447.html

Spring Cloud 相关系列文章目录

网关服务

Spring Cloud Gateway

• 网关 Spring Cloud Gateway 简介 入门

• 网关 Spring Cloud Gateway 内置的路由谓词工厂详解（最全的路由策略11种）

• 网关 Spring Cloud Gateway 内置过滤器工厂(超级全30种)

• 网关 Spring Cloud Gateway 内置全局过滤器

• 网关 Spring Cloud Gateway 内置网关过滤器工厂总结

• 网关 Spring Cloud Gateway 两种配置谓词和过滤器的方法

• 网关 Spring Cloud Gateway 监控 actuator

• 网关 Spring Cloud Gateway 自定义路由谓词工厂

• 网关 Spring Cloud Gateway 自定义过滤器（全局过滤器以及网关过滤器）

• 网关 Spring Cloud Gateway 跨域配置

• 网关 Spring Cloud Gateway HTTP超时配置

• 网关 Spring Cloud Gateway 统一全局异常处理

---

QQ群【837324215】
关注我的公众号【Java大厂面试官】，回复：常用工具、资源等关键词（更多关键词，关注后注意提示信息）获取更多免费资料。

公众号也会持续输出高质量文章，和大家共同进步。