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

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

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

相关推荐

SpringBoot如何实现优雅的参数校验
SpringBoot如何实现优雅的参数校验

平常业务中肯定少不了校验,如果我们把大量的校验代码夹杂到业务中,肯定是不优雅的,对于一些简单的校验,我们可以使用java为我们提供的api进行处理,同时对于一些...

2025-05-11 19:46 ztj100

Java中的空指针怎么处理?

#暑期创作大赛#Java程序员工作中遇到最多的错误就是空指针异常,无论你多么细心,一不留神就从代码的某个地方冒出NullPointerException,令人头疼。...

一坨一坨 if/else 参数校验,被 SpringBoot 参数校验组件整干净了

来源:https://mp.weixin.qq.com/s/ZVOiT-_C3f-g7aj3760Q-g...

用了这两款插件,同事再也不说我代码写的烂了

同事:你的代码写的不行啊,不够规范啊。我:我写的代码怎么可能不规范,不要胡说。于是同事打开我的IDEA,安装了一个插件,然后执行了一下,规范不规范,看报告吧。这可怎么是好,这玩意竟然给我挑出来这么...

SpringBoot中6种拦截器使用场景

SpringBoot中6种拦截器使用场景,下面是思维导图详细总结一、拦截器基础...

用注解进行参数校验,spring validation介绍、使用、实现原理分析

springvalidation是什么在平时的需求开发中,经常会有参数校验的需求,比如一个接收用户注册请求的接口,要校验用户传入的用户名不能为空、用户名长度不超过20个字符、传入的手机号是合法的手机...

快速上手:SpringBoot自定义请求参数校验

作者:UncleChen来源:http://unclechen.github.io/最近在工作中遇到写一些API,这些API的请求参数非常多,嵌套也非常复杂,如果参数的校验代码全部都手动去实现,写起来...

分布式微服务架构组件

1、服务发现-Nacos服务发现、配置管理、服务治理及管理,同类产品还有ZooKeeper、Eureka、Consulhttps://nacos.io/zh-cn/docs/what-is-nacos...

优雅的参数校验,告别冗余if-else

一、参数校验简介...

Spring Boot断言深度指南:用断言机制为代码构筑健壮防线

在SpringBoot开发中,断言(Assert)如同代码的"体检医生",能在上线前精准捕捉业务逻辑漏洞。本文将结合企业级实践,解析如何通过断言机制实现代码自检、异常预警与性能优化三...

如何在项目中优雅的校验参数

本文看点前言验证数据是贯穿所有应用程序层(从表示层到持久层)的常见任务。通常在每一层实现相同的验证逻辑,这既费时又容易出错。为了避免重复这些验证,开发人员经常将验证逻辑直接捆绑到域模型中,将域类与验证...

SpingBoot项目使用@Validated和@Valid参数校验

一、什么是参数校验?我们在后端开发中,经常遇到的一个问题就是入参校验。简单来说就是对一个方法入参的参数进行校验,看是否符合我们的要求。比如入参要求是一个金额,你前端没做限制,用户随便过来一个负数,或者...

28个验证注解,通过业务案例让你精通Java数据校验(收藏篇)

在现代软件开发中,数据验证是确保应用程序健壮性和可靠性的关键环节。JavaBeanValidation(JSR380)作为一个功能强大的规范,为我们提供了一套全面的注解工具集,这些注解能够帮...

Springboot @NotBlank参数校验失效汇总

有时候明明一个微服务里的@Validated和@NotBlank用的好好的,但就是另一个里不能用,这时候问题是最不好排查的,下面列举了各种失效情况的汇总,供各位参考:1、版本问题springbo...

这可能是最全面的Spring面试八股文了

Spring是什么?Spring是一个轻量级的控制反转(IoC)和面向切面(AOP)的容器框架。...

取消回复欢迎 发表评论: