从原理到实践：SpringBoot如何优雅处理全局异常？

🎓博主介绍：Java、Python、js全栈开发 “多面手”，精通多种编程语言和技术，痴迷于人工智能领域。秉持着对技术的热爱与执着，持续探索创新，愿在此分享交流和学习，与大家共进步。
📖DeepSeek-行业融合之万象视界(附实战案例详解100+)
📖全栈开发环境搭建运行攻略：多语言一站式指南(环境搭建+运行+调试+发布+保姆级详解)
👉感兴趣的可以先收藏起来，希望帮助更多的人

从原理到实践：SpringBoot如何优雅处理全局异常？

一、引言

在开发Spring Boot应用程序时，异常处理是一个不可忽视的重要环节。当应用程序运行过程中出现异常时，如果没有进行合理的处理，不仅会影响用户体验，还可能暴露系统的内部信息，给系统带来安全风险。因此，优雅地处理全局异常是提高应用程序健壮性和可维护性的关键。本文将从原理出发，详细介绍Spring Boot中全局异常处理的方法，并通过实践案例进行演示。

二、Spring Boot异常处理的基本原理

2.1 异常的分类

在Java中，异常主要分为两类：受检查异常（Checked Exception）和非受检查异常（Unchecked Exception）。受检查异常是指在编译时必须进行处理的异常，如IOException、SQLException等；非受检查异常是指在编译时不需要进行处理的异常，如RuntimeException及其子类。

2.2 Spring Boot的异常处理机制

Spring Boot基于Spring框架的异常处理机制，提供了多种方式来处理异常。其中，最常用的是使用@ControllerAdvice和@ExceptionHandler注解来实现全局异常处理。@ControllerAdvice是一个特殊的@Component，用于定义@ExceptionHandler、@InitBinder和@ModelAttribute方法，这些方法将应用于所有使用@RequestMapping注解的控制器。@ExceptionHandler注解用于处理特定类型的异常。

三、Spring Boot全局异常处理的实践步骤

3.1 创建自定义异常类

为了更好地管理异常，我们可以创建自定义异常类。以下是一个简单的自定义异常类的示例：

public class CustomException extends RuntimeException {
    private int code;

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

    public int getCode() {
        return code;
    }
}

3.2 创建全局异常处理器

使用@ControllerAdvice和@ExceptionHandler注解创建全局异常处理器。以下是一个示例：

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;

@ControllerAdvice
public class GlobalExceptionHandler {

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

    @ExceptionHandler(Exception.class)
    public ResponseEntity<ErrorResponse> handleGeneralException(Exception ex) {
        ErrorResponse errorResponse = new ErrorResponse(500, "Internal Server Error");
        return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

在上述代码中，handleCustomException方法用于处理CustomException异常，handleGeneralException方法用于处理其他所有类型的异常。

3.3 创建错误响应类

为了统一异常响应的格式，我们可以创建一个错误响应类。以下是一个示例：

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

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

    public int getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }
}

3.4 在控制器中抛出异常

在控制器中抛出自定义异常，测试全局异常处理功能。以下是一个示例：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {

    @GetMapping("/test")
    public String test() {
        throw new CustomException(400, "This is a custom exception");
    }
}

四、高级应用：异常日志记录和异常信息国际化

4.1 异常日志记录

在全局异常处理器中添加日志记录功能，方便后续排查问题。以下是一个示例：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;

@ControllerAdvice
public class GlobalExceptionHandler {

    private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);

    @ExceptionHandler(CustomException.class)
    public ResponseEntity<ErrorResponse> handleCustomException(CustomException ex) {
        logger.error("CustomException occurred: code={}, message={}", ex.getCode(), ex.getMessage(), ex);
        ErrorResponse errorResponse = new ErrorResponse(ex.getCode(), ex.getMessage());
        return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
    }

    @ExceptionHandler(Exception.class)
    public ResponseEntity<ErrorResponse> handleGeneralException(Exception ex) {
        logger.error("General exception occurred", ex);
        ErrorResponse errorResponse = new ErrorResponse(500, "Internal Server Error");
        return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

4.2 异常信息国际化

为了支持多语言环境，我们可以使用Spring的国际化功能来处理异常信息。以下是一个示例：

import org.springframework.context.MessageSource;
import org.springframework.context.i18n.LocaleContextHolder;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;

@ControllerAdvice
public class GlobalExceptionHandler {

    private final MessageSource messageSource;

    public GlobalExceptionHandler(MessageSource messageSource) {
        this.messageSource = messageSource;
    }

    @ExceptionHandler(CustomException.class)
    public ResponseEntity<ErrorResponse> handleCustomException(CustomException ex) {
        String message = messageSource.getMessage("custom.exception.message", null, LocaleContextHolder.getLocale());
        ErrorResponse errorResponse = new ErrorResponse(ex.getCode(), message);
        return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
    }
}

在上述代码中，messageSource.getMessage方法用于根据当前的Locale获取国际化的异常信息。

五、总结

通过本文的介绍，我们了解了Spring Boot异常处理的基本原理，并掌握了使用@ControllerAdvice和@ExceptionHandler注解实现全局异常处理的方法。同时，我们还介绍了异常日志记录和异常信息国际化等高级应用。在实际开发中，合理地处理全局异常可以提高应用程序的健壮性和可维护性，为用户提供更好的体验。