响应包装工具类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
package camellia.common;

import lombok.Data;

import java.io.Serial;
import java.io.Serializable;

@Data
public class BaseResponse<T> implements Serializable {
    @Serial
    private static final long serialVersionUID = 5477638191965981955L;

    /**
     * 表示响应状态码
     */
    private int code;

    /**
     * 泛型类型的数据，表示响应的数据内容。
     */
    private T data;

    /**
     * 消息内容，用于描述响应的简短信息。
     */
    private String message;

    /**
     * 描述信息，用于提供更详细的响应说明。<br>
     * 根据需求，可删。
     */
    private String description;

    /**
     * 接收 code、data、message 和 description 参数，用于完全自定义响应。
     * @param code
     * @param data
     * @param message
     * @param description
     */
    public BaseResponse(int code, T data, String message, String description) {
        this.code = code;
        this.data = data;
        this.message = message;
        this.description = description;
    }

    /**
     * 省略 description 参数，将其默认为空字符串。
     * @param code
     * @param data
     * @param message
     */
    public BaseResponse(int code, T data, String message) {
        this(code, data, message, "");
    }

    /**
     * 省略 message 和 description 参数，将其默认为空字符串。
     * @param code
     * @param data
     */
    public BaseResponse(int code, T data) {
        this(code, data, "", "");
    }

    /**
     * 接受 ErrorCode 对象，用于处理错误响应。
     * @param errorCode
     */
    public BaseResponse(ErrorCode errorCode) {
        this(errorCode.getCode(), null, errorCode.getMessage(), errorCode.getDescription());
    }

}

  • 处理后响应的结构如下：
1
2
3
4
5
6
7
8
9
10
{
  "code": 200,
  "data": {
    "id": 1,
    "name": "John Doe"
  },
  "message": "Success",
  "description": ""
}

1
2
3
4
5
6
7
{
  "code": 404,
  "data": null,
  "message": "Not Found",
  "description": "The requested resource was not found."
}