如何在Spring MVC中使用@ControllerAdvice创建全局异常处理器

news2024/9/25 9:37:31

文章目录

  • 前言
  • 一、认识注解:@RestControllerAdvice和@ExceptionHandler
  • 二、使用步骤
    • 1、封装统一返回结果类
    • 2、自定义异常类封装
    • 3、定义全局异常处理类
    • 4、测试
  • 总结


前言

全局异常处理器是一种 🌟✨机制,用于处理应用程序中发生的异常,无论这些异常在哪个部分发生。它可以拦截和处理整个应用程序范围内的异常,从而实现统一的异常处理逻辑。😊
在一个应用程序中,可能会有多个控制器处理不同的请求。当这些控制器中抛出异常时,可以使用全局异常处理器来捕获和处理这些异常,而不是在每个控制器中单独处理。⚡💪
全局异常处理器通常在应用程序的顶层进行定义,以确保能够拦截所有的异常。它可以捕获和处理各种类型的异常,包括应用程序自定义的异常、系统异常和未处理的异常。🎯🔍
使用全局异常处理器的好处包括:💡🎉
统一异常处理:全局异常处理器可以集中处理所有控制器中出现的异常,避免重复的异常处理代码,提高代码的可维护性和复用性。🙌
自定义异常响应:通过全局异常处理器,可以定义统一的异常响应格式和错误码,使异常的处理更加符合应用的需求。💼📊
防止泄露敏感信息:全局异常处理器可以捕获并处理未处理的异常,确保不会向客户端返回敏感信息,同时返回适当的异常信息。🔒🙅‍♂️
在Spring MVC中,可以使用@ControllerAdvice或@RestControllerAdvice注解来定义全局异常处理器类,并使用 @ExceptionHandler注解来定义处理特定异常的方法。这些方法可以在全局异常处理器类中进行集中管理,提供统一的异常处理逻辑。📚💻
希望这样的回答给你带来了一些乐趣和激励!如果你有其他问题,我会很乐意回答。😊🌈


一、认识注解:@RestControllerAdvice和@ExceptionHandler

当涉及到全局异常处理时,两个重要的注解被广泛使用:@RestControllerAdvice和@ExceptionHandler。
下面是对这两个注解的解释:
@RestControllerAdvice:
(这里插一句:如果你的应用程序使用传统的Web应用程序架构(使用视图解析器渲染视图),则可以使用@ControllerAdvice。而如果你的应用程序是RESTful风格的应用程序,需要直接返回JSON或其他格式的响应体,那么可以使用@RestControllerAdvice。)
@RestControllerAdvice是一个用于定义全局异常处理器的注解。通过将此注解应用于一个类上,该类可以成为一个全局异常处理器。在这个处理器中,你可以定义通用的异常处理逻辑,用于捕获和处理应用程序中的各种异常情况。
@RestControllerAdvice注解的主要作用是:
提供全局异常处理逻辑,捕获应用程序中未被处理的异常。
允许在多个控制器类中共享相同的异常处理逻辑。
可以组合使用其他注解,如@ExceptionHandler、@InitBinder和@ModelAttribute。
@ExceptionHandler:
@ExceptionHandler是一个用于定义特定异常处理方法的注解。通过将此注解应用于处理器类中的方法上,该方法可以被用于处理特定类型的异常。这样,当应用程序抛出匹配的异常时,该方法将被自动调用以处理该异常。
@ExceptionHandler注解的主要作用是:
定义特定异常的处理逻辑,捕获应用程序中抛出的特定类型的异常。
提供更精细的异常处理机制,根据不同的异常类型执行不同的处理代码。
可以在同一个全局异常处理器类中定义多个@ExceptionHandler方法,以处理不同类型的异常。

二、使用步骤

1、封装统一返回结果类

定义返回结果类:后端统一返回结果:


import lombok.Data;

import java.io.Serializable;

/**
 * 后端统一返回结果
 * @param <T>
 */
@Data
public class Result<T> implements Serializable {

    private Integer code; //编码:1成功,0和其它数字为失败
    private String msg; //错误信息
    private T data; //数据

    public static <T> Result<T> success() {
        Result<T> result = new Result<T>();
        result.code = 1;
        return result;
    }

    public static <T> Result<T> success(T object) {
        Result<T> result = new Result<T>();
        result.data = object;
        result.code = 1;
        return result;
    }

    public static <T> Result<T> error(String msg) {
        Result result = new Result();
        result.msg = msg;
        result.code = 0;
        return result;
    }

}

2、自定义异常类封装

封装自定义异常类,用于自定义异常抛出,根据实际情况对业务异常进行更细致和明确的拓展
先定义基础异常类:

/**
 * 业务异常
 */
public class BaseException extends RuntimeException {

    public BaseException() {
    }

