SpringBoot异常处理

news2024/9/25 17:22:43

目录

一、 错误处理

1. 默认规则

2. 定制错误处理逻辑

二、自定义异常处理

1. 实现 ErrorController

2. @RestControllerAdvice/@ControllerAdvice + @ExceptionHandler 实现自定义异常

3. 新建 UserController.class 测试 3 种不同异常的处理

4. 最终效果如下

补充

1. 参数校验所需依赖以及使用方式

2. 追踪抛出错误的方法

一、 错误处理

1. 默认规则

1）默认情况下，SpringBoot 提供了 /error 处理所有错误的映射

2）对于机器客户端，它将生成 JSON 响应，其中包含错误，HTTP 状态和异常消息的详细信息；对于浏览器客户端，它将响应一个 "whitelabel" 错误视图，以 HTML 格式呈现相同的数据

3）要对其自定义，添加 View 解析为 Error

4）要完全替换默认行为，可以实现 ErrorController 并注册该类型的 Bean 定义，或添加 ErrorAttributes 类型组件以使用现有机制并替换其内容；ErrorAttributes 中定义了返回哪些错误项

2. 定制错误处理逻辑

1）自定义错误页面 error/404.html，error/500.html 放到 /resources/public/error 文件夹下即可；也可以将这两个 html 命名为 4xx.html，5xx.html 则可处理对应 4xx、5xx 错误；当然还可以每个状态码放一个对应页面

 

2）通过 @ControllerAdvice/@RestControllerAdvice + @ExceptionHandler 处理异常

3）实现 HandlerExceptionResolver 处理异常

二、自定义异常处理

1. 实现 ErrorController

1. 新建 GlobalErrorController.class 实现 ErrorController 接口并实现如下逻辑

@RestController
public class GlobalErrorController implements ErrorController {
    // 错误请求路径
    private final String ERROR_PATH = "/error";

    @Resource
    private ErrorAttributes errorAttributes;

    @Override
    public String getErrorPath() {
        return ERROR_PATH;
    }

    /**
     * JSON格式错误信息
     */
    @RequestMapping(value = ERROR_PATH,  produces = {MediaType.APPLICATION_JSON_VALUE})
    public Map<String, Object> error(WebRequest webRequest) {
        ErrorAttributeOptions options = ErrorAttributeOptions.of(ErrorAttributeOptions.Include.MESSAGE);
        Map<String, Object> body = this.errorAttributes.getErrorAttributes(webRequest, options);
        return body;
    }
}

注意

1）ERROR_PATH = "/error" 这个路径其实就是 SpringBoot 错误处理机制中自动配置的路径；在 ErrorProperties.class 中可找到这个配置

2）如果在 application.properties 覆盖了默认错误路径，则上面代码中 ERROR_PATH 应设置为配置文件中的错误路径

# 全局错误映射路径
server.error.path = /error

3）这句代码：ErrorAttributeOptions.of(ErrorAttributeOptions.Include.MESSAGE)；的意思是返回给前端的错误信息中包含哪些信息，这个 of() 方法中可以指定返回信息范围(可以指定多个)，共有 4 个选项值：

  • ErrorAttributeOptions.Include.EXCEPTION：Include the exception class name attribute
  • ErrorAttributeOptions.Include.STACK_TRACE：Include the stack trace attribute
  • ErrorAttributeOptions.Include.MESSAGE：Include the message attribute
  • ErrorAttributeOptions.Include.BINDING_ERRORS：Include the binding errors attribute

不同值返回信息如下

a. ErrorAttributeOptions.Include.EXCEPTION

{
    "timestamp": "2022-08-07T13:53:40.607+00:00",
    "status": 500,
    "error": "Internal Server Error",
    "exception": "java.lang.RuntimeException",
    "message": "",
    "path": "/error123"
}

b. ErrorAttributeOptions.Include.STACK_TRACE，显示信息最多

{
    "timestamp": "2022-08-07T13:54:14.101+00:00",
    "status": 500,
    "error": "Internal Server Error",
    "trace": "java.lang.RuntimeException: Error\r\n\tat com.study ... ...
    "message": "",
    "path": "/error123"
}

