程序员scholar
  • Spring高级
  • Spring Boot
scholar
2023-07-05
目录

Spring Boot - 通用响应类

# 1. 统一响应体设计

在实际项目开发中，前后端分离架构要求我们提供规范、一致的API响应格式。一个良好的响应不应随意返回各种格式的数据，而是应该有统一的结构。本文详细介绍如何设计和实现Spring Boot的通用响应类。

# 1.1 响应类核心设计

以下是一个通用响应类的实现，它包含了响应码、状态、消息、时间戳和数据等基本要素（建议放在项目的http包中）：

/**
 * 通用响应对象
 * 该类封装了API返回的标准格式，包括状态码、状态信息、消息、时间戳和数据
 * 使用泛型T来支持不同类型的响应数据
 * 
 * @author yourName
 * @date 2023/07/05
 */
public class Response<T> implements Serializable {
    /** 序列化ID */
    private static final long serialVersionUID = -464624820023286858L;
    
    /** 自定义状态码，用于标识请求处理结果 */
    private Integer code;
    
    /** 状态描述，如"success"、"fail"、"error"等 */
    protected String status;
    
    /** 详细消息，用于描述操作结果或错误原因 */
    private String message;
    
    /** 响应时间戳，记录响应生成的时间 */
    private Long timestamp;
    
    /** 响应数据，使用泛型支持各种数据类型，transient关键字防止某些情况下不需要序列化数据 */
    protected transient T data;

    /**
     * 获取状态码
     * @return 状态码
     */
    public Integer getCode() {
        return code;
    }

    /**
     * 设置状态码
     * @param code 状态码
     */
    public void setCode(Integer code) {
        this.code = code;
    }

    /**
     * 获取状态描述
     * @return 状态描述
     */
    public String getStatus() {
        return status;
    }

    /**
     * 设置状态描述
     * @param status 状态描述
     */
    public void setStatus(String status) {
        this.status = status;
    }

    /**
     * 获取详细消息
     * @return 详细消息
     */
    public String getMessage() {
        return message;
    }

    /**
     * 设置详细消息
     * @param message 详细消息
     */
    public void setMessage(String message) {
        this.message = message;
    }

    /**
     * 获取时间戳
     * @return 时间戳
     */
    public Long getTimestamp() {
        return timestamp;
    }

    /**
     * 设置时间戳
     * @param timestamp 时间戳
     */
    public void setTimestamp(Long timestamp) {
        this.timestamp = timestamp;
    }

    /**
     * 获取响应数据
     * @return 响应数据
     */
    public T getData() {
        return data;
    }

    /**
     * 设置响应数据
     * @param data 响应数据
     */
    public void setData(T data) {
        this.data = data;
    }
    
    /**
     * 创建Response实例的静态工厂方法
     * 便于链式调用和创建泛型实例
     * @param <T> 响应数据类型
     * @return 新的Response实例
     */
    public static <T> Response<T> instance() {
        return new Response<>();
    }
}
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

# 1.2 响应体说明

响应类主要包含以下字段：

  • code：自定义状态码，表示请求处理结果
  • status：状态描述，如"success"、"fail"、"error"等
  • message：详细消息，用于描述操作结果或错误原因
  • timestamp：响应时间戳，记录响应生成的时间
  • data：响应数据，使用泛型支持各种数据类型

# 2. 响应工具类实现

为了方便创建各种响应对象，我们设计了一个工具类HttpResult，提供了丰富的静态方法来生成不同类型的响应：

/**
 * HTTP响应结果工具类
 * 提供了创建各种标准响应对象的静态方法，简化Controller中的响应创建过程
 * 
 * @author yourName
 * @date 2023/07/05
 */
public class HttpResult {

    /**
     * 私有构造方法，防止实例化
     */
    private HttpResult() {
    }