    public BaseException(String msg) {
        super(msg);
    }

}

再定义自定义异常类:


public class UserNotLoginException extends BaseException {

    public UserNotLoginException() {
    }

    public UserNotLoginException(String msg) {
        super(msg);
    }

}

3、定义全局异常处理类

统一捕获异常:


import com.example.result.Result;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice
public class GlobalExceptionHandler {
    /**
     * 捕获业务异常
     */
    @ExceptionHandler
    public Result<?> exceptionHandler(BaseException ex){
        return Result.error(ex.getMessage());
    }
	/**
     * 捕获除数为0异常
     */
    @ExceptionHandler
    public Result<?> exceptionHandler(ArithmeticException ex){
        return Result.error("分母不能为0");
    }
    /**
     * 根据异常类型和业务需求,以以下格式继续完善代码
     */
}

根据异常类型和业务需求,可以以以下格式继续完善代码:

 @ExceptionHandler
    public Result<?> exceptionHandler(异常类型 ex){
        return Result.error("异常类型信息");
    }

4、测试

import com.example.result.Result;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class webTest {
	/**
     * 测试捕获业务异常
     */
    @GetMapping("/aa/{id}")
    public Result<?> aa(@PathVariable Long id){
        if(id<2)
            throw new UserNotLoginException("密码错误");
        return Result.success("成功");
    }
    /**
     * 测试捕获除数为0异常
     */
    @GetMapping("/bb")
    public Result<?> bb(){
        int a = 1/0;
        return Result.success("成功");
    }

在这里插入图片描述
在这里插入图片描述
通过以上测试,产生的异常都被全局异常处理器捕获了!!搞定!!!

总结

@作者:加辣椒了吗?
简介:憨批大学生一枚,喜欢在博客上记录自己的学习心得,也希望能够帮助到你们!
在这里插入图片描述

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

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

相关文章

使用mybatis-plus的updateById方法更新一个numeric(1)类型字段,sql成功执行,但是updates为0,更新失败的解决办法

使用mybatis-plus的updateById方法更新一个numeric(1)类型字段&#xff0c;sql成功执行&#xff0c;但是updates为0&#xff0c;更新失败的解决办法&#xff1a; 背景&#xff1a;我有一张表&#xff0c;有个启用禁用功能&#xff0c;没有放在编辑页面一起编辑保存&#xff0c;…

使用sysbench对mysql数据库进行基准测试

目录 一、 安装sysbench 二、准备测试表及数据 三、开始测试 1、测试综合TPS 2、只读性能 oltp_read_only 3、删除性能 oltp_delete 4、更新索引字段性能 oltp_update_index 5、更新非索引字段性能 oltp_update_non_index 6、插入性能 oltp_insert 7、写入性能 ol…

SpringBoot Web开发静态资源处理

Web开发探究 简介 其实SpringBoot的东西用起来非常简单&#xff0c;因为SpringBoot最大的特点就是自动装配 使用SpringBoot的步骤&#xff1a; 1、创建一个SpringBoot应用&#xff0c;选择我们需要的模块&#xff0c;SpringBoot就会默认将我们的需要的模块自动配置好 2、手动…

湘大oj1138爱你一生一世题解:最大公约数 逆向思维 int整除会向下取整

一、链接 爱你一生一世 二、题目 题目描述 在2013年1月4日&#xff0c;这个“爱你一生一世”的特别日子&#xff0c;男生都想向自己的喜欢的女生表达爱意。 你准备在该死的C语言考试后&#xff0c;去向她&#xff08;或者他&#xff1f;&#xff09;告白。告白怎么能缺了礼…

八大排序

目录 选择排序-直接插入排序 插入排序-希尔排序 选择排序-简单选择排序 选择排序-堆排序 交换排序-冒泡排序 交换排序-快速排序 归并排序 基数排序 选择排序-直接插入排序 基本思想: 如果碰见一个和插入元素相等的&#xff0c;那么插入元素把想插入的元素放在相等元素…

如何高效地阅读 Python 代码?

原文首发于&#xff1a;如何高效地阅读 Python 代码&#xff1f; | 今是昨非 | 技术.生活.阅读.思考 副标题&#xff1a;一个重要但很少被讨论的技能 从网上看到这篇英文文章&#xff0c;感觉还不错&#xff0c;翻译了一下。Claude2 也有参与翻译&#x1f61d; AI摘要 这篇文…

Linux基础与拓展

文章目录 虚拟机网络连接方式VIMvi和vim常用的三种模式各种模式的相互切换快捷键 用户管理权限 基本介绍&#xff1a;添加用户指定/修改密码删除用户切换用户用户组 路径命令学习mkdir命令介绍语法注意 touch 创建文件介绍语法 cat 查看文件内容介绍语法 more 查看文件内容介绍…

vue3报错

这是因为eslint对代码的要求严格导致的&#xff0c;可以在package.json里面删掉"eslint:recommended"&#xff0c;然后重启就可以正常运行了

软件编程专业:探索计算机世界的奥秘

软件编程专业&#xff1a;探索计算机世界的奥秘 随着科技的飞速发展&#xff0c;计算机已经渗透到我们生活的方方面面。我们每天都在使用各种应用程序&#xff0c;比如社交媒体、游戏和电子邮件等&#xff0c;而这些应用程序背后的魔法都是由软件编程专业的人创造的。那么&…

Android 面试重点之Framework (Handler篇)

近期在网上看到不少Android 开发分享的面试经验&#xff0c;我发现基本每个面经中多多少少都有Framework 底层原理的影子。它也是Android 开发中最重要的一个部分&#xff0c;面试官一般会通过 Framework底层中的一些逻辑原理由浅入深进行提问&#xff0c;来评估应聘者的真实水…

idea - 刷新 Git 分支数据 / 命令刷新 Git 分支数据

一、idea - 刷新 Git 分支数据 idea 找到 fetch 选项&#xff0c;重新获取分支数据 二、命令刷新 Git 分支数据 git fetch参考链接 1. 远程Gitlab新建的分支在IDEA里不显示

Python-OpenCV中的图像处理-边缘检测

Python-OpenCV中的图像处理-边缘检测 边缘检测Canny算子 边缘检测Canny算子 Canny 边缘检测是一种非常流行的边缘检测算法&#xff0c;是 John F.Canny 在 1986 年提出的。它是一个有很多步构成的算法&#xff1a;噪声去除、计算图像梯度、非极大值抑制、滞后阀值等。 Canny(i…

kubernetes中最小组件——Pod

目录 一、Pod简介 二、Pod的使用方式 三、Pause——Pod中底层基础容器 四、为什么kubernetes这样设计Pod 五、Pod的分类 1.自主式Pod 2.控制器管理的Pod 3.静态Pod 六、Pod容器的分类 1. 基础容器&#xff08;infrastructure container&#xff09; 2. 初始化容器&am…

软件测试-------Web(性能测试 / 界面测试 / 兼容性测试 / 安全性测试)

Web&#xff08;性能测试 / 界面测试 / 兼容性测试 / 安全性测试&#xff09; 一、Web性能测试&#xff1a;&#xff08;压力测试、负载测试、连接速度测试&#xff09;1、压力测试&#xff1a;      并发测试 &#xff08;如500人同时登录邮箱&#xff09; 2、负载测试…

手机开启应急预警通知 / 地震预警

前言 安卓手机在检测到地震时&#xff0c;将发送地震预警通知&#xff0c;但此设置是默认关闭的&#xff0c;原因是以防引发用户恐慌从而引发安全问题&#xff0c;且开启此设置需要完成指引教程&#xff0c;因此默认关闭此设置。下文介绍如何开启此设置。 开启方法 华为手机开…

layui的基本使用-日期控件的业务场景使用入门实战案例一

效果镇楼; 1 前端UI层面; <!DOCTYPE html> <html lang="en"> <head><meta charset="UTF-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" conten…

SuperMap GIS基础产品云GIS FAQ集锦(5)

SuperMap GIS基础产品云GIS FAQ集锦&#xff08;5&#xff09; 【iServer】如何开启密码防暴力破解&#xff1f; 【解决办法】管理员可以在“安全配置”页面设置是否启用防暴力破解设置&#xff08;默认未启用&#xff09;&#xff0c;并可自定义修改锁定周期、允许失败次数等参…

flutter-第三方组件

卡片折叠 stacked_card_carousel 扫一扫组件 qr_code_scanner 权限处理组件 permission_handler 生成二维码组件 pretty_qr_code 角标组件 badges 动画组件 animations app更新 app_installer 带缓存的图片组件 cached_network_image 密码输入框 collection 图片保存 image_g…

Kubernetes集群部署上篇(安装部署,但是集群网络未部署)

第四阶段 时 间&#xff1a;2023年8月9日 参加人&#xff1a;全班人员 内 容&#xff1a; Kubernetes集群部署上篇 目录 一、Kubernetes部署方式 &#xff08;一&#xff09;minikube &#xff08;二&#xff09;二进制包 &#xff08;三&#xff09;Kubeadm Kubea…

centos7.9究极法-基础篇

centos7.9 前言Linux发行版本帮助命令man命令help命令 文件目录管理命令ls命令pwd命令cd命令mkdir命令cp命令scp命令rm命令mv命令chmod命令chown命令 文本内容管理命令cat命令echo命令less命令tail命令 用户和组管理命令useradd命令userdel命令passwd命令usermod命令groupadd命…