ApiResponse

ApiResponse是一个常用的类，它提供了一个统一的响应对象，用于向客户端提供有关 API 调用结果的信息。

响应结构

{
    "success": true,                #表示请求是否成功 
    "message": "操作成功",           #返回的信息
    "data": {                       #返回的数据
        "name": "张三",
        "age": 20
     }
}

使用

在使用ApiResponse时，通常可以通过以下方式创建一个实例：

public class UserController {
    @GetMapping("/{id}")
    public ApiResponse<User> getUserById(@PathVariable("id") Long id) {
        User user = userService.getUserById(id);
        return ApiResponse.success(user);
    }
}

这个例子展示了如何在控制器中使用ApiResponse。 此方法返回一个包含用户信息的ApiResponse实例。 如果数据提取成功，我们使用ApiResponse.success()来创建一个ApiResponse实例，该实例将包含请求数据。

如果数据提取失败，可以使用ApiResponse.error()方法来创建包含错误信息的响应。

总结

ApiResponse类是一个常用的响应对象，用于向客户端提供有关 API 调用结果的信息。 通过使用该类，您可以更轻松地创建和返回响应。务必注意在使用时，需要在程序中进行正确的异常处理，以避免程序宕机等未预期的问题。