Java中 Spring Gateway 网关怎么拦截全局异常并转换为 JSON 自定义异常响应

云静同学_4475

云静同学_4475

2026-07-26

182人浏览

原创

spring cloud gateway因基于webflux而不支持@controlleradvice和@exceptionhandler,需自定义继承defaulterrorwebexceptionhandler的jsonexceptionhandler并以@bean+@order(-1)注册,重写geterrorattributes()和getroutingfunction()方法,配合acceptheaderviewresolver确保返回json格式统一异常响应。

java中 spring gateway 网关怎么拦截全局异常并转换为 json 自定义异常响应

Spring Cloud Gateway 基于 WebFlux(响应式编程),不走 Spring MVC 的拦截链路,所以 @ControllerAdvice 和 @ExceptionHandler 在网关层默认无效。要实现全局异常拦截并返回统一 JSON 格式响应,必须替换默认的 ErrorWebExceptionHandler,自定义一个继承 DefaultErrorWebExceptionHandler 的处理器。

核心思路:替换 WebFlux 默认异常处理器

Gateway 启动时会自动装配 ErrorWebFluxAutoConfiguration,其中注册了 DefaultErrorWebExceptionHandler Bean。我们通过 @Bean + @Order(-1) 提前注入自定义实现,覆盖默认行为。

  • 自定义类需继承 DefaultErrorWebExceptionHandler
  • 重写 getErrorAttributes() 方法,提取异常类型、状态码、业务消息
  • 重写 renderErrorResponse() 或依赖父类逻辑,确保返回体为 JSON(而非 HTML 或默认 error 页面)
  • 在构造器中注入 ErrorAttributes、ResourceProperties 等必要组件

关键代码:自定义 JsonExceptionHandler

以下是一个轻量但完整的实现示例:

public class JsonExceptionHandler extends DefaultErrorWebExceptionHandler {

    public JsonExceptionHandler(ErrorAttributes errorAttributes,
                               ResourceProperties resourceProperties,
                               ErrorProperties errorProperties,
                               ApplicationContext applicationContext) {
        super(errorAttributes, resourceProperties, errorProperties, applicationContext);
    }

    @Override
    protected Map<string object> getErrorAttributes(ServerRequest request, boolean includeStackTrace) {
        Throwable error = super.getError(request);
        int status = HttpStatus.INTERNAL_SERVER_ERROR.value();
        String message = "系统异常";

        if (error instanceof NotFoundException) {
            status = HttpStatus.NOT_FOUND.value();
            message = "请求路径不存在";
        } else if (error instanceof CustomException) {
            CustomException ce = (CustomException) error;
            status = ce.getStatus();
            message = ce.getMessage();
        } else if (error instanceof ResponseStatusException) {
            status = ((ResponseStatusException) error).getStatus().value();
            message = error.getLocalizedMessage();
        }

        Map<string object> result = new HashMap();
        result.put("code", status);
        result.put("message", message);
        result.put("timestamp", Instant.now().toString());
        return result;
    }

    @Override
    protected RouterFunction<serverresponse> getRoutingFunction(ErrorAttributes errorAttributes) {
        return RouterFunctions.route(RequestPredicates.all(), this::renderErrorResponse);
    }
}</serverresponse></string></string>

注意:getRoutingFunction 必须重写,否则可能 fallback 到默认 HTML 渲染逻辑。

配置生效:注册为 Bean

在配置类中声明该处理器,并确保优先级最高:

java-enterprise
java-enterprise

Java企业开发专家,专注于Spring Boot、微服务架构和JVM优化。适用于:Java语言掌握、

下载
@Configuration
public class ExceptionConfig {

    @Bean
    @Order(-1)
    public ErrorWebExceptionHandler errorWebExceptionHandler(
            ErrorAttributes errorAttributes,
            ResourceProperties resourceProperties,
            ErrorProperties errorProperties,
            ApplicationContext applicationContext,
            ServerCodecConfigurer serverCodecConfigurer) {

        JsonExceptionHandler exceptionHandler = new JsonExceptionHandler(
                errorAttributes, resourceProperties, errorProperties, applicationContext);

        exceptionHandler.setViewResolvers(getViewResolvers(applicationContext));
        exceptionHandler.setMessageWriters(serverCodecConfigurer.getWriters());
        exceptionHandler.setMessageReaders(serverCodecConfigurer.getReaders());

        return exceptionHandler;
    }

    private List<viewresolver> getViewResolvers(ApplicationContext context) {
        ViewResolver viewResolver = new AcceptHeaderViewResolver(MediaType.APPLICATION_JSON);
        return Collections.singletonList(viewResolver);
    }
}</viewresolver>

其中 AcceptHeaderViewResolver 保证响应 Content-Type 为 application/json。

配合业务异常统一抛出

网关内或下游转发失败时,建议主动抛出自定义异常(如 CustomException),便于在 getErrorAttributes 中精准识别和映射:

  • 继承 RuntimeException,避免强制 try-catch
  • 携带 code(业务码)和 status(HTTP 状态码)两个字段
  • 在 Filter 或 GlobalFilter 中捕获转发异常(如 ConnectException、TimeoutException)后包装成 CustomException 再抛出

例如在自定义 GlobalFilter 中:

if (exchange.getResponse().getStatusCode() == null) {
    throw new CustomException(503, "服务不可用,请稍后再试");
}

不复杂但容易忽略:WebFlux 的异常处理是响应式链路,必须从 ErrorWebExceptionHandler 入口切入,绕过 MVC 体系才能真正统一管控所有网关层异常。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java json js gate

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

10237

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

7362

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

6472

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1124

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

928

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1356

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2689

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20011

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1195

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习