c. ErrorAttributeOptions.Include.MESSAGE

{
    "timestamp": "2022-08-07T13:54:56.751+00:00",
    "status": 500,
    "error": "Internal Server Error",
    "message": "Error",
    "path": "/error123"
}

d. ErrorAttributeOptions.Include.BINDING_ERRORS

{
    "timestamp": "2022-08-07T13:53:03.791+00:00",
    "status": 500,
    "error": "Internal Server Error",
    "message": "",
    "path": "/error123"
}

2. @RestControllerAdvice/@ControllerAdvice + @ExceptionHandler 实现自定义异常

在一次请求调用过程中，如果程序出现异常，我们应对异常进行拦截，把异常中重要信息记录在日志便于排查错误，只提供简单的错误信息返回给前端；这个时候通过 @RestControllerAdvice/@ControllerAdvice + @ExceptionHandler 可轻松实现

1. 新建 GlobalException.class 继承 RuntimeException 并重写构造方法

@Data
public class GlobalException extends RuntimeException {
    // 错误编码
    private Integer errorCode;
    // 错误信息
    private String errorMsg;
    // 具体信息
    private String errorInfo;

    public GlobalException(Integer errorCode, String errorMsg, String errorInfo) {
        super(errorMsg);
        this.errorCode = errorCode;
        this.errorMsg = errorMsg;
        this.errorInfo = errorInfo;
    }

    public GlobalException(Integer errorCode, String errorMsg, Throwable cause) {
        super(errorMsg, cause);
        this.errorCode = errorCode;
        this.errorMsg = errorMsg;
        this.errorInfo = cause.getMessage();
    }
}

2. 新建 GlobalExceptionHandler.class 实现对系统错误的统一处理

@RestControllerAdvice
public class GlobalExceptionHandler {
    /**
     * 处理全局系统异常(非自定义异常)
     */
    @ExceptionHandler(Exception.class)
    public Map<String, Object> handleSystemException(Exception exception) {
        Map<String, Object> exceptionInfo = new HashMap<>();
        exceptionInfo.put("errorCode", 500);
        exceptionInfo.put("errorMsg", "系统故障");
        // 日志记录具体信息，不要返回给前端
        System.out.println(exception.getMessage());
        return exceptionInfo;
    }

    /**
     * 处理自定义异常
     */
    @ExceptionHandler(GlobalException.class)
    public Map<String, Object> handleGlobalException(GlobalException exception) {
        Map<String, Object> exceptionInfo = new HashMap<>();
        exceptionInfo.put("errorCode", exception.getErrorCode());
        exceptionInfo.put("errorMsg", exception.getErrorMsg());
        // 日志记录具体信息，不要返回给前端
        System.out.println(exception.getErrorInfo());
        return exceptionInfo;
    }

    /**
     * 实体类属性校验异常
     */ 
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Map<String, Object> MethodArgumentNotValidExceptionHandler(MethodArgumentNotValidException exception) {
        ObjectError objectError = exception.getBindingResult().getAllErrors().get(0);
        Map<String, Object> exceptionInfo = new HashMap<>();
        exceptionInfo.put("errorCode", 550);
        exceptionInfo.put("errorMsg", objectError.getDefaultMessage());
        return exceptionInfo;
    }
}

3. 新建 UserController.class 测试 3 种不同异常的处理

@RestController
public class UserController {
    /**
     * 测试全局异常
     */
    @GetMapping("/error1")
    public Integer error1() {
        int m = 10 / 0;
        return m;
    }

    /**
     * 测试自定义异常
     */
    @GetMapping("/error2")
    public Integer error2() {
        try {
            int m = 10 / 0;
            return m;
        } catch (Exception e) {
            throw new GlobalException(501, "系统错误", e);
        }
    }

    /**
     * 测试实体类字段校验异常
     */
    @PostMapping("/error3")
    public User error3(@RequestBody @Valid User user) {
        return user;
    }
}

4. 最终效果如下

1）全局异常测试(非自定义异常)：http://localhost:8080/error1

{
    "errorCode": 500,
    "errorMsg": "系统故障"
}

2）自定义异常测试：http://localhost:8080/error2

