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

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

ztj100 2024-12-15 18:01 11 浏览 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和自定义异常我们可以满足更多样化的需求。通过这些技术综合实现,我们可以构建出一套高效健壮的异常处理体系,来提升系统的稳定性和用户体验。

相关推荐

Whoosh,纯python编写轻量级搜索工具

引言在许多应用程序中,搜索功能是至关重要的。Whoosh是一个纯Python编写的轻量级搜索引擎库,可以帮助我们快速构建搜索功能。无论是在网站、博客还是本地应用程序中,Whoosh都能提供高效的全文搜...

如何用Python实现二分搜索算法(python二分法查找代码)

如何用Python实现二分搜索算法二分搜索(BinarySearch)是一种高效的查找算法,适用于在有序数组中快速定位目标值。其核心思想是通过不断缩小搜索范围,每次将问题规模减半,时间复杂度为(O...

路径扫描 -- dirsearch(路径查找器怎么使用)

外表干净是尊重别人,内心干净是尊重自己,干净,在今天这个时代,应该是一种极高的赞美和珍贵。。。----网易云热评一、软件介绍Dirsearch是一种命令行工具,可以强制获取web服务器中的目录和文件...

78行Python代码帮你复现微信撤回消息!

来源:悟空智能科技本文约700字,建议阅读5分钟。本文基于python的微信开源库itchat,教你如何收集私聊撤回的信息。...

从零开始学习 Python!2《进阶知识》 Python进阶之路

欢迎来到Python学习的进阶篇章!如果你说已经掌握了基础语法,那么这篇就是你开启高手之路的大门。我们将一起探讨面向对象编程...

白帽黑客如何通过dirsearch脚本工具扫描和收集网站敏感文件

一、背景介绍...

Python之txt数据预定替换word预定义定位标记生成word报告(四)

续接Python之txt数据预定替换word预定义定位标记生成word报告(一)https://mp.toutiao.com/profile_v4/graphic/preview?pgc_id=748...

假期苦短,我用Python!这有个自动回复拜年信息的小程序

...

Python——字符串和正则表达式中的反斜杠(&#39;\&#39;)问题详解

在本篇文章里小编给大家整理的是关于Python字符串和正则表达式中的反斜杠('\')问题以及相关知识点,有需要的朋友们可以学习下。在Python普通字符串中在Python中,我们用'\'来转义某些普通...

Python re模块:正则表达式综合指南

Python...

Python中re模块详解(rem python)

在《...

python之re模块(python re模块sub)

re模块一.re模块的介绍1.什么是正则表达式"定义:正则表达式是一种对字符和特殊字符操作的一种逻辑公式,从特定的字符中,用正则表达字符来过滤的逻辑。(也是一种文本模式;)2、正则表达式可以帮助我们...

MySQL、PostgreSQL、SQL Server 数据库导入导出实操全解

在数字化时代,数据是关键资产,数据库的导入导出操作则是连接数据与应用场景的桥梁。以下是常见数据库导入导出的实用方法及代码,包含更多细节和特殊情况处理,助你应对各种实际场景。一、MySQL数据库...

Zabbix监控系统系列之六:监控 mysql

zabbix监控mysql1、监控规划在创建监控项之前要尽量考虑清楚要监控什么,怎么监控,监控数据如何存储,监控数据如何展现,如何处理报警等。要进行监控的系统规划需要对Zabbix很了解,这里只是...

mysql系列之一文详解Navicat工具的使用(二)

本章内容是系列内容的第二部分,主要介绍Navicat工具的使用。若查看第一部分请见:...

取消回复欢迎 发表评论: