前言

在之前的文章中我們有介紹過，如何更好、更簡(jiǎn)單的寫好一個(gè)接口(接口返回值篇)，今天的這篇文章我們主要介紹，怎么統(tǒng)一處理下接口的返回格式問題。

問題分析

我們先來分析下我們所面臨的問題在哪里，然后接著給出解決方案。在寫一個(gè)接口時(shí)，我們通常會(huì)先統(tǒng)一定義一下接口的返回格式是什么，然后在跟前端去對(duì)接，通常的返回格式大體兩種(我們以保存用戶為例)：

1. 成功/失敗響應(yīng)格式不一致(此種方式作為我們默認(rèn)的接口響應(yīng)方式)

保存用戶成功，響應(yīng)體

• 失敗響應(yīng)體(下面的格式是spring boot默認(rèn)的錯(cuò)誤響應(yīng)格式，只不過我們?cè)谄浠A(chǔ)上增加了一個(gè)code字段用于解釋更詳細(xì)的錯(cuò)誤碼)

2.成功/失敗響應(yīng)體格式一致

• 保存用戶成功，響應(yīng)體

• 失敗響應(yīng)體

那么如果我們想要的響應(yīng)體格式是第二種，我們?cè)撊绾螌懳覀兊拇a呢？你可能想是這樣么？

PlatformResult.success()這段邏輯顯然很多余，每個(gè)方法都要這樣寫一遍，所以上述方式并不是我們想要的，我們要的是

我們加了一個(gè)自定義的注解@ResponseResult(PlatformResult.class)，參數(shù)PlatformResult.class告訴這個(gè)Controller類下的所有方法都以這個(gè)類PlatformResult的格式進(jìn)行返回，這個(gè)注解可以標(biāo)記在類或方法上，好了，我們的目的明朗了許多，要做的就是標(biāo)記這個(gè)注解讓它實(shí)現(xiàn)接口返回值格式控制這個(gè)功能，下面我們給出具體的實(shí)現(xiàn)方式。

實(shí)現(xiàn)思路

首先介紹下完成我們這次主要功能的幾個(gè)類：

Result 是返回格式類的父接口(所有返回格式類都需要繼承它)

PlatformResult 通用返回結(jié)果格式(我們上面說的第二種返回結(jié)果)

DefaultErrorResult 全局錯(cuò)誤返回結(jié)果(我們上面說的第一種錯(cuò)誤時(shí)的返回結(jié)果)

GlobalExceptionHandler全局異常處理

ResponseResult 注解類(用于在Controller上指定返回值格式類)

ResponseResultInterceptor 攔截器(主要用于將ResponseResult注解類的標(biāo)記信息傳入ResponseResultHandler中)

ResponseResultHandler 響應(yīng)體格式處理器(主要轉(zhuǎn)換邏輯都在這里)

代碼實(shí)現(xiàn)

下面將有一大片代碼襲來，要頂住！O(∩_∩)O哈哈~

1. Result 接口類

說明

理論上所有的返回格式類都需要實(shí)現(xiàn)該接口才能被使用

2. PlatformResult 通用返回結(jié)果

3. DefaultErrorResult 默認(rèn)全局錯(cuò)誤返回格式

4. GlobalExceptionHandler 全局錯(cuò)誤異常處理器

BaseGlobalExceptionHandler 全局異常處理基礎(chǔ)類

說明

上面用到了一些自定義異常基類(BusinessException)，對(duì)于這個(gè)類它會(huì)有很多子類去繼承它，例如：

參數(shù)異常、數(shù)據(jù)已存在異常、無權(quán)限異常等等，這些類我們會(huì)在后面的文章給大家分享下

5. ResponseResult 注解類

說明

這里我們默認(rèn)PlatformResult使用這個(gè)類作為返回格式，所以@ResponseResult 等價(jià)于@ResponseResult(PlatformResult.class)

6. ResponseResultInterceptor 攔截器

開啟攔截器

7. ResponseResultHandler 響應(yīng)體格式處理器

說明

上述代碼用到了一個(gè)工具類(RequestContextHolderUtil)用于獲取request對(duì)象，如果感興趣可以看下這篇文章 工具類分享之《RequestContextHolderUtil》

@ControllerAdvice、ResponseBodyAdvice這兩個(gè)類是本功能的關(guān)鍵使用類，用于接口的響應(yīng)體增強(qiáng)，其中supports方法用于判斷是否需要做增強(qiáng)轉(zhuǎn)化，beforeBodyWrite方法用于增加邏輯實(shí)現(xiàn)

supports方法中，加了個(gè)小功能，當(dāng)調(diào)用人員不想要封裝結(jié)果時(shí)，可以在header上設(shè)置參數(shù)Api-Style=none

最后我們寫一個(gè)創(chuàng)建用戶的Controller層方法：

總結(jié)

以上是生活随笔為你收集整理的接口响应时组装响应json_企业实战之spring项目《接口响应体格式统一封装》的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。