Spring Boot：优雅地处理全局异常以及格式化输出
原创Spring Boot：优雅地处理全局异常以及格式化输出
原创
前言
在Spring Boot应用程序中，全局异常处理是一种非常重要的功能。它可以帮助我们捕获未处理的异常，进行统一处理，并返回给客户端一个友好的错误信息。本文将介绍如何使用Spring Boot优雅地处理全局异常，并提供一些实用的代码示例。
正文内容
一. 使用@ControllerAdvice注解创建全局异常处理器
在Spring MVC中，我们可以使用@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(Exception.class)
public ResponseEntity<String> handleException(Exception e) {
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("服务器内部错误");
}
}在这个例子中，我们创建了一个名为GlobalExceptionHandler的全局异常处理器类，并使用@ControllerAdvice注解进行标注。在这个类中，我们定义了一个处理异常的方法handleException()，并使用@ExceptionHandler(Exception.class)注解指定该方法用于处理Exception类型的异常。
二. 处理特定类型的异常
除了处理所有类型的异常之外，我们还可以创建专门的方法来处理特定类型的异常。例如，我们可以创建一个方法来处理NullPointerException异常：
@ExceptionHandler(NullPointerException.class)
public ResponseEntity<String> handleNullPointerException(NullPointerException e) {
return ResponseEntity.status(HttpStatus.BAD_REQUEST).body("请求参数不能为空");
}三. 自定义异常类
为了更好地处理异常，我们可以创建自定义的异常类，并在需要的地方抛出这些异常。下面是一个简单的自定义异常类示例：
public class CustomException extends RuntimeException {
private static final long serialVersionUID = 1L;
public CustomException(String message) {
super(message);
}
}四. 在控制器中使用自定义异常
在控制器中，我们可以根据需要抛出自定义异常。例如：
@RestController
public class UserController {
@GetMapping("/users/{id}")
public User getUserById(@PathVariable Long id) {
if (id == null || id <= 0) {
throw new CustomException("用户ID必须为正数");
}
// ...其他逻辑代码
}
}五. 处理自定义异常
为了处理自定义异常，我们需要在全局异常处理器类中添加相应的方法。例如：
@ExceptionHandler(CustomException.class)
public ResponseEntity<String> handleCustomException(CustomException e) {
return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(e.getMessage());
}六. 返回自定义的错误响应
为了让客户端收到更友好的错误信息，我们可以创建一个自定义的错误响应类，并在全局异常处理器中使用这个类返回错误信息。例如：
public class ErrorResponse {
private int status;
private String message;
public ErrorResponse(int status, String message) {
this.status = status;
this.message = message;
}
// ...getter和setter方法
}然后，在全局异常处理器中使用ErrorResponse类返回错误信息：
@ExceptionHandler(CustomException.class)
public ResponseEntity<ErrorResponse> handleCustomException(CustomException e) {
ErrorResponse errorResponse = new ErrorResponse(HttpStatus.BAD_REQUEST.value(), e.getMessage());
return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(errorResponse);
}七、限制某些异常不进行全局处理
如果你想要限制某些类型的异常不进行全局处理，可以通过以下两种方式实现：
方法一：在@ExceptionHandler注解中使用exclude属性
在Spring 3.2版本之后，@ExceptionHandler注解增加了一个exclude属性，允许你排除某些类型的异常不进行处理。你可以在@ExceptionHandler注解中指定要排除的异常类型，如下所示：
@ControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(Exception.class)
public ResponseEntity<String> handleException(Exception e) {
if (e instanceof SomeSpecificException) {
// 不处理SomeSpecificException类型的异常
return null;
}
// 处理其他类型的异常
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("服务器内部错误");
}
// 其他处理方法...
}然而，这种方式并不是非常优雅，因为它要求你在处理方法内部进行类型检查和返回null。更好的方式是使用exclude属性直接在注解中排除不需要处理的异常类型。但是，需要注意的是，@ExceptionHandler注解本身并没有提供exclude属性。为了实现这个功能，你需要使用@ControllerAdvice的一个变体——@RestControllerAdvice，它允许你在类级别定义排除的异常类型。
@RestControllerAdvice(exclude = SomeSpecificException.class)
public class GlobalExceptionHandler {
@ExceptionHandler(Exception.class)
public ResponseEntity<String> handleException(Exception e) {
// 这个方法将不会处理SomeSpecificException类型的异常
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("服务器内部错误");
}
// 其他处理方法...
}方法二：创建多个异常处理器
另一种方法是创建多个异常处理器，每个处理器处理不同的异常集合。这样，你可以通过不包含特定异常类型的方法来间接排除它们。例如：
@ControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler({Exception.class, AnotherException.class})
public ResponseEntity<String> handleMultipleExceptions(Exception e) {
// 处理Exception和AnotherException类型的异常
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("服务器内部错误");
}
// 这个方法将不会处理SomeSpecificException类型的异常
}八、日志格式化输出
在全局异常处理中，实现日志的格式化输出可以帮助我们更好地了解异常发生时的上下文信息，从而便于调试和定位问题。以下是如何在全局异常处理中实现日志格式化输出的方法：
1. 引入依赖
首先，确保你的项目中已经引入了日志框架的依赖。以Logback为例，你需要在pom.xml文件中添加以下依赖：
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.2.3</version>
</dependency>2. 创建日志对象
在你的全局异常处理器类中，创建一个日志对象。通常，我们使用SLF4J作为日志门面，然后选择具体的日志实现（如Logback）。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@ControllerAdvice
public class GlobalExceptionHandler {
private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);
// ...其他代码
}3. 在异常处理方法中记录日志
在全局异常处理器的方法中，使用日志对象的error()方法记录异常信息。为了实现格式化输出，我们可以使用{}占位符，并将异常对象作为参数传递给error()方法。
@ExceptionHandler(Exception.class)
public ResponseEntity<String> handleException(Exception e) {
logger.error("服务器内部错误: {}", e.getMessage(), e);
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("服务器内部错误");
}在这个例子中，我们使用logger.error()方法记录了一个格式化的错误日志。{}占位符将被e.getMessage()的值替换，同时异常对象e也会被传递到日志方法中，以便在日志中包含异常的堆栈跟踪信息。
4. 配置日志格式
为了更好地控制日志的输出格式，我们可以在src/main/resources目录下创建一个名为logback-spring.xml的文件，用于配置Logback日志框架。在这个文件中，我们可以定义日志的输出格式和级别。
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<include resource="org/springframework/boot/logging/logback/base.xml"/>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
<root level="INFO">
<appender-ref ref="STDOUT"/>
</root>
</configuration>在这个配置文件中，我们定义了一个名为STDOUT的控制台输出器，并设置了日志的输出格式。%d{yyyy-MM-dd HH:mm:ss.SSS}表示日期和时间，%thread表示线程名称，%-5level表示日志级别（左对齐），%logger{36}表示日志输出器名称（截取前36个字符），%msg表示日志消息，%n表示换行符。
总结
本文介绍了如何使用Spring Boot优雅地处理全局异常。通过创建全局异常处理器类并使用@ControllerAdvice和@ExceptionHandler注解，我们可以轻松地捕获和处理各种异常。同时，我们还介绍了如何创建自定义异常类并返回自定义的错误响应。希望本文的内容能帮助您更好地处理Spring Boot应用程序中的全局异常。
原创声明：本文系作者授权腾讯云开发者社区发表，未经许可，不得转载。
如有侵权，请联系 cloudcommunity@tencent.com 删除。
原创声明：本文系作者授权腾讯云开发者社区发表，未经许可，不得转载。
如有侵权，请联系 cloudcommunity@tencent.com 删除。
腾讯云开发者
