百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术分类 > 正文

Spring Boot中的全局异常处理机制详解

ztj100 2024-12-15 18:01 22 浏览 0 评论

在Web开发中,能够有一个统一的异常处理机制会为整个的Web应用程序的稳定性和用户体验带来很大的帮助。而在Spring Boot中也提供了非常强大的异常处理机制们可以优雅的实现对于异常的捕获了处理,在提升代码维护性的同时也可以很好的提升用户体验。下面我们就来详细的介绍一下Spring Boot中的全局异常处理机制。

为什么需要全局异常处理?

在开发过程中,可能会遇到各种的需要进行异常处理的场景,而在整个的Web项目中包含了很多的模块,如果每个模块都进行单独的异常处理,那么就会导致代码的冗余,并且代码将会变的非常难维护。而全局异常处理机制就可以提供一整套完整的全局异常处理逻辑,可以减少代码冗余,提供统一的异常响应处理,也可以让开发者更好的统计异常快速定位问题。

Spring Boot 中的异常处理方式

在SpringBoot中提供了很多的异常处理方式,如下所示。

使用@ExceptionHandler注解

@ExceptionHandler注解主要是用来对特定异常进行处理,与@Controller或@RestController注解一起使用来处理各种控制器异常捕获,如下所示。

@RestController
public class DemoController {

    @GetMapping("/test")
    public String test() {
        throw new IllegalArgumentException("非法参数异常");
    }

    @ExceptionHandler(IllegalArgumentException.class)
    public ResponseEntity<String> handleIllegalArgumentException(IllegalArgumentException ex) {
        return new ResponseEntity<>("错误信息: " + ex.getMessage(), HttpStatus.BAD_REQUEST);
    }
}

通过简单的方式来处理控制器内的异常,但是没有办法对全局的异常进行捕获。

使用@ControllerAdvice和@RestControllerAdvice

@ControllerAdvice是在Spring中所提供的用来进行全局异常处理的注解,专门用于捕获@Controller层的异常。如果是是RESTful风格的接口(JSON 响应)的异常,则可以通过@RestControllerAdvice注解实现。如下所示。

@RestControllerAdvice
public class GlobalExceptionHandler {

    // 捕获特定异常
    @ExceptionHandler(IllegalArgumentException.class)
    public ResponseEntity<String> handleIllegalArgumentException(IllegalArgumentException ex) {
        return new ResponseEntity<>("非法参数: " + ex.getMessage(), HttpStatus.BAD_REQUEST);
    }

