SpringBoot中全局异常捕获与参数校验的优雅实现

一，为什么要用全局异常处理？

在日常开发中，为了不抛出异常堆栈信息给前端页面，每次编写Controller层代码都要尽可能的catch住所有service层、dao层等异常，代码耦合性较高，且不美观，不利于后期维护。

为解决该问题，计划将Controller层异常信息统一封装处理，且能区分对待Controller层方法返回给前端的String、Map、JSONObject、ModelAndView等结果类型。

二，应用场景是什么？

  • 非常方便的去掉了try catch这类冗杂难看的代码，有利于代码的整洁和优雅

  • 自定义参数校验时候全局异常处理会捕获异常，将该异常统一返回给前端，省略很多if else代码

  • 当后端出现异常时，需要返回给前端一个友好的界面的时候就需要全局异常处理

  • 因为异常时层层向上抛出的，为了避免控制台打印一长串异常信息

三、如何进行全局异常捕获和处理？

一共有两种方法：

  • Spring的AOP（较复杂）

  • @ControllerAdvice结合@ExceptionHandler（简单）

springboot后端api接口的实现通道：后端API接口设计

四、@ControllerAdvice和@ExceptionHandler怎么用？

1、Controller Advice

字面上意思是“控制器通知”，Advice除了“劝告”、“意见”之外，还有“通知”的意思。

可以将@ExceptionHandler（标识异常类型对应的处理方法）标记的方法提取出来，放到一个类里，并将加上@ControllerAdvice，这样，所有的控制器都可以用了

@ControllerAdvice
public class ControllerHandlers(){@ExceptionHandlerpublic String errorHandler(Exception e){return "error";}
}

2、 因为@ControllerAdvice被@Componen标记

所以他可以被组件扫描到并放入Spring容器

3、 如果只想对一部分控制器通知

比如某个包下边的控制器，就可以这样写：

@ControllerAdvice("com.labor")
public class ControllerHandlers(){}
也可以直接写类名
@ControllerAdvice(basePackageClasses = ***.class)
public class ControllerHandlers(){}
也可以传多个类
@ControllerAdvice(assignableTypes = {***.class,***.class})
public class ControllerHandlers(){}

4、 控制器通知还有一个兄弟

@RestControllerAdvice，如果用了它，错误处理方法的返回值不会表示用的哪个视图，而是会作为HTTP body处理，即相当于错误处理方法加了@ResponseBody注解。

@RestControllerAdvice
public class ControllerHandlers(){@ExceptionHandlerpublic String errorHandler(Exception e){return "error";}
}

5、@ExceptionHandler

注解的方法只能返回一种类型,在前后端分离开发中我们通常返回，统一返回类型和优化错误的提示，我们可以封装我们自己的返回Map

public class AjaxResult extends HashMap<String, Object> {private static final long serialVersionUID = 1L;public static final String CODE_TAG = "code";public static final String MSG_TAG = "msg";public static final String DATA_TAG = "data";/*** 状态类型*/public enum Type {/*** 成功*/SUCCESS(1),/*** 警告*/WARN(2),/*** 错误*/ERROR(0),/**无权限*/UNAUTH(3),/**未登录、登录超时*/UNLOGIN(4);private final int value;Type(int value) {this.value = value;}public int value() {return this.value;}}/*** 状态类型*/private Type type;/*** 状态码*/private int code;/*** 返回内容*/private String msg;/*** 数据对象*/private Object data;/*** 初始化一个新创建的 AjaxResult 对象，使其表示一个空消息。*/public AjaxResult() {}/*** 初始化一个新创建的 AjaxResult 对象* @param type 状态类型* @param msg  返回内容*/public AjaxResult(Type type, String msg) {super.put(CODE_TAG, type.value);super.put(MSG_TAG, msg);}/*** 初始化一个新创建的 AjaxResult 对象* @param type 状态类型* @param msg  返回内容* @param data 数据对象*/public AjaxResult(Type type, String msg, Object data) {super.put(CODE_TAG, type.value);super.put(MSG_TAG, msg);/* 数据为空的时候，还是需要把参数传给前台   huangqr @2019.7.19if (StringUtils.isNotNull(data)) {super.put(DATA_TAG, data);}*/super.put(DATA_TAG, data);}/*** 返回成功消息* @return 成功消息*/public static AjaxResult success() {return AjaxResult.success("操作成功");}/*** 返回成功数据* @return 成功消息*/public static AjaxResult success(Object data) {return AjaxResult.success("操作成功", data);}/*** 返回成功消息* @param msg 返回内容* @return 成功消息*/public static AjaxResult success(String msg) {return AjaxResult.success(msg, null);}/*** 返回成功消息* @param msg  返回内容* @param data 数据对象* @return 成功消息*/public static AjaxResult success(String msg, Object data) {return new AjaxResult(Type.SUCCESS, msg, data);}/*** 返回警告消息* @param msg 返回内容* @return 警告消息*/public static AjaxResult warn(String msg) {return AjaxResult.warn(msg, null);}/*** 返回警告消息* @param msg  返回内容* @param data 数据对象* @return 警告消息*/public static AjaxResult warn(String msg, Object data) {return new AjaxResult(Type.WARN, msg, data);}/*** 返回错误消息* @return*/public static AjaxResult error() {return AjaxResult.error("操作失败");}/*** 返回错误消息* @param msg 返回内容* @return 警告消息*/public static AjaxResult error(String msg) {return AjaxResult.error(msg, null);}/*** 返回错误消息* @param msg  返回内容* @param data 数据对象* @return 警告消息*/public static AjaxResult error(String msg, Object data) {return new AjaxResult(Type.ERROR, msg, data);}/*** 无权限返回* @return*/public static AjaxResult unauth() {return new AjaxResult(Type.UNAUTH, "您没有访问权限！", null);}/*** 无权限** @param msg* @return com.wanda.labor.framework.web.domain.AjaxResult* @exception*/public static AjaxResult unauth(String msg) {return new AjaxResult(Type.UNAUTH, msg, null);}/*** 未登录或登录超时。请重新登录** @param* @return com.wanda.labor.framework.web.domain.AjaxResult* @exception*/public static AjaxResult unlogin() {return new AjaxResult(Type.UNLOGIN, "未登录或登录超时。请重新登录！", null);}public Type getType() {return type;}public void setType(Type type) {this.type = type;}public int getCode() {return code;}public void setCode(int code) {this.code = code;}public String getMsg() {return msg;}public void setMsg(String msg) {this.msg = msg;}public Object getData() {return data;}public void setData(Object data) {this.data = data;}public static class SUCCESS{public static AjaxResult data(Object data){return new AjaxResult(Type.SUCCESS, "操作成功 Operation Successful", data);}public static AjaxResult iMessagesg(String msg){return new AjaxResult(Type.SUCCESS, msg, null);}public static AjaxResult imsgAndData(String msg,Object data){return new AjaxResult(Type.SUCCESS, msg, data);}}@Overridepublic String toString() {return new ToStringBuilder(this, ToStringStyle.MULTI_LINE_STYLE).append("code", getCode()).append("msg", getMsg()).append("data", getData()).toString();}
}

6、 完善全局异常处理器