    /**
     * 创建标准响应对象
     * 
     * @param data 响应数据
     * @param responseStatusEnum 响应状态枚举
     * @param <T> 数据类型
     * @return 响应对象
     */
    public static <T> Response<T> response(T data, ResponseStatusEnum responseStatusEnum) {
        // 创建响应实例
        Response<T> response = Response.instance();
        // 设置响应数据
        response.setData(data);
        // 设置状态码
        response.setCode(responseStatusEnum.getCode());
        // 设置状态描述
        response.setStatus(responseStatusEnum.getStatus());
        // 设置消息
        response.setMessage(responseStatusEnum.getMessage());
        // 设置当前时间戳
        response.setTimestamp(Instant.now().atZone(ZoneId.systemDefault()).toInstant().toEpochMilli());
        return response;
    }

    /**
     * 创建带自定义消息的标准响应对象
     * 
     * @param data 响应数据
     * @param responseStatusEnum 响应状态枚举
     * @param message 自定义消息
     * @param <T> 数据类型
     * @return 响应对象
     */
    public static <T> Response<T> response(T data, ResponseStatusEnum responseStatusEnum, String message) {
        Response<T> response = Response.instance();
        response.setData(data);
        response.setCode(responseStatusEnum.getCode());
        response.setStatus(responseStatusEnum.getStatus());
        response.setMessage(message);
        response.setTimestamp(Instant.now().atZone(ZoneId.systemDefault()).toInstant().toEpochMilli());
        return response;
    }

    /**
     * 创建带键值对数据的标准响应对象
     * 
     * @param key 数据键名
     * @param data 数据值
     * @param status 响应状态枚举
     * @param <T> 数据类型
     * @return 响应对象
     */
    public static <T> Response<Map<String, T>> response(String key, T data, ResponseStatusEnum status) {
        // 创建一个Map存储键值对数据
        Map<String, T> map = new HashMap<>(16);
        Response<Map<String, T>> response = Response.instance();
        map.put(key, data);
        response.setData(map);
        response.setCode(status.getCode());
        response.setStatus(status.getStatus());
        response.setMessage(status.getMessage());
        response.setTimestamp(Instant.now().atZone(ZoneId.systemDefault()).toInstant().toEpochMilli());
        return response;
    }

    /**
     * 创建完全自定义的响应对象
     * 
     * @param data 响应数据
     * @param code 状态码
     * @param status 状态描述
     * @param message 消息
     * @param <T> 数据类型
     * @return 响应对象
     */
    public static <T> Response<T> response(T data, Integer code, String status, String message) {
        Response<T> response = Response.instance();
        response.setData(data);
        response.setCode(code);
        response.setStatus(status);
        response.setMessage(message);
        response.setTimestamp(Instant.now().atZone(ZoneId.systemDefault()).toInstant().toEpochMilli());
        return response;
    }

    /**
     * 创建带键值对数据的完全自定义响应对象
     * 
     * @param key 数据键名
     * @param data 数据值
     * @param code 状态码
     * @param status 状态描述
     * @param message 消息
     * @param <T> 数据类型
     * @return 响应对象
     */
    public static <T> Response<Map<String, T>> response(String key, T data, Integer code, String status, String message) {
        Map<String, T> map = new HashMap<>(16);
        Response<Map<String, T>> response = Response.instance();
        map.put(key, data);
        response.setData(map);
        response.setCode(code);
        response.setStatus(status);
        response.setMessage(message);
        response.setTimestamp(Instant.now().atZone(ZoneId.systemDefault()).toInstant().toEpochMilli());
        return response;
    }

    /**
     * 创建成功响应对象
     * 
     * @param data 响应数据
     * @param <T> 数据类型
     * @return 成功响应对象
     */
    public static <T> Response<T> ok(T data) {
        Response<T> response = Response.instance();
        response.setData(data);
        response.setCode(ResponseStatusEnum.SUCCESS.getCode());
        response.setStatus(ResponseStatusEnum.SUCCESS.getStatus());
        response.setMessage(ResponseStatusEnum.SUCCESS.getMessage());
        response.setTimestamp(Instant.now().atZone(ZoneId.systemDefault()).toInstant().toEpochMilli());
        return response;
    }