{
    "errorCode": 501,
    "errorMsg": "系统错误"
}

3）实体类字段校验异常测试：http://localhost:8080/error3

{
    "errorCode": 550,
    "errorMsg": "年龄不能超过100岁"
}

补充

1. 参数校验所需依赖以及使用方式

1）实体类字段校验需要引入如下依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

2）实体类上添加注解

@Data
public class User {
    @NotBlank(message = "用户名不能为空")
    private String name;
    
    @NotNull(message = "年龄不能为空")
    @Min(value = 1, message = "年龄不能小于1岁")
    @Max(value = 100, message = "年龄不能超过100岁")
    private Integer age;
}

2. 追踪抛出错误的方法

上面的异常处理，虽然把返回给前端的异常提示信息和日志记录的异常信息进行了处理，但对于后端来说，日志仅仅打印了错误信息，并没有记录是哪个类哪个方法的抛出的异常，这不便于后端调试，所以可添加如下方法记录抛出错误的类和方法

1）添加根据异常查找出执行的类和方法

/**
 * 找出执行类和执行方法

 */
private String getExecutedMethod(Exception e) {
    StackTraceElement[] elements = e.getStackTrace();
    if(elements.length > 0) {
        // 异常链中第一个也就是最外层的信息, 当然就是 controller 这一层
        StackTraceElement target = elements[0];
        return String.format("%s#%s", target.getClassName(), target.getMethodName());
    }
    return "";
}

2）在异常处理器中做如下修改即可

/**
 * 处理全局系统异常(非自定义异常)
 */
@ExceptionHandler(Exception.class)
public Map<String, Object> handleSystemException(Exception exception) {
    Map<String, Object> exceptionInfo = new HashMap<>();
    exceptionInfo.put("errorCode", 500);
    exceptionInfo.put("errorMsg", "系统故障");
    // 日志记录具体信息，不要返回给前端
    String executedMethod = getExecutedMethod(exception);
    String exceptionMessage = String.format("执行方法: %s, 错误信息: %s", executedMethod, exception.getMessage());
    tem.out.println(exceptionMessage);
    return exceptionInfo;
}

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/382368.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

【数据结构】八大经典排序总结

【数据结构】八大经典排序总结

文章目录一、排序的概念及其运用1.排序的概念2.常见排序的分类3.排序的运用二、常见排序算法的实现1.直接插入排序1.1排序思想1.2代码实现1.3复杂度及稳定性1.4特性总结2.希尔排序2.1排序思想2.3复杂度及稳定性2.4特性总结3.直接选择排序3.1排序思想3.2代码实现3.3复杂度及稳定…
阅读更多...
《数据治理行业实践白皮书》正式发布，开辟数据治理新范式（附下载）

《数据治理行业实践白皮书》正式发布，开辟数据治理新范式（附下载）

近日&#xff0c;作为首届未来数商大会协办单位之一&#xff0c;袋鼠云承办“首届未来数商大会——业数融合创新论坛”&#xff0c;与参会嘉宾共同探讨数据驱动企业业务增长提效的新思路。袋鼠云联合创始人、易知微CEO 宁海元发表主题演讲《数智视融合&#xff0c;构建数字产业…
阅读更多...
Docker安装Cassandra数据库，在SpringBoot中连接Cassandra

Docker安装Cassandra数据库，在SpringBoot中连接Cassandra

简介 Apache Cassandra是一个高度可扩展的高性能分布式数据库&#xff0c;旨在处理许多商用服务器上的大量数据&#xff0c;提供高可用性而没有单点故障。它是NoSQL数据库的一种。首先让我们了解一下NoSQL数据库的作用。 NoSQL 数据库 NoSQL数据库&#xff08;有时称为“Not …
阅读更多...
YOLO5-V7.0的python代码转成exe，方便离线部署

YOLO5-V7.0的python代码转成exe，方便离线部署

思路&#xff1a;用Pyinstaller打包&#xff0c;但有一些坑&#xff0c;踩完坑后成功运行&#xff0c;写个踩坑指南分享下。 前提&#xff1a;已经在conda 环境下安装完可以运行的yolo5代码&#xff0c;例如你的虚拟python环境叫yolo5&#xff0c;主代码是XXX.py&#xff08;这…
阅读更多...
数字IC手撕代码--低功耗设计 Clock Gating

数字IC手撕代码--低功耗设计 Clock Gating

背景介绍芯片功耗组成中&#xff0c;有高达 40%甚至更多是由时钟树消耗掉的。这个结果的原因也很直观&#xff0c;因 为这些时钟树在系统中具有最高的切换频率&#xff0c;而且有很多时钟 buffer&#xff0c;而且为了最小化时钟 延时&#xff0c;它们通常具有很高的驱动强度。 …
阅读更多...
《分布式技术原理与算法解析》学习笔记Day26

《分布式技术原理与算法解析》学习笔记Day26

流量控制 什么是流量控制&#xff1f; 网络传输中的流量控制就是让发送方发送数据的速度不要太快&#xff0c;这样可以让接收方来得及接收数据&#xff0c;通常使用滑动窗口的方式来实现。 滑动窗口是指在任意时刻&#xff0c;发送方都维持一个连续的允许发送的数据大小&…
阅读更多...
全国CSM敏捷教练认证将于2023年3月25-26开班，报名从速！

全国CSM敏捷教练认证将于2023年3月25-26开班，报名从速！

CSM&#xff0c;即Certified Scrum Master&#xff0c;是Scrum联盟发起的Scrum认证。 CSM可以帮助团队正确使用Scrum&#xff0c;从而提高项目整体成功的可能性。 CSM深刻理解Scrum的价值观、实践以及Scrum框架。 CSM是“服务型领导”&#xff0c;帮助Scrum团队一起紧密合作。 …
阅读更多...
QT案例 Qt Creator 使用QuaZIP加密压缩解压ZIP文件

QT案例 Qt Creator 使用QuaZIP加密压缩解压ZIP文件

QT开发中部分项目可能会涉及对项目数据的一些指定文件的打包压缩以及指定目录下的解压&#xff0c;此时也需要对数据数据进行加密以确保数据的安全性。此时就可以使用Quazip实现相关功能。 QuaZIP是使用Qt&#xff0c;C对ZLIB进行简单封装的用于压缩ZIP以及解压缩ZIP的开源库。…
阅读更多...
Hive表-----数据清洗

Hive表-----数据清洗

以下内容所需要的环境 &#xff1a;hive 、beeline、Zeppelin&#xff08;可视化界面如何操作表格&#xff09; 一、准备表格 1、上传csv表格至linux目录中 百度网盘自取&#xff1a;链接&#xff1a;https://pan.baidu.com/s/1xd5MdXiBDLBUtP07kpgl5Q?pwd2ema 提取码&…
阅读更多...
python+appium+夜神模拟器（app抓包爬虫）

python+appium+夜神模拟器（app抓包爬虫）

安装模块 pip install appium-python-client 安装andriodSDK 官网下载&#xff1a;https://android-sdk.en.softonic.com/download 自动下载一个压缩包&#xff0c;解压后就是一个文件夹放各种需要的文件&#xff0c;将解压的路径配置到环境变量中。 然后添加到path中。 下…
阅读更多...
带你了解“函数递归”

带你了解“函数递归”

目录 1. 什么是递归&#xff1f; 2. 函数递归的必要条件 2.1 接收一个整型值&#xff08;无符号&#xff09;&#xff0c;按照顺序打印它的每一位。 代码如下&#xff1a; 2.2 编写一个函数&#xff0c;不用临时变量求字符串长度 代码如下&#xff1a; 2.3 递归与迭代 …
阅读更多...
爬虫之Selenium，Phantomjs，Chrome handless

爬虫之Selenium，Phantomjs，Chrome handless

爬虫之模拟浏览器前言1. Selenium1.1 Selenium介绍1.2 安装selenium1.3 Selenium访问京东1.4 Selenium元素定位1.5 seleniu访问元素信息1.6 selenium交互2. Phantomjs2.1 介绍Phantomjs2.1 使用Phantomjs3. Chrome handless3.1 Chrome handless的系统要求3.2 Chrome handless的…
阅读更多...
STM32 E18-D80NK红外检测

STM32 E18-D80NK红外检测

本文代码使用 HAL 库。 文章目录前言一、E18-D80NK 红外传感器&#xff1a;1. E18-D80NK 的介绍2. 电器特性二、红外检测小实验代码讲解三、实验现象总结前言 这篇文章介绍 如何使用 STM32 控制 E18-D80NK 进行红外检测。 一、E18-D80NK 红外传感器&#xff1a; 1. E18-D80N…
阅读更多...
Qt学习笔记-Qt程序中的调试日志

Qt学习笔记-Qt程序中的调试日志

Qt学习笔记-Qt程序中的调试日志环境说明Qt程序中调试日志使用案例对于一门好的编程语言或者开发框架来说&#xff0c;便捷的调试日志功能是必不可少的。QT作为一个跨平台的开发工具&#xff0c;内置了便捷的调试日志功能&#xff0c;本文就对其做一个简介。环境说明 操作系统&…
阅读更多...
测试好工具fiddler，手机抓包，查看手机app请求了哪些接口

测试好工具fiddler，手机抓包，查看手机app请求了哪些接口

领导让我接收一个项目&#xff0c;但是这个项目是安卓的&#xff0c;安卓我一窍不通&#xff0c;我们只做过web页面的。身为一个大数据程序员&#xff0c;要接手同事的项目&#xff0c;给我了代码&#xff0c;但是我完全不知道&#xff0c;这个代码对应&#xff0c;安卓机里面的…
阅读更多...
Serverless 时代开启，云计算进入业务创新主战场

Serverless 时代开启，云计算进入业务创新主战场

作者&#xff1a;于洪涛 “我们希望让用户做得更少而收获更多&#xff0c;通过 Serverless 化&#xff0c;让企业使用云服务像用电一样简单。” Serverless 化正在成为全新的软件研发范式&#xff0c;阿里云将坚定推进核心产品全面 Serverless 化&#xff0c;帮助客户更好的实现…
阅读更多...
Jetpack Compose 深入探索系列五：State Snapshot System

Jetpack Compose 深入探索系列五：State Snapshot System

Jetpack Compose 有一种特殊的方式来表示状态和传播状态变化&#xff0c;从而驱动最终的响应式体验&#xff1a;状态快照系统&#xff08;State snapshot system&#xff09;。这种响应式模型使我们的代码更加强大和简洁&#xff0c;因为它允许组件根据它们的输入自动重组&…
阅读更多...
Zookeeper3.5.7版本——Zookeeper的概述、工作机制、特点、数据结构及应用场景

Zookeeper3.5.7版本——Zookeeper的概述、工作机制、特点、数据结构及应用场景

目录一、Zookeeper的概述二、Zookeeper的工作机制三、Zookeeper的特点四、Zookeeper的数据结构五、Zookeeper的应用场景5.1、统一命名服务5.2、统一配置管理5.3、统一集群管理5.4、服务器动态上下线5.5、软负载均衡一、Zookeeper的概述 Zookeeper 是一个开源的分布式的&#x…
阅读更多...
飞桨全量支持业内AI科学计算工具——DeepXDE!

飞桨全量支持业内AI科学计算工具——DeepXDE!

AI技术在跨学科融合创新方面扮演着日益重要的角色&#xff0c;特别是在Al for Science领域&#xff0c;AI技术的发展为跨学科、跨领域的融合创新带来了巨大的机会。AI已成为一个关键的研究工具&#xff0c;改变了基础科学的研究范式。依托AI技术开发的科学计算工具&#xff0c;…
阅读更多...
【教学类-07-06】20230302《破译电话号码-图形篇（图形固定列不重复）》（两款输入版）

【教学类-07-06】20230302《破译电话号码-图形篇（图形固定列不重复）》（两款输入版）

效果展示1、适合中班默写学号——有姓名 有班级&#xff0c;无学号&#xff0c;适合中班幼儿2、适合大班幼儿默写名字——有学号&#xff0c;有班级&#xff0c;无姓名&#xff0c;适合初学者描字&#xff08;小班、中班、大班&#xff09;——名字、学号、班级都有&#xff08…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023