0

0

如何在 Spring Boot 中统一处理 404 异常并返回 JSON 响应

花韻仙語

花韻仙語

发布时间:2026-01-01 14:38:02

|

281人浏览过

|

来源于php中文网

原创

如何在 Spring Boot 中统一处理 404 异常并返回 JSON 响应

通过配置 `spring.mvc.throw-exception-if-no-handler-found=true` 并调整静态资源路径,可使未匹配的请求触发 `@exceptionhandler`,从而实现 404 异常的全局 json 格式化响应。

在 Spring Boot 中,@ControllerAdvice(或其 REST 专用变体 @RestControllerAdvice)配合 @ExceptionHandler 是处理控制器层异常的标准方式。但默认情况下,404(Not Found)错误并不会进入 @ExceptionHandler 流程——因为该异常发生在 DispatcherServlet 的请求分发阶段(即“找不到任何 HandlerMapping 匹配该 URL”),而非控制器执行过程中抛出的异常。此时 Spring Boot 会直接返回 Whitelabel 错误页(HTML),而非调用你的全局异常处理器

要让 404 也能被 @ExceptionHandler 捕获,关键在于 强制 Spring 在无处理器匹配时抛出 NoHandlerFoundException,而非静默返回 404 响应。这需要两个协同配置:

✅ 步骤一:启用异常抛出机制

在 application.yml(或 application.properties)中启用:

spring:
  mvc:
    throw-exception-if-no-handler-found: true

⚠️ 注意:仅设置此项不够!Spring Boot 默认将静态资源路径设为 /**,而 Whitelabel 错误页本质上是静态资源(由 BasicErrorController 提供)。若不调整静态路径,throw-exception-if-no-handler-found 将被忽略(因为 /error 路径仍能被静态资源处理器匹配)。

✅ 步骤二:隔离静态资源路径

方案 A(推荐):显式限定静态资源路径,避免覆盖 /error:

spring:
  mvc:
    throw-exception-if-no-handler-found: true
    static-path-pattern: /static/**

这样,所有非 /static/** 开头的请求(如 /api/v1/itemss)若无对应 Controller,则触发 NoHandlerFoundException。

Pi智能演示文档
Pi智能演示文档

领先的AI PPT生成工具

下载

方案 B:禁用自动配置,手动接管 Web MVC(适用于需深度定制场景):

@Configuration
@EnableWebMvc // ⚠️ 关闭 Spring Boot 的 WebMvcAutoConfiguration
public class WebConfig implements WebMvcConfigurer {
    // 可选:自定义资源处理器等
}

再配合 spring.mvc.throw-exception-if-no-handler-found=true 即可生效。

✅ 步骤三:添加 404 异常处理器

在你的 @RestControllerAdvice 类中添加:

@ExceptionHandler(NoHandlerFoundException::class)
fun handleNoHandlerFound(
    exception: NoHandlerFoundException,
    request: HttpServletRequest
): ResponseEntity {
    logger().warn("404 Not Found: {}", exception.requestURL)
    val notFound = HttpStatus.NOT_FOUND
    val apiError = ApiError(
        requestURI = exception.requestURL,
        status = notFound.value(),
        statusText = notFound.reasonPhrase,
        createdAt = OffsetDateTime.now(),
        errorMessage = "Requested resource does not exist"
    )
    return ResponseEntity(apiError, notFound)
}
? 提示:NoHandlerFoundException 的 requestURL 字段需通过 exception.requestURL 获取(Kotlin 中注意空安全),或从 request.requestURL.toString() 提取。

✅ 最终效果

访问 GET /api/v1/itemss 将返回标准 JSON:

{
  "requestUri": "/api/v1/itemss",
  "status": 404,
  "statusText": "Not Found",
  "createdAt": "2023-01-12T16:52:06.932108+02:00",
  "errorMessage": "Requested resource does not exist"
}

⚠️ 注意事项

  • 确保 NoHandlerFoundException 的包导入正确:org.springframework.web.servlet.NoHandlerFoundException;
  • 若使用 Spring Security,请确认 /error 路径未被拦截(通常需放行);
  • @EnableWebMvc 会完全关闭 Spring Boot 的 Web 自动配置,仅在必要时选用;
  • 生产环境建议结合 ErrorAttributes 或 ErrorController 做更健壮的错误溯源。

通过以上三步配置,即可将 404 纳入统一的 JSON 异常处理体系,保持 API 响应风格一致,提升客户端集成体验与服务可观测性。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

98

2025.08.06

spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

135

2023.09.05

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

384

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

64

2025.08.19

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

11

2025.12.22

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

101

2025.12.24

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

403

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

528

2023.08.23

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

7

2025.12.31

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.7万人学习

AngularJS教程
AngularJS教程

共24课时 | 2.2万人学习

CSS教程
CSS教程

共754课时 | 17.3万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号