今天說(shuō)一下 Spring Boot 如何實(shí)現(xiàn)優(yōu)雅的數(shù)據(jù)響應(yīng)：統(tǒng)一的結(jié)果響應(yīng)格式、簡(jiǎn)單的數(shù)據(jù)封裝。
前提
無(wú)論系統(tǒng)規(guī)模大小，大部分 Spring Boot 項(xiàng)目是提供 Restful + json 接口，供前端或其他服務(wù)調(diào)用，格式統(tǒng)一規(guī)范，是程序猿彼此善待彼此的象征，也是減少聯(lián)調(diào)挨罵的基本保障。
通常響應(yīng)結(jié)果中需要包含業(yè)務(wù)狀態(tài)碼、響應(yīng)描述、響應(yīng)時(shí)間戳、響應(yīng)內(nèi)容，比如：
{
"code": 200,
"desc": "查詢成功",
"timestamp": "2020-08-12 14:37:11",
"data": {
"uid": "1597242780874",
"name": "測(cè)試 1"
}
}
對(duì)于業(yè)務(wù)狀態(tài)碼分為兩個(gè)派系：一個(gè)是推薦使用 HTTP 響應(yīng)碼作為接口業(yè)務(wù)返回；另一種是 HTTP 響應(yīng)碼全部返回 200，在響應(yīng)體中通過(guò)單獨(dú)的字段表示響應(yīng)狀態(tài)。兩種方式各有優(yōu)劣，個(gè)人推薦使用第二種，因?yàn)楹芏?Web 服務(wù)器對(duì) HTTP 狀態(tài)碼有攔截處理功能，而且狀態(tài)碼數(shù)量有限，不夠靈活。比如返回 200 表示接口處理成功且正常響應(yīng)，現(xiàn)在需要有一個(gè)狀態(tài)碼表示接口處理成功且正常響應(yīng)，但是請(qǐng)求數(shù)據(jù)狀態(tài)不對(duì)，可以返回 2001 表示。
自定義響應(yīng)體
定義一個(gè)數(shù)據(jù)響應(yīng)體是返回統(tǒng)一響應(yīng)格式的第一步，無(wú)論接口正常返回，還是發(fā)生異常，返回給調(diào)用方的結(jié)構(gòu)格式都應(yīng)該不變。給出一個(gè)示例：
|
1
2
3
4
5
6
7
8
9
10
11
12
|
@ApiModel@Datapublic class Response<T> { @ApiModelProperty(value = "返回碼", example = "200") private Integer code; @ApiModelProperty(value = "返回碼描述", example = "ok") private String desc; @ApiModelProperty(value = "響應(yīng)時(shí)間戳", example = "2020-08-12 14:37:11") private Date timestamp = new Date(); @ApiModelProperty(value = "返回結(jié)果") private T data;} |
這樣，只要在 Controller 的方法返回Response就可以了，接口響應(yīng)就一致了，但是這樣會(huì)形成很多格式固定的代碼模板，比如下面這種寫(xiě)法：
|
1
2
3
4
5
6
7
8
|
@RequestMapping("hello1")public Response<String> hello1() { final Response<String> response = new Response<>(); response.setCode(200); response.setDesc("返回成功"); response.setData("Hello, World!"); return response;} |
調(diào)用接口響應(yīng)結(jié)果為：
{
"code": 200,
"desc": "返回成功",
"timestamp": "2020-08-12 14:37:11","data": "Hello, World!"
}
這種重復(fù)且沒(méi)有技術(shù)含量的代碼，怎么能配得上程序猿這種優(yōu)（lan）雅（duo）的生物呢？最好能在返回響應(yīng)結(jié)果的前提下，減去那些重復(fù)的代碼，比如：
|
1
2
3
4
|
@RequestMapping("hello2")public String hello2() { return "Hello, World!";} |
這就需要借助 Spring 提供的ResponseBodyAdvice來(lái)實(shí)現(xiàn)了。
全局處理響應(yīng)數(shù)據(jù)
先上代碼：
|
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
|
/** * <br>created at 2020/8/12 * * @author www.howardliu.cn * @since 1.0.0 */@RestControllerAdvicepublic class ResultResponseAdvice implements ResponseBodyAdvice<Object> { @Override public boolean supports(final MethodParameter returnType, final Class<? extends HttpMessageConverter<?>> converterType) { return !returnType.getGenericParameterType().equals(Response.class);// 1 } @Override public Object beforeBodyWrite(final Object body, final MethodParameter returnType, final MediaType selectedContentType, final Class<? extends HttpMessageConverter<?>> selectedConverterType, final ServerHttpRequest request, final ServerHttpResponse response) { if (body == null || body instanceof Response) { return body; } final Response<Object> result = new Response<>(); result.setCode(200); result.setDesc("查詢成功"); result.setData(body); if (returnType.getGenericParameterType().equals(String.class)) {// 2 ObjectMapper objectMapper = new ObjectMapper(); try { return objectMapper.writeValueAsString(result); } catch (JsonProcessingException e) { throw new RuntimeException("將 Response 對(duì)象序列化為 json 字符串時(shí)發(fā)生異常", e); } } return result; }}/** * <br>created at 2020/8/12 * * @author www.howardliu.cn * @since 1.0.0 */@RestControllerpublic class HelloWorldController { @RequestMapping("hello2") public String hello2() { return "Hello, World!"; } @RequestMapping("user1") public User user1() { User u = new User(); u.setUid(System.currentTimeMillis() + ""); u.setName("測(cè)試1"); return u; }} |
上面代碼是實(shí)現(xiàn)了 Spring ResponseBodyAdvice類的模板方式，按照 Spring 的要求實(shí)現(xiàn)就行。只有兩個(gè)需要特別注意的地方，也就是代碼中標(biāo)注 1 和 2 的地方。
首先說(shuō) 1 這一行，也就是supports方法，這個(gè)方法是校驗(yàn)是否需要調(diào)用beforeBodyWrite方法的前置判斷，返回true則執(zhí)行beforeBodyWrite方法，這里根據(jù) Controller 方法返回類型來(lái)判斷是否需要執(zhí)行beforeBodyWrite，也可以一律返回true，在后面判斷是否需要進(jìn)行類型轉(zhuǎn)換。
然后重點(diǎn)說(shuō)下 2 這一行，這行是坑，是大坑，如果對(duì) Spring 結(jié)構(gòu)不熟悉的，絕對(duì)會(huì)在這徘徊許久，不得妙法。
代碼 2 這一行是判斷Controller的方法是否返回的是String類型的結(jié)果，如果是，將返回的對(duì)象序列化之后返回。
這是因?yàn)?code>Spring對(duì)String類型的響應(yīng)類型單獨(dú)處理了，使用StringHttpMessageConverter類進(jìn)行數(shù)據(jù)轉(zhuǎn)換。在處理響應(yīng)結(jié)果的時(shí)候，會(huì)在方法getContentLength中計(jì)算響應(yīng)體大小，其父類方法定義是protected Long getContentLength(T t, @Nullable MediaType contentType)，而StringHttpMessageConverter將方法重寫(xiě)為protected Long getContentLength(String str, @Nullable MediaType contentType)，第一個(gè)參數(shù)是響應(yīng)對(duì)象，固定寫(xiě)死是String類型，如果我們強(qiáng)制返回Response對(duì)象，就會(huì)報(bào)ClassCastException。
當(dāng)然，直接返回String的場(chǎng)景不多，這個(gè)坑可能會(huì)在某天特殊接口中突然出現(xiàn)。
補(bǔ)充說(shuō)明
上面只是展示了ResponseBodyAdvice類最簡(jiǎn)單的應(yīng)用，我們還可以實(shí)現(xiàn)更多的擴(kuò)展使用。比如：
-
返回請(qǐng)求ID：這個(gè)需要與與
RequestBodyAdvice聯(lián)動(dòng)，獲取到請(qǐng)求ID后，在響應(yīng)是放在響應(yīng)體中； -
結(jié)果數(shù)據(jù)加密：通過(guò)
ResponseBodyAdvice實(shí)現(xiàn)響應(yīng)數(shù)據(jù)加密，不會(huì)侵入業(yè)務(wù)代碼，而且可以通過(guò)注解方式靈活處理接口的加密等級(jí)； -
有選擇的包裝響應(yīng)體：比如定義注解
IgnoreResponseWrap，在不需要包裝響應(yīng)體的接口上定義，然后在supports方法上判斷方法的注解即可，比如：
|
1
2
3
4
5
|
@Overridepublic boolean supports(final MethodParameter returnType, final Class<? extends HttpMessageConverter<?>> converterType) { final IgnoreResponseWrap[] declaredAnnotationsByType = returnType.getExecutable().getDeclaredAnnotationsByType(IgnoreResponseWrap.class); return !(declaredAnnotationsByType.length > 0 || returnType.getGenericParameterType().equals(Response.class));} |
很多其他玩法就不一一列舉了。
總結(jié)
上面說(shuō)了正常響應(yīng)的數(shù)據(jù)，只做到了一點(diǎn)優(yōu)雅，想要完整，還需要考慮接口異常情況，總不能來(lái)個(gè)大大的try/catch/finally包住業(yè)務(wù)邏輯吧，那也太丑了。后面會(huì)再來(lái)一篇，重點(diǎn)說(shuō)說(shuō)接口如何在出現(xiàn)異常時(shí)，也能返回統(tǒng)一的結(jié)果響應(yīng)。
本文只是拋出一塊磚，玉還得自己去找。
推薦閱讀
- SpringBoot 實(shí)戰(zhàn)：一招實(shí)現(xiàn)結(jié)果的優(yōu)雅響應(yīng)
- SpringBoot 實(shí)戰(zhàn)：如何優(yōu)雅的處理異常
- SpringBoot 實(shí)戰(zhàn)：通過(guò) BeanPostProcessor 動(dòng)態(tài)注入 ID 生成器
- SpringBoot 實(shí)戰(zhàn)：自定義 Filter 優(yōu)雅獲取請(qǐng)求參數(shù)和響應(yīng)結(jié)果
- SpringBoot 實(shí)戰(zhàn)：優(yōu)雅的使用枚舉參數(shù)
- SpringBoot 實(shí)戰(zhàn)：優(yōu)雅的使用枚舉參數(shù)（原理篇）
- SpringBoot 實(shí)戰(zhàn)：在 RequestBody 中優(yōu)雅的使用枚舉參數(shù)
- SpringBoot 實(shí)戰(zhàn)：在 RequestBody 中優(yōu)雅的使用枚舉參數(shù)（原理篇）
到此這篇關(guān)于SpringBoot實(shí)戰(zhàn)之實(shí)現(xiàn)結(jié)果的優(yōu)雅響應(yīng)案例詳解的文章就介紹到這了,更多相關(guān)SpringBoot實(shí)戰(zhàn)之實(shí)現(xiàn)結(jié)果的優(yōu)雅響應(yīng)內(nèi)容請(qǐng)搜索服務(wù)器之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持服務(wù)器之家！
原文鏈接：https://www.howardliu.cn/springboot-action-gracefully-response/
