SpringBoot打造统一返回格式，简单易上手！

2023-11-21 11:10:47

前言

在现代Web应用程序开发中，前后端分离已成为主流架构。后端负责业务逻辑处理，而前端则专注于用户界面和交互。然而，在前后端交互过程中，数据传输的格式往往不统一，容易导致兼容性问题和代码维护成本增加。

SpringBoot构建统一返回格式

为了解决这一问题，我们可以利用SpringBoot的强大功能，构建一个统一的返回格式。具体步骤如下：

1. 定义公共返回类

创建一个公共返回类，例如 Result，包含以下字段：

public class Result {
    private int code;
    private String message;
    private Object data;

    // 省略getter和setter方法
}

其中，code 表示返回状态码，message 表示返回信息，data 表示返回的数据。

2. 使用SpringBoot注解

在Controller方法中，使用 @ResponseBody 注解将返回对象转换为JSON格式，并使用 @ResponseStatus 注解设置返回状态码：

@PostMapping("/login")
@ResponseBody
public Result login(@RequestBody User user) {
    // 登录逻辑
    ...

    return new Result(200, "登录成功", user);
}

3. 前端处理

在前端中，我们可以使用Axios或其他库处理后端返回的JSON数据。例如：

axios.post("/login", user)
  .then(response => {
    if (response.data.code === 200) {
      // 登录成功
    } else {
      // 登录失败
    }
  })
  .catch(error => {
    // 处理异常
  });

4. 异常处理

在处理业务逻辑异常时，我们可以抛出 BusinessException，并在统一异常处理器中将其转换为 Result 对象返回。

5. 扩展返回格式

我们可以根据需要扩展 Result 类，增加额外的字段或方法，例如分页信息、错误码等。

示例代码

以下是一个完整示例代码：

// CommonResult.java
public class CommonResult<T> {
    private int code;
    private String message;
    private T data;

    // 省略getter和setter方法
}

// UserController.java
@RestController
@RequestMapping("/user")
public class UserController {
    @PostMapping("/login")
    public CommonResult<User> login(@RequestBody User user) {
        try {
            // 登录逻辑
            ...

            return new CommonResult<>(200, "登录成功", user);
        } catch (BusinessException e) {
            return new CommonResult<>(e.getCode(), e.getMessage(), null);
        }
    }
}