SpringBoot实现统一封装返回前端结果集的示例代码

下面我来详细讲解如何实现SpringBoot的统一封装返回前端结果集的示例代码的完整攻略。

1. 为什么需要统一封装返回结果集

在我们使用SpringBoot开发Web应用时，通常经常会用到Controller来处理请求。Controller的主要作用是接收请求，处理业务逻辑，然后将结果返回给前端。通常情况下，我们在Controller方法中使用如下方式处理返回结果：

@GetMapping("/user/{id}")
public User getUserById(@PathVariable Long id) {
    User user = userService.getById(id);
    return user;
}

但是这种方式有一些问题：

• 状态码难以统一处理：不同的异常对应不同的状态码，我们需要在返回结果时根据不同的异常写不同的状态码，这样的代码会很难维护。
• 错误信息不易统一处理：一些错误信息的提醒需要在前台做处理，一些需要在后台做处理，这样一个应用里面会出现很多的格式化字符串，不方便管理。

因此，我们需要一种机制来解决这些问题，统一封装返回前端结果集是一个很好的解决方案。

2. 实现统一封装返回前端结果集的步骤

2.1 定义统一返回结果集

首先，我们需要定义一个统一的返回结果集。这个结果集应该包含状态码、错误信息和返回的数据。定义示例如下：

public class Result<T> {
    private int code;// 返回状态码
    private String message;// 返回信息
    private T data;// 返回数据

    // 省略 getter 和 setter 方法...
}

2.2 定义异常处理器

我们需要定义一个全局的异常处理器来处理Controller抛出的异常。该处理器可以统一处理异常，封装统一的返回结果集。定义异常处理器的示例如下：

@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public Result<Object> handleException(Exception e) {
        // 处理异常...
        // 返回统一的结果集...
        return result;
    }
}

2.3 封装返回结果集

接下来，我们需要在Controller中封装统一的返回结果集。这个结果集应该在每一个接口处理完成后都返回。定义一个公共的返回数据方法，返回统一的结果集。示例如下：

public class BaseController {
    public <T> Result<T> getResult(int code, String message, T data) {
        Result<T> result = new Result<>();
        result.setCode(code);
        result.setMessage(message);
        result.setData(data);
        return result;
    }
}

2.4 在Controller中使用统一返回结果集

最后，我们需要在每一个Controller中使用统一的返回结果集。示例如下：

@RestController
@RequestMapping("/user")
public class UserController extends BaseController {
    @Autowired
    private IUserService userService;

    @GetMapping("/{id}")
    public Result<User> getUserById(@PathVariable Long id) {
        User user = userService.getById(id);
        return getResult(200, "成功", user);
    }

    @DeleteMapping("/{id}")
    public Result<Object> deleteUserById(@PathVariable Long id) {
        userService.deleteById(id);
        return getResult(200, "成功", null);
    }
}

3. 示例说明

下面我会给出两个示例来说明如何使用SpringBoot实现统一封装返回前端结果集。

示例1：返回单个对象

在以下示例中，我们会返回单个用户对象。如果用户不存在，我们会抛出UserNotFoundException。如果抛出了其他异常，我们会返回一个错误信息并设置状态码为500。

@RestController
@RequestMapping("/user")
public class UserController extends BaseController {
    @Autowired
    private IUserService userService;

    @GetMapping("/{id}")
    public Result<User> getUserById(@PathVariable Long id) throws UserNotFoundException {
        User user = userService.getById(id);
        if (user == null) {
            throw new UserNotFoundException(String.format("用户 %d 不存在", id));
        }
        return getResult(200, "成功", user);
    }

    @ExceptionHandler(UserNotFoundException.class)
    @ResponseBody
    public Result<Object> handleUserNotFoundException(UserNotFoundException e) {
        return getResult(404, e.getMessage(), null);
    }

    @ExceptionHandler(Exception.class)
    @ResponseBody
    public Result<Object> handleException(Exception e) {
        return getResult(500, e.getMessage(), null);
    }
}

示例2：返回列表

在以下示例中，我们会返回一组用户对象列表。如果数据库中没有用户，我们会抛出NoUserException。如果抛出了其他异常，我们会返回一个错误信息并设置状态码为500。

@RestController
@RequestMapping("/user")
public class UserController extends BaseController {
    @Autowired
    private IUserService userService;

    @GetMapping("")
    public Result<List<User>> getUserList() throws NoUserException {
        List<User> userList = userService.getUserList();
        if (userList.size() == 0) {
            throw new NoUserException("用户列表为空");
        }
        return getResult(200, "成功", userList);
    }

    @ExceptionHandler(NoUserException.class)
    @ResponseBody
    public Result<Object> handleNoUserException(NoUserException e) {
        return getResult(404, e.getMessage(), null);
    }

    @ExceptionHandler(Exception.class)
    @ResponseBody
    public Result<Object> handleException(Exception e) {
        return getResult(500, e.getMessage(), null);
    }
}

这两个示例演示了如何使用SpringBoot实现统一封装返回前端结果集。我们通过定义统一的返回结果集、定义异常处理器、封装返回结果集和在Controller中使用统一返回结果集等一系列步骤，实现了一个简洁、易于维护的接口返回结果。