看看人家那后端API接口寫得,那叫一個優雅!

在移動互聯網,分布式、微服務盛行的今天,現在項目絕大部分都采用的微服務框架,前后端分離方式,(題外話:前后端的工作職責越來越明確,現在的前端都稱之為大前端,技術棧以及生態圈都已經非常成熟;以前后端人員瞧不起前端人員,那現在后端人員要重新認識一下前端,前端已經很成體系了)。

一般系統的大致整體架構圖如下:

image

需要說明的是,有些小伙伴會回復說,這個架構太簡單了吧,太low了,什么網關啊,緩存啊,消息中間件啊,都沒有。因為這篇主要介紹的是API接口,所以我們聚焦點,其他的模塊小伙伴們自行去補充。

接口交互

前端和后端進行交互,前端按照約定請求URL路徑,并傳入相關參數,后端服務器接收請求,進行業務處理,返回數據給前端。

針對URL路徑的restful風格,以及傳入參數的公共請求頭的要求(如:app_version,api_version,device等),老顧這里就不介紹了,小伙伴們可以自行去了解,也比較簡單。

著重介紹一下后端服務器如何實現把數據返回給前端?

返回格式

后端返回給前端我們一般用JSON體方式,定義如下:

{
    #返回狀態碼
    code:integer,       
    #返回信息描述
    message:string,
    #返回值
    data:object
}

CODE狀態碼

code返回狀態碼,一般小伙伴們是在開發的時候需要什么,就添加什么。

如接口要返回用戶權限異常,我們加一個狀態碼為101吧,下一次又要加一個數據參數異常,就加一個102的狀態碼。這樣雖然能夠照常滿足業務,但狀態碼太凌亂了

我們應該可以參考HTTP請求返回的狀態碼

:下面是常見的HTTP狀態碼:
200 - 請求成功
301 - 資源(網頁等)被永久轉移到其它URL
404 - 請求的資源(網頁等)不存在
500 - 內部服務器錯誤
image

我們可以參考這樣的設計,這樣的好處就把錯誤類型歸類到某個區間內,如果區間不夠,可以設計成4位數。

#1000~1999 區間表示參數錯誤
#2000~2999 區間表示用戶錯誤
#3000~3999 區間表示接口異常

這樣前端開發人員在得到返回值后,根據狀態碼就可以知道,大概什么錯誤,再根據message相關的信息描述,可以快速定位。

Message

這個字段相對理解比較簡單,就是發生錯誤時,如何友好的進行提示。一般的設計是和code狀態碼一起設計,如

image

再在枚舉中定義,狀態碼

image

狀態碼和信息就會一一對應,比較好維護。

Data

返回數據體,JSON格式,根據不同的業務又不同的JSON體。

我們要設計一個返回體類Result

image

控制層Controller

我們會在controller層處理業務請求,并返回給前端,以order訂單為例

image

我們看到在獲得order對象之后,我們是用的Result構造方法進行包裝賦值,然后進行返回。小伙伴們有沒有發現,構造方法這樣的包裝是不是很麻煩,我們可以優化一下。

美觀優化

我們可以在Result類中,加入靜態方法,一看就懂

image

那我們來改造一下Controller

image

代碼是不是比較簡潔了,也美觀了。

優雅優化

上面我們看到在Result類中增加了靜態方法,使得業務處理代碼簡潔了。但小伙伴們有沒有發現這樣有幾個問題:

1、每個方法的返回都是Result封裝對象,沒有業務含義
2、在業務代碼中,成功的時候我們調用Result.success,異常錯誤調用Result.failure。是不是很多余
3、上面的代碼,判斷id是否為null,其實我們可以使用hibernate validate做校驗,沒有必要在方法體中做判斷。

我們最好的方式直接返回真實業務對象,最好不要改變之前的業務方式,如下圖

image

這個和我們平時的代碼是一樣的,非常直觀,直接返回order對象,這樣是不是很完美。那實現方案是什么呢?

實現方案

小伙伴們怎么去實現是不是有點思路,在這個過程中,我們需要做幾個事情

1、定義一個注解@ResponseResult,表示這個接口返回的值需要包裝一下
2、攔截請求,判斷此請求是否需要被@ResponseResult注解
3、核心步驟就是實現接口ResponseBodyAdvice和@ControllerAdvice,判斷是否需要包裝返回值,如果需要,就把Controller接口的返回值進行重寫。

注解類

用來標記方法的返回值,是否需要包裝

image

攔截器

攔截請求,是否此請求返回的值需要包裝,其實就是運行的時候,解析@ResponseResult注解

image

此代碼核心思想,就是獲取此請求,是否需要返回值包裝,設置一個屬性標記。

重寫返回體

image

上面代碼就是判斷是否需要返回值包裝,如果需要就直接包裝。這里我們只處理了正常成功的包裝,如果方法體報異常怎么辦?處理異常也比較簡單,只要判斷body是否為異常類。

image

怎么做全局的異常處理,篇幅原因,這里就不做介紹了,只要思路理清楚了,自行改造就行。

重寫Controller

image

在控制器類上或者方法體上加上@ResponseResult注解,這樣就ok了,簡單吧。到此返回的設計思路完成,是不是又簡潔,又優雅。

總結

這個方案還有沒有別的優化空間,當然是有的。如:每次請求都要反射一下,獲取請求的方法是否需要包裝,其實可以做個緩存,不需要每次都需要解析。當然整體思路了解,小伙伴們就可以在此基礎上面自行擴展。謝謝!!!

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,197評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,415評論 3 415
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,104評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,884評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,647評論 6 408
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,130評論 1 323
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,208評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,366評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,887評論 1 334
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,737評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,939評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,478評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,174評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,586評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,827評論 1 283
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,608評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,914評論 2 372