    // 捕获所有异常
    @ExceptionHandler(Exception.class)
    public ResponseEntity<String> handleException(Exception ex) {
        return new ResponseEntity<>("服务器内部错误: " + ex.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

用于统一处理所有控制器中的异常,可以针对不同的异常返回不同的响应结果,但是需要手动配置各种异常处理器方法,比较麻烦。

使用ResponseEntityExceptionHandler

ResponseEntityExceptionHandler也是在Spring框架中提供的异常处理基类,默认实现了对很多常见异常,例如HttpRequestMethodNotSupportedException等的处理。我们可以通过继承这个类并重写其方法,来实现自定义异常处理逻辑,如下所示。

@RestControllerAdvice
public class CustomExceptionHandler extends ResponseEntityExceptionHandler {

    @Override
    protected ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException ex,
                                                                  HttpHeaders headers,
                                                                  HttpStatus status,
                                                                  WebRequest request) {
        String errorMessage = ex.getBindingResult().getAllErrors().get(0).getDefaultMessage();
        return new ResponseEntity<>("参数验证失败: " + errorMessage, HttpStatus.BAD_REQUEST);
    }
}

可以直接复用Spring默认的异常处理逻辑,所以比较适合处理一些验证类的异常处理,但是这个异常处理只适用于Spring中定义的异常。

自定义异常和统一响应格式

为了让异常响应更具结构化和可读性,我们可以通过定义一个统一的错误响应类,以及自定义异常类来对异常处理进行封装,如下所示。

统一响应类

public class ErrorResponse {
    private int code;
    private String message;
    private LocalDateTime timestamp;

    // 构造方法、Getter和Setter
    public ErrorResponse(int code, String message) {
        this.code = code;
        this.message = message;
        this.timestamp = LocalDateTime.now();
    }
}

自定义异常类

public class BusinessException extends RuntimeException {
    private int code;

    public BusinessException(int code, String message) {
        super(message);
        this.code = code;
    }

    public int getCode() {
        return code;
    }
}

全局处理逻辑

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(BusinessException.class)
    public ResponseEntity<ErrorResponse> handleBusinessException(BusinessException ex) {
        ErrorResponse errorResponse = new ErrorResponse(ex.getCode(), ex.getMessage());
        return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
    }

    @ExceptionHandler(Exception.class)
    public ResponseEntity<ErrorResponse> handleGenericException(Exception ex) {
        ErrorResponse errorResponse = new ErrorResponse(500, "服务器内部错误");
        return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

总结

在Spring Boot中提供了很多的全局异常处理机制,其中@ExceptionHandler 适合局部处理。@ControllerAdvice或@RestControllerAdvice则是比较适合全局异常管理,通过结合ResponseEntityExceptionHandler和自定义异常我们可以满足更多样化的需求。通过这些技术综合实现,我们可以构建出一套高效健壮的异常处理体系,来提升系统的稳定性和用户体验。

相关推荐

Sublime Text 4 稳定版 Build 4113 发布

IT之家7月18日消息知名编辑器SublimeText4近日发布了Build4113版本,是SublimeText4的第二个稳定版。IT之家了解到,SublimeTe...

【小白课程】openKylin便签贴的设计与实现

openKylin便签贴作为侧边栏的一个小插件,提供便捷的文本记录和灵活的页面展示。openKylin便签贴分为两个部分:便签列表...

“告别 Neovim!为什么我投奔了刚开源的 Zed 编辑器?”

...

壹啦罐罐 Android 手机里的 Xposed 都装了啥

这是少数派推出的系列专题,叫做「我的手机里都装了啥」。这个系列将邀请到不同的玩家,从他们各自的角度介绍手机中最爱的或是日常使用最频繁的App。文章将以「每周一篇」的频率更新,内容范围会包括iOS、...

电气自动化专业词汇中英文对照表(电气自动化专业英语单词)

专业词汇中英文对照表...

Python界面设计Tkinter模块的核心组件

我们使用一个模块,我们要熟悉这个模块的主要元件。如我们设计一个窗口,我们可以用Tk()来完成创建;一些交互元素,按钮、标签、编辑框用到控件;怎么去布局你的界面,我们可以用到pack()、grid()...

以色列发现“死海古卷”新残片(死海古卷是真的吗)

编译|陈家琦据艺术新闻网(artnews.com)报道,3月16日,以色列考古学家发现了死海古卷(DeadSeaScrolls)新残片。新出土的羊皮纸残片中包括以希腊文书写的《十二先知书》段落,这...

鸿蒙Next仓颉语言开发实战教程:订单列表

大家上午好,最近不断有友友反馈仓颉语言和ArkTs很像,所以要注意不要混淆。今天要分享的是仓颉语言开发商城应用的订单列表页。首先来分析一下这个页面,它分为三大部分,分别是导航栏、订单类型和订单列表部分...

哪些模块可以用在 Xposed for Lollipop 上?Xposed 模块兼容性解答

虽然已经有了XposedforLollipop的安装教程,但由于其还处在alpha阶段,一些Xposed模块能不能依赖其正常工作还未可知。为了解决大家对于模块兼容性的疑惑,笔者尽可能多...

利用 Fluid 自制 Mac 版 Overcast 应用

我喜爱收听播客,健身、上/下班途中,工作中,甚至是忙着做家务时。大多数情况下我会用MarcoArment开发的Overcast(Freemium)在iPhone上收听,这是我目前最喜爱的Po...

Avalonia日志组件实现与优化指南(ar日志表扣)

...

浅色Al云食堂APP代码(三)(手机云食堂)

以下是进一步优化完善后的浅色AI云食堂APP完整代码,新增了数据可视化、用户反馈、智能推荐等功能,并优化了代码结构和性能。项目结构...

实战PyQt5: 121-使用QImage实现一个看图应用

QImage简介QImage类提供了独立于硬件的图像表示形式,该图像表示形式可以直接访问像素数据,并且可以用作绘制设备。QImage是QPaintDevice子类,因此可以使用QPainter直接在图...

滚动条隐藏及美化(滚动条隐藏但是可以滚动)

1、滚动条隐藏背景/场景:在移动端,滑动的时候,会显示默认滚动条,如图1://隐藏代码:/*隐藏滚轮*/.ul-scrool-box::-webkit-scrollbar,.ul-scrool...

浅色AI云食堂APP完整代码(二)(ai 食堂)

以下是整合后的浅色AI云食堂APP完整代码,包含后端核心功能、前端界面以及优化增强功能。项目采用Django框架开发,支持库存管理、订单处理、财务管理等核心功能,并包含库存预警、数据导出、权限管理等增...

取消回复欢迎 发表评论: