构建稳固系统基础：Spring Boot如何实现结果统一封装和异常统一处理？

2023-05-22 06:33:56

Spring Boot中的结果统一封装和异常统一处理

背景

随着Spring Boot框架在前后端分离和RESTful API开发中的广泛应用，使用JSON作为数据传输格式已成为常态。为此，定义一个统一规范的数据传输格式至关重要，以实现前后端数据的无缝交互。此外，异常统一处理机制也能提升应用程序的鲁棒性和用户体验。

结果统一封装

步骤1：创建统一返回对象

我们首先定义一个统一返回对象Result<T>，包含以下属性：

code: 状态码，用于指示请求结果
message: 消息，用于请求结果
data: 数据，用于承载请求成功时的返回数据

public class Result<T> {

    private Integer code;
    private String message;
    private T data;

    // 省略getter和setter方法
}

步骤2：定义返回结果状态码

接下来，定义一个枚举类ResultCode，用于定义各种状态码及其对应的消息：

public enum ResultCode {

    SUCCESS(200, "操作成功"),
    FAIL(500, "操作失败"),
    UNAUTHORIZED(401, "未授权"),
    NOT_FOUND(404, "未找到"),
    // 省略其他状态码
}

步骤3：使用统一返回对象封装结果

在Controller方法中，我们可以使用Result对象来封装请求结果：

@GetMapping("/user/{id}")
public Result<User> getUserById(@PathVariable Long id) {
    User user = userService.findById(id);
    if (user == null) {
        return Result.fail(ResultCode.NOT_FOUND);
    }
    return Result.success(user);
}

异常统一处理

步骤1：定义全局异常处理类

为了统一处理异常，我们需要定义一个全局异常处理类：

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public Result<Object> handleException(Exception e) {
        return Result.fail(ResultCode.FAIL, e.getMessage());
    }
}

步骤2：在Controller方法中抛出异常

在Controller方法中，可以通过抛出异常来触发全局异常处理类：

@GetMapping("/user/{id}")
public Result<User> getUserById(@PathVariable Long id) {
    User user = userService.findById(id);
    if (user == null) {
        throw new RuntimeException("用户不存在");
    }
    return Result.success(user);
}