通用返回结果类ResultVO

1. 定义通用返回结果类

​                        定义ResultVO类，作返回给前端的对象结构，主要有4个字段

• code : 错误码
  
• data :  内容
  
• message : 消息
  
• description : 具体描述
  

1. import lombok.Data;
2. import java.io.Serializable;
4. /**
5. * 通用返回结果类
6. * @param <T>
7. */
8. @Data
9. public class ResultVO<T> implements Serializable {
11.     /**
12.      * 错误码
13.      */
14.     private int code;
15.     /**
16.      * 内容
17.      */
18.     private T data;
19.     /**
20.      * 消息
21.      */
22.     private String message;
23.     /**
24.      * 描述
25.      */
26.     private String description;
28.     public ResultVO(int code, T data, String message, String description) {
29.         this.code = code;
30.         this.data = data;
31.         this.message = message;
32.         this.description = description;
33.     }
35.     public ResultVO(int code, T data) {
36.         this(code,data,"","");
37.     }
39.     public ResultVO(int code, T data, String message) {
40.         this(code,data,message,"");
41.     }
42.    
43. }

复制代码

2 工具类

1. /**
2. * 通用返回响应工具类
3. *
4. * @author leovany
5. * @date 2023/09/23
6. */
7. public class ResultUtils {
9.     /**
10.      * 成功
11.      *
12.      * @param data 数据
13.      * @return {@link ResultVO}<{@link T}>
14.      */
15.     public static <T> ResultVO<T> success(T data) {
16.         return new ResultVO<T>(0, data, "success");
17.     }
19.     /**
20.      * 错误
21.      *
22.      * @param code        错误码
23.      * @param message     信息
24.      * @param description 描述
25.      * @return {@link ResultVO}
26.      */
27.     public static ResultVO error(int code, String message, String description) {
28.         return new ResultVO<>(code, null, message, description);
29.     }
31. }

复制代码

3 使用

• 返回值用 ResultVO封装
  
• 成功返回：ResultUtils.success(XX);
  
• 失败失败：ResultUtils.error(code,message,description);
  

1. @PostMapping("/login")
2. public ResultVO<User> userLogin(@RequestBody UserLoginRequest userLoginRequest, HttpServletRequest request) {
3.     String userAccount = userLoginRequest.getUserAccount();
4.     String userPassword = userLoginRequest.getUserPassword();
5.     // 参数校验
6.     if (StringUtils.isAnyBlank(userAccount, userPassword)) {
7.         return ResultUtils.error(40000,"参数错误","参数不能为空");
8.     }
9.     // 从数据库查找用户
10.     User user = userService.doLogin(userAccount, userPassword, request);
11.     return ResultUtils.success(user);
12. }

复制代码

跟之前对比，代码更加优雅

4 返回给前端效果图

返回给前端的响应结果

1. {
2.     "code": 0,
3.     "data": {
4.         "id": 10,
5.         "username": "admin"
6.     },
7.     "message": "success",
8.     "description": ""
9. }

复制代码

• 成功
  

• 失败
  

总结

​        通过封装ResultVO通用返回结果对象之后，保证了后端跟前端视图对象（VO）的统一。

本文由博客一文多发平台 OpenWrite 发布！

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！