跳到主要内容

全局异常处理

介绍​

在开发 Spring Cloud Alibaba 应用程序时，异常处理是一个非常重要的环节。如果没有统一的异常处理机制，代码中可能会出现大量的 try-catch 块，导致代码冗余且难以维护。全局异常处理可以帮助我们集中管理异常，避免重复代码，并提供统一的错误响应格式。

全局异常处理的核心思想是通过 Spring 的 @ControllerAdvice 和 @ExceptionHandler 注解，捕获应用程序中抛出的异常，并返回统一的错误信息。这样，无论是业务逻辑中的异常，还是框架层面的异常，都可以被统一处理。

实现全局异常处理​

1. 创建全局异常处理类​

首先，我们需要创建一个全局异常处理类，并使用 @ControllerAdvice 注解标记它。这个类将负责捕获和处理应用程序中的所有异常。

java
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.context.request.WebRequest;

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public ResponseEntity<?> handleGlobalException(Exception ex, WebRequest request) {
        ErrorDetails errorDetails = new ErrorDetails(new Date(), ex.getMessage(), request.getDescription(false));
        return new ResponseEntity<>(errorDetails, HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

在这个例子中，@ExceptionHandler(Exception.class) 表示该方法将处理所有类型的异常。ErrorDetails 是一个自定义的类，用于封装错误信息。

2. 定义错误响应格式​

为了返回统一的错误响应格式，我们可以定义一个 ErrorDetails 类：

java
import java.util.Date;

public class ErrorDetails {
    private Date timestamp;
    private String message;
    private String details;

    public ErrorDetails(Date timestamp, String message, String details) {
        this.timestamp = timestamp;
        this.message = message;
        this.details = details;
    }

    // Getters and Setters
}

3. 处理特定异常​

除了处理所有异常外，我们还可以为特定的异常定义处理方法。例如，处理 ResourceNotFoundException：

java
@ExceptionHandler(ResourceNotFoundException.class)
public ResponseEntity<?> handleResourceNotFoundException(ResourceNotFoundException ex, WebRequest request) {
    ErrorDetails errorDetails = new ErrorDetails(new Date(), ex.getMessage(), request.getDescription(false));
    return new ResponseEntity<>(errorDetails, HttpStatus.NOT_FOUND);
}

4. 测试全局异常处理​

假设我们有一个简单的 REST 控制器：

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

@RestController
public class UserController {

    @GetMapping("/users/{id}")
    public String getUser(@PathVariable Long id) {
        if (id == 1) {
            throw new ResourceNotFoundException("User not found with id " + id);
        }
        return "User found";
    }
}

当我们访问 /users/1 时，由于用户不存在，会抛出 ResourceNotFoundException，全局异常处理类会捕获这个异常，并返回如下 JSON 响应：

json
{
  "timestamp": "2023-10-01T12:00:00.000+00:00",
  "message": "User not found with id 1",
  "details": "uri=/users/1"
}

实际应用场景​

在实际开发中，全局异常处理可以应用于以下场景：

  1. 统一错误响应格式：所有异常都返回相同的 JSON 结构，便于前端处理。
  2. 日志记录：在异常处理类中记录异常信息，便于后续排查问题。
  3. 特定异常处理：针对不同的异常类型，返回不同的 HTTP 状态码和错误信息。

总结​

全局异常处理是 Spring Cloud Alibaba 应用程序开发中的一个重要环节。通过使用 @ControllerAdvice 和 @ExceptionHandler，我们可以集中管理应用程序中的异常，避免代码冗余，并提供统一的错误响应格式。这不仅提高了代码的可维护性，还提升了用户体验。

附加资源​

练习​

  1. 尝试在你的 Spring Cloud Alibaba 项目中实现全局异常处理，并处理至少两种不同的异常类型。
  2. 修改 ErrorDetails 类，添加更多的字段（如错误码），并返回给客户端。
  3. 在全局异常处理类中添加日志记录功能，记录每次异常的发生时间和详细信息。