    /**
     * 创建带键值对数据的成功响应对象
     * 
     * @param key 数据键名
     * @param data 数据值
     * @param <T> 数据类型
     * @return 成功响应对象
     */
    public static <T> Response<Map<String, T>> ok(String key, T data) {
        Map<String, T> map = new HashMap<>(16);
        Response<Map<String, T>> response = Response.instance();
        map.put(key, data);
        response.setData(map);
        response.setCode(ResponseStatusEnum.SUCCESS.getCode());
        response.setStatus(ResponseStatusEnum.SUCCESS.getStatus());
        response.setMessage(ResponseStatusEnum.SUCCESS.getMessage());
        response.setTimestamp(Instant.now().atZone(ZoneId.systemDefault()).toInstant().toEpochMilli());
        return response;
    }

    /**
     * 创建只有消息的成功响应对象
     * 
     * @param message 成功消息
     * @param <T> 数据类型
     * @return 成功响应对象
     */
    public static <T> Response<T> okMessage(String message) {
        Response<T> response = Response.instance();
        response.setData(null);
        response.setCode(ResponseStatusEnum.SUCCESS.getCode());
        response.setStatus(ResponseStatusEnum.SUCCESS.getStatus());
        response.setMessage(message);
        response.setTimestamp(Instant.now().atZone(ZoneId.systemDefault()).toInstant().toEpochMilli());
        return response;
    }

    /**
     * 创建失败响应对象
     * 
     * @param data 响应数据
     * @param <T> 数据类型
     * @return 失败响应对象
     */
    public static <T> Response<T> fail(T data) {
        Response<T> response = Response.instance();
        response.setData(data);
        response.setCode(ResponseStatusEnum.FAIL.getCode());
        response.setStatus(ResponseStatusEnum.FAIL.getStatus());
        response.setMessage(ResponseStatusEnum.FAIL.getMessage());
        response.setTimestamp(Instant.now().atZone(ZoneId.systemDefault()).toInstant().toEpochMilli());
        return response;
    }

    /**
     * 创建带键值对数据的失败响应对象
     * 
     * @param key 数据键名
     * @param data 数据值
     * @param <T> 数据类型
     * @return 失败响应对象
     */
    public static <T> Response<Map<String, T>> fail(String key, T data) {
        Map<String, T> map = new HashMap<>(16);
        Response<Map<String, T>> response = Response.instance();
        map.put(key, data);
        response.setData(map);
        response.setCode(ResponseStatusEnum.FAIL.getCode());
        response.setStatus(ResponseStatusEnum.FAIL.getStatus());
        response.setMessage(ResponseStatusEnum.FAIL.getMessage());
        response.setTimestamp(Instant.now().atZone(ZoneId.systemDefault()).toInstant().toEpochMilli());
        return response;
    }

    /**
     * 创建带自定义状态和消息的失败响应对象
     * 
     * @param responseStatusEnum 响应状态枚举
     * @param message 自定义消息
     * @param <T> 数据类型
     * @return 失败响应对象
     */
    public static <T> Response<T> fail(ResponseStatusEnum responseStatusEnum, String message) {
        return returnResponse(responseStatusEnum, message);
    }

    /**
     * 创建只有消息的失败响应对象
     * 
     * @param message 失败消息
     * @param <T> 数据类型
     * @return 失败响应对象
     */
    public static <T> Response<T> failMessage(String message) {
        Response<T> response = Response.instance();
        response.setData(null);
        response.setCode(ResponseStatusEnum.FAIL.getCode());
        response.setStatus(ResponseStatusEnum.FAIL.getStatus());
        response.setMessage(message);
        response.setTimestamp(Instant.now().atZone(ZoneId.systemDefault()).toInstant().toEpochMilli());
        return response;
    }

    /**
     * 创建带自定义状态码和消息的失败响应对象
     * 
     * @param code 自定义状态码
     * @param message 自定义消息
     * @param <T> 数据类型
     * @return 失败响应对象
     */
    public static <T> Response<T> failMessage(Integer code, String message) {
        return returnResponse(code, message);
    }

    /**
     * 创建错误响应对象
     * 
     * @param data 响应数据
     * @param <T> 数据类型
     * @return 错误响应对象
     */
    public static <T> Response<T> error(T data) {
        Response<T> response = Response.instance();
        response.setData(data);
        response.setCode(ResponseStatusEnum.ERROR.getCode());
        response.setStatus(ResponseStatusEnum.ERROR.getStatus());
        response.setMessage(ResponseStatusEnum.ERROR.getMessage());
        response.setTimestamp(Instant.now().atZone(ZoneId.systemDefault()).toInstant().toEpochMilli());
        return response;
    }

    /**
     * 创建带键值对数据的错误响应对象
     * 
     * @param key 数据键名
     * @param data 数据值
     * @param <T> 数据类型
     * @return 错误响应对象
     */
    public static <T> Response<Map<String, T>> error(String key, T data) {
        Map<String, T> map = new HashMap<>(16);
        Response<Map<String, T>> response = Response.instance();
        map.put(key, data);
        response.setData(map);
        response.setCode(ResponseStatusEnum.ERROR.getCode());
        response.setStatus(ResponseStatusEnum.ERROR.getStatus());
        response.setMessage(ResponseStatusEnum.ERROR.getMessage());
        response.setTimestamp(Instant.now().atZone(ZoneId.systemDefault()).toInstant().toEpochMilli());
        return response;
    }

    /**
     * 创建带自定义状态和消息的错误响应对象
     * 
     * @param responseStatusEnum 响应状态枚举
     * @param message 自定义消息
     * @param <T> 数据类型
     * @return 错误响应对象
     */
    public static <T> Response<T> error(ResponseStatusEnum responseStatusEnum, String message) {
        return returnResponse(responseStatusEnum, message);
    }

    /**
     * 创建只有消息的错误响应对象
     * 
     * @param message 错误消息
     * @param <T> 数据类型
     * @return 错误响应对象
     */
    public static <T> Response<T> errorMessage(String message) {
        Response<T> response = Response.instance();
        response.setData(null);
        response.setCode(ResponseStatusEnum.ERROR.getCode());
        response.setStatus(ResponseStatusEnum.ERROR.getStatus());
        response.setMessage(message);
        response.setTimestamp(Instant.now().atZone(ZoneId.systemDefault()).toInstant().toEpochMilli());
        return response;
    }

    /**
     * 创建带自定义状态码和消息的错误响应对象
     * 
     * @param code 自定义状态码
     * @param message 自定义消息
     * @param <T> 数据类型
     * @return 错误响应对象
     */
    public static <T> Response<T> errorMessage(Integer code, String message) {
        return returnResponse(code, message);
    }

    /**
     * 根据数据是否为空返回成功或失败响应
     * 如果数据为空，返回失败响应；否则返回成功响应并带自定义消息
     *
     * @param data 响应数据
     * @param message 成功消息
     * @param <T> 数据类型
     * @return 响应对象
     */
    public static <T> Response<T> okOrFail(T data, String message) {
        if (null == data) {
            return response(null, ResponseStatusEnum.FAIL, ResponseStatusEnum.FAIL.getMessage());
        }
        return response(data, ResponseStatusEnum.SUCCESS, message);
    }

    /**
     * 根据数据是否为空返回成功或失败响应
     * 如果数据为空，返回失败响应；否则返回成功响应
     *
     * @param data 响应数据
     * @param <T> 数据类型
     * @return 响应对象
     */
    public static <T> Response<T> okOrFail(T data) {
        if (null == data) {
            return response(null, ResponseStatusEnum.FAIL);
        }
        return response(data, ResponseStatusEnum.SUCCESS);
    }