@RestControllerAdvice
public class GlobalExceptionHandler {private static final Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);/*** 权限校验失败 如果请求为ajax返回json，普通请求跳转页面*/@ExceptionHandler(AuthorizationException.class)public Object handleAuthorizationException(HttpServletRequest request, AuthorizationException e) {//log.error(e.getMessage(), e);if (ServletUtils.isAjaxRequest(request)) {return AjaxResult.unauth(PermissionUtils.getMsg(e.getMessage()));} else {ModelAndView modelAndView = new ModelAndView();modelAndView.setViewName("error/unauth");return modelAndView;}}/*** 请求方式不支持*/@ExceptionHandler({HttpRequestMethodNotSupportedException.class})public AjaxResult handleException(HttpRequestMethodNotSupportedException e) {log.error(e.getMessage(), e);return AjaxResult.error("不支持' " + e.getMethod() + "'请求");}/*** 拦截未知的运行时异常*/@ExceptionHandler(RuntimeException.class)public AjaxResult notFount(RuntimeException e) {log.error("运行时异常:", e);return AjaxResult.error("运行时异常:" + e.getMessage());}/*** 系统异常*/@ExceptionHandler(Exception.class)public AjaxResult handleException(Exception e) {log.error(e.getMessage(), e);return AjaxResult.error("服务器错误，请联系管理员");}/*** 校验异常*/@ExceptionHandler(value = MethodArgumentNotValidException.class)public AjaxResult exceptionHandler(MethodArgumentNotValidException e) {BindingResult bindingResult = e.getBindingResult();String errorMesssage = "";for (FieldError fieldError : bindingResult.getFieldErrors()) {errorMesssage += fieldError.getDefaultMessage() + "!";}return AjaxResult.error(errorMesssage);}/*** 校验异常*/@ExceptionHandler(value = BindException.class)public AjaxResult validationExceptionHandler(BindException e) {BindingResult bindingResult = e.getBindingResult();String errorMesssage = "";for (FieldError fieldError : bindingResult.getFieldErrors()) {errorMesssage += fieldError.getDefaultMessage() + "!";}return AjaxResult.error(errorMesssage);}/*** 校验异常*/@ExceptionHandler(value = ConstraintViolationException.class)public AjaxResult ConstraintViolationExceptionHandler(ConstraintViolationException ex) {Set<ConstraintViolation<?>> constraintViolations = ex.getConstraintViolations();Iterator<ConstraintViolation<?>> iterator = constraintViolations.iterator();List<String> msgList = new ArrayList<>();while (iterator.hasNext()) {ConstraintViolation<?> cvl = iterator.next();msgList.add(cvl.getMessageTemplate());}return AjaxResult.error(String.join(",",msgList));}/*** 业务异常*/@ExceptionHandler(BusinessException.class)public AjaxResult businessException(BusinessException e) {log.error(e.getMessage(), e);return AjaxResult.error(e.getMessage());}/*** 演示模式异常*/@ExceptionHandler(DemoModeException.class)public AjaxResult demoModeException(DemoModeException e) {return AjaxResult.error("演示模式，不允许操作");}}

六、@Validated 校验器注解的异常，也可以一起处理，无需手动判断绑定校验结果 BindingResult/Errors 了

pom文件

引入validation的jar包。

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

等待校验的object

public class Person {/*** @PersonName(prefix = "song")：自定义注解*/@NotNull@PersonName(prefix = "song")private String name;@Min(value = 18)@Max(value = 30, message = "超过30岁的不要！")private Integer age;
}

使用

/*** 开启校验注解：@Valid*/
@RestController
public class PersonController {@PostMapping("/person")public Person savePerson(@Valid @RequestBody Person person){return person;}
}

全局异常处理里有相应的处理方法

/*** 校验异常*/
@ExceptionHandler(value = BindException.class)
public AjaxResult validationExceptionHandler(BindException e) {BindingResult bindingResult = e.getBindingResult();String errorMesssage = "";for (FieldError fieldError : bindingResult.getFieldErrors()) {errorMesssage += fieldError.getDefaultMessage() + "!";}return AjaxResult.error(errorMesssage);
}

被@RequestBody和@RequestParam注解的请求实体，校验异常类是不同的

七、自定义异常以及事务回滚

public class MyException extends RuntimeException {//这个地方不要写exception，因为Spring是只对运行时异常进行事务回滚，//如果抛出的是exception是不会进行事务回滚的。}

如果是在service层里捕获异常统一去处理，那为了保证事务的回滚，需要抛出RuntimeException

try {} catch (Exception e) {e.printStackTrace();logger.error("发生异常");throw new RuntimeException();}

关于try-catch-finally中，finally的作用，finally设计之初就是为了关闭资源，如果在finally中使用return语句，会覆盖try或者catch的返回值，最常见的就是覆盖异常，即便catch往上抛了异常，也会被覆盖，返回finally中return语句的返回值。

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

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

相关文章

DLT 直接线性变换

DLT 直接线性变换

DLT 直接线性变换 对于单应变换 x i ′ H x i x_i^{\prime}Hx_i xi′​Hxi​&#xff0c;易知两图中对应的特征点&#xff0c;如何找出所需要的 H H H​&#xff0c;为了解决这个问题&#xff0c;可以采用DLT算法 原理 其中采用Least Squares Error去拟合 其中目标是获得最佳…
阅读更多...
【办公类-22-05】20240419 UIBOT填写“PATHS课程”的《SSBS校园行为问卷》

【办公类-22-05】20240419 UIBOT填写“PATHS课程”的《SSBS校园行为问卷》

背景需求&#xff1a; 每年都有一个PATHS课程的“家长问卷调查”和“教师问卷调查”需要填写 作为教师&#xff0c;每次要对全班所有的孩子进行评价&#xff0c;每位孩子64题&#xff01; 反复点题目&#xff0c;感觉非常累&#xff0c;工作操作就是两位老师&#xff0c;每人做…
阅读更多...
Golang | Leetcode Golang题解之第25题K个一组翻转链表

Golang | Leetcode Golang题解之第25题K个一组翻转链表

题目&#xff1a; 题解&#xff1a; func reverseKGroup(head *ListNode, k int) *ListNode {hair : &ListNode{Next: head}pre : hairfor head ! nil {tail : prefor i : 0; i < k; i {tail tail.Nextif tail nil {return hair.Next}}nex : tail.Nexthead, tail my…
阅读更多...
U盘秒变0字节？别慌，数据恢复有妙招！

U盘秒变0字节？别慌，数据恢复有妙招！

在日常的工作和生活中&#xff0c;U盘已成为我们不可或缺的数据存储工具。然而&#xff0c;有时候我们可能会遇到一个令人头疼的问题&#xff1a;原本存有重要文件的U盘&#xff0c;突然间容量显示为0字节。这意味着U盘中的数据全部丢失&#xff0c;无法读取。那么&#xff0c;…
阅读更多...
hackthebox - Redeemer

hackthebox - Redeemer

2024.4.19 TASK 1 Which TCP port is open on the machine? 6379 TASK 2 Which service is running on the port that is open on the machine? redis TASK 3 What type of database is Redis? Choose from the following options: (i) In-memory Database, (ii) Traditiona…
阅读更多...
UltraScale+的10G/25G Ethernet Subsystem IP核使用

UltraScale+的10G/25G Ethernet Subsystem IP核使用

文章目录 前言一、设计框图1.1、xxv_ethernet_01.2、xxv_ethernet_0_sharedlogic_wrapper1.3、xxv_ethernet_0_clocking_wrapper1.4、xxv_ethernet_0_common_wrapper 二、IP核配置三、仿真四、上板测速 前言 前面我们学习了很多基于XILINX 7系列的高速接口使用&#xff0c;本文…
阅读更多...
组合预测 | Matlab实现ICEEMDAN-SMA-SVM基于改进完备集合经验模态分解-黏菌优化算法-支持向量机的时间序列预测

组合预测 | Matlab实现ICEEMDAN-SMA-SVM基于改进完备集合经验模态分解-黏菌优化算法-支持向量机的时间序列预测

组合预测 | Matlab实现ICEEMDAN-SMA-SVM基于改进完备集合经验模态分解-黏菌优化算法-支持向量机的时间序列预测 目录 组合预测 | Matlab实现ICEEMDAN-SMA-SVM基于改进完备集合经验模态分解-黏菌优化算法-支持向量机的时间序列预测预测效果基本介绍程序设计参考资料预测效果 基本…
阅读更多...
爬取微博评论数据

爬取微博评论数据

# -*- coding: utf-8 -*- import requests #用于发送请求并且拿到源代码 from bs4 import BeautifulSoup #用于解析数据 1.找到数据源地址并且分析链接 2.发送请求并且拿到数据 3.在拿到的数据中解析出需要的数据 4.存储数据 headers { "User-Agent": "…
阅读更多...
Go微服务: go-micro集成链路追踪jaeger

Go微服务: go-micro集成链路追踪jaeger

关于链路追踪jeager的原理 参考: https://blog.csdn.net/Tyro_java/article/details/137754812 核心代码演示 1 ) 概述 这里接前文结构框架&#xff1a;https://blog.csdn.net/Tyro_java/article/details/137753232 2 &#xff09;核心代码&#xff1a;common/jaeger.go p…
阅读更多...
C++中string的用法总结+底层剖析

C++中string的用法总结+底层剖析

前言&#xff1a;在C语言中&#xff0c;我们经常使用字符串进行一系列操作&#xff0c;经常使用的函数如下&#xff1a;增删改查 &#xff08;自己造轮子&#xff09;&#xff0c;C中设计出string容器&#xff0c;STL库中为我们提供了以上函数&#xff0c;所以我们使用string容…
阅读更多...
华为OD-C卷-密码解密[100分]Python3+C语言-90%

华为OD-C卷-密码解密[100分]Python3+C语言-90%

题目描述 给定一段“密文”字符串 s，其中字符都是经过“密码本”映射的，现需要将“密文”解密并输出。 映射的规则（a ~ i）分别用（1 ~ 9）表示；（j ~ z）分别用（"10*" ~ "26*"）表示。 约束：映射始终唯一。 输入描述 “密文”字符串 输出描述 …
阅读更多...
libftdi1学习笔记 7 - MPSSE I2C

libftdi1学习笔记 7 - MPSSE I2C

目录 1. 初始化 2. 原理 3. i2cStart 4. i2cStop 5. i2cRecvByte 6. i2cSendByte 7. i2cRead 8. i2cWrite 9. 验证 9.1 初始化i2c 9.2 初始化gpio 9.3 写10个字节到EEPROM 9.4 读回10字节数据 9.5 运行结果 I2C&#xff08;主&#xff09;采用2个或3个GPIO模拟的…
阅读更多...
QTableView获取可见的行数

QTableView获取可见的行数

场景 当我们需要实时刷新QTableView时&#xff0c;而此时tableView的数据量较大&#xff0c;如果全部刷新显然不合理&#xff0c;如果可以只对用户看的到的数据进行刷新那就最好了&#xff0c;经过一番摸索找到了几种方式&#xff0c;可供参考 代码 方法1 QVector<int>…
阅读更多...
64B/66B编码 自定义PHY层设计

64B/66B编码 自定义PHY层设计

一、前言 之前的一篇文章讲解了64B/66B的基本原理&#xff0c;本篇在基于64B/66B GT Transceiver的基础之上设计自定义PHY。基本框图如下。 二、GT Mdule GT Module就按照4个GT CHannel共享一个GT COMMON进行设置&#xff0c;如下图。要将例子工程中的GT COMMON取出&#xff…
阅读更多...
docker环境搭建

docker环境搭建

项目环境搭建 1、安装 Linux 虚拟机 &#xff08;1&#xff09;下载安装&#xff1a; VM VirtualBox 下载安装&#xff1a;Downloads – Oracle VM VirtualBox&#xff0c;要先开启CPU虚拟化 &#xff08;2&#xff09;通过vagrant&#xff0c;在VirtualBox中安装虚拟机 下…
阅读更多...
STM32学习和实践笔记（15）：STM32中断系统

STM32学习和实践笔记（15）：STM32中断系统

中断概念 CPU执行程序时&#xff0c;由于发生了某种随机的事件(外部或内部)&#xff0c;引起CPU暂 时中断正在运行的程序&#xff0c;转去执行一段特殊的服务程序(中断服务子程序 或中断处理程序)&#xff0c;以处理该事件&#xff0c;该事件处理完后又返回被中断的程序 继…
阅读更多...
修改Ubuntu的镜像源为清华镜像源

修改Ubuntu的镜像源为清华镜像源

修改Ubuntu的镜像源为清华镜像源 1、首先使用以下命令备份现有的镜像源&#xff1a; cd /etc/apt sudo cp sources.list sources.list.bak 2、使用以下命令打开镜像源文件&#xff1a; sudo vim /etc/apt/sources.list 3、在vim插入模式下使用以下内容替换掉原镜像源…
阅读更多...
MySQL基础-----约束详解

MySQL基础-----约束详解

目录 一. 概述: 二.约束演示&#xff1a; 三.外键约束&#xff1a; 3.1介绍&#xff1a; 3.2外键约束语法&#xff1a; 3.3删除&#xff0c;更新行为&#xff1a; 一. 概述: &#x1f9d0;&#x1f9d0;概念&#xff1a;约束是作用于表中字段上的规则&#xff0c;用于限制…
阅读更多...
css面试题整理

css面试题整理

css面试题 一、HTML语义化标签二、块级元素、内联元素、 行内块元素三、盒模型 一、HTML语义化标签 什么是HTML语义化标签&#xff1f;语义化标签的优势&#xff1f; HTML语义化标签顾名思义就是赋予标签含义&#xff0c;比如说<p>标签代表的是段落&#xff0c;还有<…
阅读更多...
springboot结合vue实现文件上传下载功能

springboot结合vue实现文件上传下载功能

紧接着上一次的博客&#xff0c;这次来实现一下文件(主要是图片)的上传和下载功能&#xff0c;上一次的博客如下所示&#xff1a; Springboot集成JWT token实现权限验证-CSDN博客 其实文件的上传和下载功能(后端的部分)&#xff0c;在我之前的博客就已经有写了&#xff0c;所以…
阅读更多...
最新文章

Copyright @ 2022~2023