Spring Boot 中的默认异常处理机制解析(如 /error 接口)

 更新时间:2025年07月17日 10:23:42   作者:南姜先生  
SpringBoot通过/error接口默认处理异常,使用BasicErrorController返回结构化JSON或HTML错误页面,支持自定义ErrorAttributes、ControllerAdvice及错误模板,配置项可调整错误路径和格式,本文给大家介绍Spring Boot 中的默认异常处理机制解析,感兴趣的朋友一起看看吧

Spring Boot 中,为了简化 Web 应用的异常处理流程,它提供了一套默认的全局异常处理机制,其中最核心的就是 /error 接口。这个接口是 Spring Boot 提供的一个内置错误页面控制器(BasicErrorController),用于统一返回错误信息。

🧠 一句话总结:

✅ Spring Boot 默认使用 BasicErrorController 来处理所有未被捕获的异常,并通过 /error 接口返回结构化的错误响应或跳转到错误页面(如 HTML 页面)。

🔍 一、默认行为概览

请求类型返回内容
浏览器请求(HTML)跳转到 /error 页面(如 error.html
API 请求(JSON/REST)返回 JSON 格式的错误信息

例如:

  • 访问一个不存在的路径:GET /not-found
  • 控制器抛出未处理的异常 都会被 Spring Boot 的 /error 端点捕获并处理。

🛠️ 二、核心组件解析

1. BasicErrorController

这是 Spring Boot 默认提供的错误处理器,负责处理 /error 请求。

@Controller
@RequestMapping("${server.error.path:${spring.mvc.async.request-timeout}}")
public class BasicErrorController extends AbstractErrorController {
    ...
}
  • 默认路径为 /error(可通过 server.error.path 配置修改)
  • 支持两种响应格式:
    • text/html:返回 HTML 错误页面(如 error.html
    • 其他格式(如 JSON):返回结构化错误信息

2. ErrorAttributes 接口

该接口定义了错误信息的内容来源,包括:

  • 异常对象
  • HTTP 状态码
  • 请求 URL
  • 时间戳等

默认实现是 DefaultErrorAttributes,你也可以自定义。

3. ErrorViewResolver 接口

用于解析 HTML 错误页面。例如:

  • /templates/error/404.html
  • /templates/error/5xx.html
  • /templates/error.html

Spring Boot 会根据状态码优先匹配具体页面。

📦 三、默认返回的 JSON 错误结构

当你访问一个 REST 接口时,如果发生异常且没有被 @ExceptionHandler@ControllerAdvice 捕获,Spring Boot 会返回如下格式的 JSON 响应:

{
  "timestamp": "2025-07-12T10:45:00.000+00:00",
  "status": 404,
  "error": "Not Found",
  "path": "/not-found"
}

字段说明:

字段名含义
timestamp错误发生时间
statusHTTP 状态码
error错误描述
exception异常类名(仅当 spring.boot.debug=true 时显示)
message异常消息(可选)
path出错的请求路径

🌐 四、如何自定义错误处理?

虽然 Spring Boot 提供了默认的错误处理机制,但在实际项目中我们通常需要进行定制:

1. 方式一:自定义 ErrorAttributes

你可以实现 ErrorAttributes 接口来自定义错误信息内容:

@Component
public class CustomErrorAttributes extends DefaultErrorAttributes {
    @Override
    public Map<String, Object> getErrorAttributes(WebRequest webRequest, ErrorAttributeOptions options) {
        Map<String, Object> errorMap = super.getErrorAttributes(webRequest, options);
        errorMap.put("customInfo", "This is a custom error info.");
        return errorMap;
    }
}

2. 方式二:继承 BasicErrorController 自定义控制器

@RestController
@RequestMapping("${server.error.path:/error}")
public class CustomErrorController extends BasicErrorController {
    public CustomErrorController(ErrorAttributes errorAttributes) {
        super(errorAttributes, new ErrorProperties());
    }
    @Override
    public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
        Map<String, Object> body = getErrorAttributes(new ServletWebRequest(request), true);
        return new ResponseEntity<>(body, HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

3. 方式三:创建自定义错误页面(HTML)

将 HTML 页面放在以下位置之一即可:

  • src/main/resources/templates/error/404.html
  • src/main/resources/static/error/500.html
  • src/main/resources/public/error.html

Spring Boot 会根据 HTTP 状态码自动选择对应的页面。

4. 方式四:使用 @ControllerAdvice 全局处理异常

@RestControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(Exception.class)
    public ResponseEntity<Map<String, Object>> handleException(Exception ex, HttpServletRequest request) {
        Map<String, Object> errorBody = new HashMap<>();
        errorBody.put("error", ex.getMessage());
        errorBody.put("path", request.getRequestURI());
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(errorBody);
    }
}

这种方式比默认机制更灵活,适用于大型项目。

⚙️ 五、配置相关属性(application.yml)

你可以在 application.ymlapplication.properties 中配置一些与错误相关的参数:

spring:
  mvc:
    async:
      request-timeout: 0 # 禁用超时控制
server:
  error:
    path: /my-error     # 自定义错误路径
    whitelabel:
      enabled: false    # 关闭默认白标错误页

✅ 六、总结

项目内容
默认错误端点/error
默认控制器BasicErrorController
默认错误信息DefaultErrorAttributes
默认视图支持支持 HTML 错误页面(按状态码命名)
JSON 输出格式包含 timestamp, status, error, path 等字段
可扩展性支持自定义 ErrorAttributes、ErrorController、HTML 页面、@ControllerAdvice

到此这篇关于Spring Boot 中的默认异常处理机制(如 /error 接口)的文章就介绍到这了,更多相关Spring Boot 异常处理内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java实现非对称加密的三种方法

    Java实现非对称加密的三种方法

    本文主要介绍了Java实现非对称加密的三种方法,主要包括非对称加密算法--DH(密钥交换),非对称加密算法--RSA,非对称加密算法--EIGamal,具有一定的参考价值,感兴趣的可以了解一下
    2023-12-12
  • SpringCloud之注册中心之Nacos负载均衡详解

    SpringCloud之注册中心之Nacos负载均衡详解

    Nacos提供多种负载均衡策略,包括权重、同机房、同地域、同环境等,服务下线和权重配置可以通过Nacos管理界面进行,同时,Nacos使用Raft算法选举Leader节点,若IP地址改变可能会影响Leader选举,配置同集群优先访问可以提高访问速度,通过配置集群名称和负载均衡策略
    2025-03-03
  • 带你了解Java常用类小结

    带你了解Java常用类小结

    今天带大家学习Java常用工具类,文中有非常详细的图文解说及代码示例,对正在学习java的小伙伴们很有帮助,需要的朋友可以参考下,希望能给你带来帮助
    2021-07-07
  • Java Cloneable接口的深拷贝与浅拷贝详解

    Java Cloneable接口的深拷贝与浅拷贝详解

    这篇文章主要为大家详细介绍了Java Cloneable接口的深拷贝与浅拷贝,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-03-03
  • mybatis中${}和#{}取值的区别分析

    mybatis中${}和#{}取值的区别分析

    mybatis中使用sqlMap进行sql查询时,经常需要动态传递参数,在动态SQL解析阶段, #{ } 和 ${ } 会有不同的表现,这篇文章主要给大家介绍了关于mybatis中${}和#{}取值区别的相关资料,需要的朋友可以参考下
    2021-09-09
  • Java设计模式之抽象工厂模式详解

    Java设计模式之抽象工厂模式详解

    这篇文章主要介绍了Java设计模式之抽象工厂模式详解,文中有非常详细的代码示例,对正在学习java的小伙伴们有非常好的帮助,需要的朋友可以参考下
    2021-05-05
  • 常用json与javabean互转的方法实现

    常用json与javabean互转的方法实现

    这篇文章主要介绍了常用json与javabean互转的方法实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-04-04
  • 基于SpringBoot实现大文件分块上传功能

    基于SpringBoot实现大文件分块上传功能

    这篇文章主要介绍了基于SpringBoot实现大文件分块上传功能,实现原理其实很简单,核心就是客户端把大文件按照一定规则进行拆分,比如20MB为一个小块,分解成一个一个的文件块,然后把这些文件块单独上传到服务端,需要的朋友可以参考下
    2024-09-09
  • Spring自定义注解配置简单日志示例

    Spring自定义注解配置简单日志示例

    这篇文章主要介绍了Spring自定义注解配置简单日志示例,注解可以增强我们的java代码,同时利用反射技术可以扩充实现很多功能,它们被广泛应用于三大框架底层,需要的朋友可以参考下
    2023-05-05
  • Java URL编码与解码基础详解

    Java URL编码与解码基础详解

    这篇文章主要介绍了Java URL编码与解码基础详解,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2025-06-06

最新评论