Java通用返回工具类Result

通用返回类Result

前言：Java项目搭建时，常常需要去封装一个通用型的Result工具类，下面就是我自己封装的常用的返回类，可以直接使用。（有部分Swagger注解,使用时可忽略）

第一步、创建ReusltUtils工具类

1. package com.code.walker.utils;
3. import com.code.walker.constant.ResultCode;
4. import io.swagger.annotations.ApiModel;
5. import io.swagger.annotations.ApiModelProperty;
6. import lombok.*;
7. import lombok.experimental.Accessors;
9. import java.io.Serializable;
11. /**
12. * @author ProsperousEnding-fhl
13. * @create 2023-07-20-15:16
14. */
15. @Getter
16. @Setter
17. @NoArgsConstructor
18. @AllArgsConstructor
19. @Accessors(chain = true)
20. @ApiModel(value = "响应信息体")
21. public class  ResultUtils<T> implements Serializable {
23.     /**
24.      * 响应码
25.      */
26.     @Getter
27.     @Setter
28.     @ApiModelProperty(value = "响应标记：成功标记=0,失败1")
29.     private Integer code;
31.     /**
32.      * 响应信息
33.      */
34.     @Getter
35.     @Setter
36.     @ApiModelProperty(value = "响应信息")
37.     private String message;
39.     /**
40.      * 响应数据
41.      */
42.     @Getter
43.     @Setter
44.     @ApiModelProperty(value = "响应数据")
45.     private T data;
48.     @Getter
49.     @Setter
50.     @ApiModelProperty(value = "返回状态")
51.     private boolean status;
54.     private ResultUtils(ResultCode resultCode,T data,boolean status){
55.         this.code = resultCode.getCode();
56.         this.message = resultCode.getMessage();
57.         this.data = data;
58.         this.status=status;
59.     }
61.     /**
62.      * 无数据成功返回
63.      *
64.      * @return
65.      */
66.     public static  <T>ResultUtils success(){
67.         return new ResultUtils<T>(ResultCode.SUCCESS.getCode(),ResultCode.SUCCESS.getMessage(),null,true);
68.     }
69.     /**
70.      * 带数据返回
71.      */
72.     public static <T> ResultUtils success(T data){
73.         return new ResultUtils<T>(ResultCode.SUCCESS.getCode(),ResultCode.SUCCESS.getMessage(),data,true);
74.     }
76.     /**
77.      * 失败
78.      */
79.     public static  <T>ResultUtils fail(){
80.         return new ResultUtils<T>(ResultCode.FAIL.getCode(),ResultCode.FAIL.getMessage(), null,false);
81.     }
82.     /**
83.      * 失败
84.      */
85.     public static <T> ResultUtils fail(T data){
86.         return new ResultUtils<T>(ResultCode.FAIL.getCode(),ResultCode.FAIL.getMessage(), data,false);
87.     }
90.     @Override
91.     public String toString() {
92.         return "ResultUtils [code=" + code + ", message=" + message + ", data=" + data + "]";
93.     }
94. }

复制代码

第二步 创建常用的报错信息类（在日常开发中可不写，将ReusltUtils中的ResultCode的代码换成常量即可）

注：主要是为了美观以及修改方便，所以去单独的封装一个常量信息类

1. /**
2. * @author ProsperousEnding-fhl
3. * @create 2023-07-20-15:46
4. */
6. @Getter
7. public enum ResultCode {
8.     /**
9.      * 成功
10.      */
11.     SUCCESS(200, "成功"),
12.     FAIL(1000, "失败"),
13.     FAILED(400, "请求失败"),
14.     NOT_FOUND(404, "未找到"),
15.     SERVER_ERROR(500, " 服务器内部出错 "),
16.     /**
17.      * 错误参数
18.      */
19.     PARAM_IS_INVALID(1001, "参数无效"),
20.     PARAM_IS_BLANK(1002, "参为空"),
21.     PARAM_TYPE_ERROR(1003, "参数类型错误"),
22.     PARAM_NOT_COMPLETE(1004, "参数缺失"),
23.     /**
24.      * 用户错误
25.      */
26.     USER_NOT_LOGIN_IN(2001, "用户未登录"),
27.     USER_LOGIN_ERROR(2002, "账号不存在或者密码错误"),
28.     USER_ACCOUNT_FORBIDDEN(2003, "账户被禁用"),
29.     USER_NOT_EXISTS(2004, "用户不存在"),
30.     USER_HAS_EXISTED(2005, "用户已存在");
32.     /**
33.      * 代码
34.      */
35.     private final Integer code;
36.     /**
37.      * 信息
38.      */
39.     private final String message;
41.     private ResultCode(Integer code, String message) {
42.         this.code = code;
43.         this.message = message;
44.     }
45. }

复制代码

第三步、调用方法以及返回样式

• 调用方式：
  

使用时可以直接使用ResultUtils.方法的方式

1.    public Result getUser() {
2.        User user1=new User();
3.        user1.setName("codeTalker")
4.         return Result.success(user1);
5.    }

复制代码

• 返回样式：
  

1.    {
2.        "code": 200,
3.        "message": "成功",
4.        "data":{
5.            "name":"codeTalker"
6.        }
7.        "status": true
8.    }

复制代码

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