    /**
     * 内部方法：创建带自定义状态和消息的响应对象
     * 
     * @param responseStatusEnum 响应状态枚举
     * @param message 自定义消息
     * @param <T> 数据类型
     * @return 响应对象
     */
    private static <T> Response<T> returnResponse(ResponseStatusEnum responseStatusEnum, String message) {
        Response<T> response = Response.instance();
        response.setData(null);
        response.setCode(responseStatusEnum.getCode());
        response.setStatus(responseStatusEnum.getStatus());
        response.setMessage(message);
        response.setTimestamp(Instant.now().atZone(ZoneId.systemDefault()).toInstant().toEpochMilli());
        return response;
    }

    /**
     * 内部方法：创建带自定义状态码和消息的响应对象
     * 
     * @param code 自定义状态码
     * @param message 自定义消息
     * @param <T> 数据类型
     * @return 响应对象
     */
    private static <T> Response<T> returnResponse(Integer code, String message) {
        Response<T> response = Response.instance();
        response.setData(null);
        response.setCode(code);
        response.setStatus(ResponseStatusEnum.ERROR.getStatus());
        response.setMessage(message);
        response.setTimestamp(Instant.now().atZone(ZoneId.systemDefault()).toInstant().toEpochMilli());
        return response;
    }
}
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400

# 3. 响应状态枚举类

为了标准化响应状态，我们定义了一组常用的响应状态枚举：

/**
 * 响应状态枚举类
 * 定义了标准的API响应状态码、状态描述和消息
 * 便于在整个应用中统一使用相同的响应状态
 *
 * @author yourName
 * @date 2023/07/05
 */
public enum ResponseStatusEnum {
    /**
     * 操作成功
     * 对应HTTP状态码200
     */
    SUCCESS(HttpServletResponse.SC_OK, "success", "操作成功"),
    
    /**
     * 操作失败
     * 对应HTTP状态码500，表示服务器内部错误导致操作失败
     */
    FAIL(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, "fail", "操作失败"),
    
    /**
     * 操作错误
     * 对应HTTP状态码500，表示服务器内部错误
     */
    ERROR(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, "error", "操作错误"),
    
    /**
     * 请求未授权
     * 对应HTTP状态码401，表示请求需要用户验证
     */
    UN_AUTHORIZED(HttpServletResponse.SC_UNAUTHORIZED, "fail", "请求未授权"),

    /**
     * 客户端请求未授权
     * 对应HTTP状态码401，表示客户端需要授权
     */
    CLIENT_UN_AUTHORIZED(HttpServletResponse.SC_UNAUTHORIZED, "fail", "客户端请求未授权"),

    /**
     * 资源未找到
     * 对应HTTP状态码404，表示服务器无法找到请求的资源
     */
    NOT_FOUND(HttpServletResponse.SC_NOT_FOUND, "fail", "404 没找到请求"),

    /**
     * 消息不能读取
     * 对应HTTP状态码400，表示由于语法错误，服务器无法理解请求
     */
    MSG_NOT_READABLE(HttpServletResponse.SC_BAD_REQUEST, "fail", "消息不能读取"),

    /**
     * 不支持当前请求方法
     * 对应HTTP状态码405，表示请求行中指定的请求方法不能被用于请求相应的资源
     */
    METHOD_NOT_SUPPORTED(HttpServletResponse.SC_METHOD_NOT_ALLOWED, "fail", "不支持当前请求方法"),

    /**
     * 不支持当前媒体类型
     * 对应HTTP状态码415，表示服务器不支持请求的媒体类型
     */
    MEDIA_TYPE_NOT_SUPPORTED(HttpServletResponse.SC_UNSUPPORTED_MEDIA_TYPE, "fail", "不支持当前媒体类型"),

    /**
     * 请求被拒绝
     * 对应HTTP状态码403，表示服务器理解请求但拒绝执行
     */
    REQ_REJECT(HttpServletResponse.SC_FORBIDDEN, "fail", "请求被拒绝"),

    /**
     * 服务器异常
     * 对应HTTP状态码500，表示服务器遇到了一个未曾预料的状况
     */
    INTERNAL_SERVER_ERROR(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, "fail", "服务器异常"),

    /**
     * 非法请求
     * 对应HTTP状态码500，表示请求非法
     */
    ILLEGALITY_REQUEST(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, "fail", "非法请求"),

    /**
     * 缺少必要的请求参数
     * 对应HTTP状态码400，表示请求参数不完整
     */
    PARAM_MISS(HttpServletResponse.SC_BAD_REQUEST, "fail", "缺少必要的请求参数"),

    /**
     * 请求参数类型错误
     * 对应HTTP状态码400，表示请求参数类型不匹配
     */
    PARAM_TYPE_ERROR(HttpServletResponse.SC_BAD_REQUEST, "fail", "请求参数类型错误"),

    /**
     * 请求参数绑定错误
     * 对应HTTP状态码400，表示请求参数无法绑定到目标对象
     */
    PARAM_BIND_ERROR(HttpServletResponse.SC_BAD_REQUEST, "fail", "请求参数绑定错误"),

    /**
     * 参数校验失败
     * 对应HTTP状态码400，表示请求参数未通过验证规则
     */
    PARAM_VALID_ERROR(HttpServletResponse.SC_BAD_REQUEST, "fail", "参数校验失败");

    /** 状态码 */
    private Integer code;

    /** 状态描述 */
    private String status;

    /** 消息 */
    private String message;

    /**
     * 构造方法
     * 
     * @param code 状态码
     * @param status 状态描述
     * @param message 消息
     */
    ResponseStatusEnum(Integer code, String status, String message) {
        this.code = code;
        this.status = status;
        this.message = message;
    }

    /**
     * 获取状态码
     * @return 状态码
     */
    public Integer getCode() {
        return code;
    }

    /**
     * 设置状态码
     * @param code 状态码
     */
    public void setCode(Integer code) {
        this.code = code;
    }

    /**
     * 获取状态描述
     * @return 状态描述
     */
    public String getStatus() {
        return status;
    }

    /**
     * 设置状态描述
     * @param status 状态描述
     */
    public void setStatus(String status) {
        this.status = status;
    }

    /**
     * 获取消息
     * @return 消息
     */
    public String getMessage() {
        return message;
    }

    /**
     * 设置消息
     * @param message 消息
     */
    public void setMessage(String message) {
        this.message = message;
    }
}
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175

# 4. 实际应用

# 4.1 基本使用方法

在Controller中使用统一响应类的方式非常简单：

/**
 * 用户控制器示例
 * 展示如何在控制器中使用统一响应类
 */
@RestController
@RequestMapping("/api/users")
public class UserController {
    
    /**
     * 用户登录接口
     * 演示返回成功响应
     *
     * @return 登录成功响应
     */
    @GetMapping("/login")
    public Response<String> login() {
        // 返回成功响应，data为字符串类型
        return HttpResult.ok("登录成功");
    }
    
    /**
     * 获取用户信息接口
     * 演示返回包含用户对象的成功响应
     *
     * @param id 用户ID
     * @return 用户信息响应
     */
    @GetMapping("/{id}")
    public Response<User> getUserInfo(@PathVariable Long id) {
        // 模拟获取用户信息
        User user = new User(id, "张三", "zhangsan@example.com");
        
        // 返回包含用户对象的成功响应
        return HttpResult.ok(user);
    }
    
    /**
     * 创建用户接口
     * 演示返回自定义消息的成功响应
     *
     * @param user 用户信息
     * @return 创建结果响应
     */
    @PostMapping("/")
    public Response<User> createUser(@RequestBody User user) {
        // 模拟用户创建逻辑
        user.setId(System.currentTimeMillis());
        
        // 返回包含自定义消息的成功响应
        return HttpResult.response(user, ResponseStatusEnum.SUCCESS, "用户创建成功");
    }
    
    /**
     * 删除用户接口
     * 演示返回失败响应
     *
     * @param id 用户ID
     * @return 删除结果响应
     */
    @DeleteMapping("/{id}")
    public Response<Void> deleteUser(@PathVariable Long id) {
        // 模拟权限不足的情况
        boolean hasPermission = false;
        
        if (!hasPermission) {
            // 返回失败响应，包含自定义消息
            return HttpResult.fail(ResponseStatusEnum.REQ_REJECT, "权限不足，无法删除用户");
        }
        
        // 实际删除逻辑...
        return HttpResult.okMessage("用户删除成功");
    }
    
    /**
     * 更新用户接口
     * 演示根据操作结果返回不同响应
     *
     * @param id 用户ID
     * @param user 用户信息
     * @return 更新结果响应
     */
    @PutMapping("/{id}")
    public Response<User> updateUser(@PathVariable Long id, @RequestBody User user) {
        // 模拟用户不存在的情况
        boolean userExists = id % 2 == 0;
        
        if (!userExists) {
            // 返回错误响应
            return HttpResult.error(ResponseStatusEnum.NOT_FOUND, "用户不存在");
        }
        
        // 模拟更新逻辑
        user.setId(id);
        
        // 返回成功响应
        return HttpResult.ok(user);
    }
}
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

# 4.2 更多使用场景

统一响应类可以在各种场景下灵活应用：

/**
 * 产品控制器示例
 * 展示更多统一响应类的使用场景
 */
@RestController
@RequestMapping("/api/products")
public class ProductController {
    
    /**
     * 使用Map类型响应多个数据
     *
     * @return 包含多个数据的响应
     */
    @GetMapping("/stats")
    public Response<Map<String, Object>> getProductStats() {
        Map<String, Object> statsMap = new HashMap<>();
        statsMap.put("totalProducts", 1250);
        statsMap.put("outOfStock", 42);
        statsMap.put("topSelling", "智能手机");
        
        return HttpResult.ok(statsMap);
    }
    
    /**
     * 使用键值对响应方式
     *
     * @return 包含键值对的响应
     */
    @GetMapping("/count")
    public Response<Map<String, Integer>> getProductCount() {
        return HttpResult.ok("count", 1250);
    }
    
    /**
     * 条件判断返回成功或失败
     *
     * @param id 产品ID
     * @return 根据条件返回不同响应
     */
    @GetMapping("/{id}")
    public Response<Product> getProduct(@PathVariable Long id) {
        // 模拟获取产品
        Product product = id > 0 ? new Product(id, "示例产品", 99.9) : null;
        
        // 根据产品是否存在返回成功或失败响应
        return HttpResult.okOrFail(product, "获取产品成功");
    }
    
    /**
     * 自定义错误码和消息
     *
     * @return 自定义错误响应
     */
    @PostMapping("/import")
    public Response<Void> importProducts() {
        // 模拟导入失败
        return HttpResult.errorMessage(4001, "产品导入失败：格式不兼容");
    }
}
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

# 5. 响应示例及说明

# 5.1 成功响应示例

{
  "code": 200,
  "status": "success",
  "message": "操作成功",
  "timestamp": 1688556681000,
  "data": {
    "id": 1001,
    "name": "张三",
    "email": "zhangsan@example.com"
  }
}
1
2
3
4
5
6
7
8
9
10
11

# 5.2 失败响应示例

{
  "code": 400,
  "status": "fail",
  "message": "缺少必要的请求参数",
  "timestamp": 1688556682000,
  "data": null
}
1
2
3
4
5
6
7

# 5.3 错误响应示例

{
  "code": 500,
  "status": "error",
  "message": "服务器内部错误",
  "timestamp": 1688556683000,
  "data": null
}
1
2
3
4
5
6
7
编辑此页 (opens new window)
上次更新: 2025/04/05, 20:16:54
Spring Boot - 请求参数接收
Spring Boot - 全局异常处理

← Spring Boot - 全局异常处理→

Theme by Vdoing | Copyright © 2019-2025 程序员scholar