Spring Boot全局异常处理

女爷i 2024-03-16 21:42 53阅读 0赞

在开发Web应用程序时，异常处理是非常重要的。在Spring Boot中，我们可以使用全局异常处理器来捕获并处理应用程序中的异常。本文将介绍如何使用Spring Boot的全局异常处理器来处理应用程序中的异常。

### 什么是全局异常处理器？ ###

全局异常处理器是一个用于处理应用程序中未处理的异常的组件。当应用程序抛出未处理的异常时，全局异常处理器会捕获该异常并执行相应的操作，例如记录日志、返回错误信息等。

在Spring Boot中，我们可以通过实现 `ErrorController` 接口或使用 `@ControllerAdvice` 注解来创建全局异常处理器。

### 实现 ErrorController 接口 ###

实现 `ErrorController` 接口是一种创建全局异常处理器的方法。`ErrorController` 接口定义了一个 `getErrorPath()` 方法，该方法返回一个字符串，表示应用程序中发生异常时应该重定向到的路径。通过实现 `ErrorController` 接口，我们可以自定义异常处理逻辑。

下面是一个实现 `ErrorController` 接口的示例：

@RestController
    public class CustomErrorController implements ErrorController {
    
        @RequestMapping("/error")
        public String handleError(HttpServletRequest request) {
            // 获取异常信息
            Object status = request.getAttribute(RequestDispatcher.ERROR_STATUS_CODE);
            Object message = request.getAttribute(RequestDispatcher.ERROR_MESSAGE);
            Object exception = request.getAttribute(RequestDispatcher.ERROR_EXCEPTION);
    
            // 处理异常信息
            String errorMsg = String.format("Status: %s, Message: %s, Exception: %s", status, message, exception);
            // 记录日志
            log.error(errorMsg);
    
            // 返回错误信息
            return "Error: " + errorMsg;
        }
    
        @Override
        public String getErrorPath() {
            return "/error";
        }
    }

在上面的示例中，我们定义了一个 `CustomErrorController` 类，该类实现了 `ErrorController` 接口。`CustomErrorController` 类中的 `handleError()` 方法用于处理异常信息。当应用程序抛出未处理的异常时，Spring Boot会自动重定向到 `getErrorPath()` 方法返回的路径，即 `/error`，然后调用 `handleError()` 方法来处理异常信息。

### 使用 @ControllerAdvice 注解 ###

另一种创建全局异常处理器的方法是使用 `@ControllerAdvice` 注解。`@ControllerAdvice` 注解用于定义一个类，该类中的方法会在应用程序中抛出未处理的异常时被调用。我们可以使用 `@ExceptionHandler` 注解来指定要处理的异常类型。

下面是一个使用 `@ControllerAdvice` 注解创建全局异常处理器的示例：

@ControllerAdvice
    public class GlobalExceptionHandler {
    
        @ExceptionHandler(Exception.class)
        public ResponseEntity<String> handleException(Exception e) {
            // 记录日志
            log.error("Exception occurred: ", e);
    
            // 返回错误信息
            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("Internal Server Error");
        }
    }

在上面的示例中，我们定义了一个 `GlobalExceptionHandler` 类，并使用 `@ControllerAdvice` 注解将其标记为全局异常处理器。`GlobalExceptionHandler` 类中的 `handleException()` 方法用于处理应用程序中抛出的所有异常。当应用程序抛出未处理的异常时，Spring Boot会自动调用 `handleException()` 方法，并将异常对象作为参数传递给该方法。

### 自定义异常 ###

除了处理应用程序中的未处理异常之外，我们还可以自定义异常，并在全局异常处理器中处理这些异常。自定义异常可以帮助我们更好地组织代码，并提高代码的可读性和可维护性。

下面是一个自定义异常的示例：

public class MyException extends RuntimeException {
    
        public MyException(String message) {
            super(message);
        }
    }

在上面的示例中，我们定义了一个 `MyException` 类，该类继承自 `RuntimeException` 类。`MyException` 类中的构造方法接受一个字符串参数，该参数用于指定异常消息。

下面是一个在全局异常处理器中处理自定义异常的示例：

@ControllerAdvice
    public class GlobalExceptionHandler {
    
        @ExceptionHandler(MyException.class)
        public ResponseEntity<String> handleMyException(MyException e) {
            // 记录日志
            log.error("MyException occurred: ", e);
    
            // 返回错误信息
            return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(e.getMessage());
        }
    }

在上面的示例中，我们使用 `@ExceptionHandler` 注解来指定要处理的异常类型。当应用程序抛出 `MyException` 异常时，Spring Boot会自动调用 `handleMyException()` 方法，并将异常对象作为参数传递给该方法。

### 最佳实践 ###

在使用全局异常处理器时，有一些最佳实践需要注意：

*  尽量不要在全局异常处理器中抛出新的异常，因为这可能会导致异常循环。
 *  尽量不要在全局异常处理器中使用 `System.out.println()` 或 `System.err.println()` 等输出语句，因为这可能会干扰应用程序的正常输出。
 *  尽量不要在全局异常处理器中处理 `Error` 类型的异常，因为这可能会导致应用程序崩溃。

### 总结 ###

在本文中，我们介绍了如何使用Spring Boot的全局异常处理器来处理应用程序中的异常。我们讨论了两种创建全局异常处理器的方法：实现 `ErrorController` 接口和使用 `@ControllerAdvice` 注解。我们还介绍了如何自定义异常，并在全局异常处理器中处理这些异常。最后，我们提供了一些最佳实践，以帮助你更好地使用全局异常处理器。

全局异常处理器是Web应用程序开发中不可或缺的组件。它可以帮助我们更好地管理应用程序中的异常，并提高应用程序的可靠性和可维护性。

**公众号请关注"果酱桑", 一起学习,一起进步!**