讲师中心 微信公众号
AI工具推荐 视频效率加速

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

云静同学_4475

云静同学_4475

发布时间:2026-07-26 09:43:47

|

182人浏览过

|

来源于php中文网

原创

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);
    }
}

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

立即学习“Java免费学习笔记(深入)”;

Feishu calendar sync, local ics to json data for AI agent
Feishu calendar sync, local ics to json data for AI agent

将ICS日历文件转为JSON格式,用于飞书日历导入导出及数据集成。

下载

配置生效:注册为 Bean

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

@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);
    }
}

其中 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 体系才能真正统一管控所有网关层异常。

热门AI工具

更多
UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
java
java

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

10197

2023.06.15

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

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

7322

2023.07.05

java自学难吗
java自学难吗

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

6432

2023.07.31

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

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

1104

2023.08.01

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

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

908

2023.08.02

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

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

1336

2023.08.02

java有什么用
java有什么用

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

2689

2023.08.02

java在线网站
java在线网站

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

20011

2023.08.03

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

20

2026.10.10

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn