這篇文章給大家介紹如何設(shè)計(jì)API接口實(shí)現(xiàn)統(tǒng)一格式返回，內(nèi)容非常詳細(xì)，感興趣的小伙伴們可以參考借鑒，希望對(duì)大家能有所幫助。

成都創(chuàng)新互聯(lián)公司服務(wù)項(xiàng)目包括大冶網(wǎng)站建設(shè)、大冶網(wǎng)站制作、大冶網(wǎng)頁(yè)制作以及大冶網(wǎng)絡(luò)營(yíng)銷(xiāo)策劃等。多年來(lái)，我們專(zhuān)注于互聯(lián)網(wǎng)行業(yè)，利用自身積累的技術(shù)優(yōu)勢(shì)、行業(yè)經(jīng)驗(yàn)、深度合作伙伴關(guān)系等，向廣大中小型企業(yè)、政府機(jī)構(gòu)等提供互聯(lián)網(wǎng)行業(yè)的解決方案，大冶網(wǎng)站推廣取得了明顯的社會(huì)效益與經(jīng)濟(jì)效益。目前，我們服務(wù)的客戶(hù)以成都為中心已經(jīng)輻射到大冶省份的部分城市，未來(lái)相信會(huì)繼續(xù)擴(kuò)大服務(wù)區(qū)域并繼續(xù)獲得客戶(hù)的支持與信任！

前言

在移動(dòng)互聯(lián)網(wǎng)，分布式、微服務(wù)盛行的今天，現(xiàn)在項(xiàng)目絕大部分都采用的微服務(wù)框架，前后端分離方式，（題外話：前后端的工作職責(zé)越來(lái)越明確，現(xiàn)在的前端都稱(chēng)之為大前端，技術(shù)棧以及生態(tài)圈都已經(jīng)非常成熟；以前后端人員瞧不起前端人員，那現(xiàn)在后端人員要重新認(rèn)識(shí)一下前端，前端已經(jīng)很成體系了）。

一般系統(tǒng)的大致整體架構(gòu)圖如下：

需要說(shuō)明的是，有些小伙伴會(huì)回復(fù)說(shuō)，這個(gè)架構(gòu)太簡(jiǎn)單了吧，太low了，什么網(wǎng)關(guān)啊，緩存啊，消息中間件啊，都沒(méi)有。因?yàn)槔项欉@篇主要介紹的是API接口，所以我們聚焦點(diǎn)，其他的模塊小伙伴們自行去補(bǔ)充。

接口 交互

前端和后端進(jìn)行交互，前端按照約定請(qǐng)求URL路徑，并傳入相關(guān)參數(shù)，后端服務(wù)器接收請(qǐng)求，進(jìn)行業(yè)務(wù)處理，返回?cái)?shù)據(jù)給前端。

針對(duì)URL路徑的restful風(fēng)格，以及傳入?yún)?shù)的公共請(qǐng)求頭的要求（如：app_version,api_version,device等），老顧這里就不介紹了，小伙伴們可以自行去了解，也比較簡(jiǎn)單。

老顧注重介紹一下后端服務(wù)器如何實(shí)現(xiàn)把數(shù)據(jù)返回給前端？

返回格式

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

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

CODE狀態(tài)碼

code返回狀態(tài)碼，一般小伙伴們是在開(kāi)發(fā)的時(shí)候需要什么，就添加什么。

如接口要返回用戶(hù)權(quán)限異常，我們加一個(gè)狀態(tài)碼為101吧，下一次又要加一個(gè)數(shù)據(jù)參數(shù)異常，就加一個(gè)102的狀態(tài)碼。這樣雖然能夠照常滿足業(yè)務(wù)，但狀態(tài)碼太凌亂了

我們應(yīng)該可以參考HTTP請(qǐng)求返回的狀態(tài)碼

：下面是常見(jiàn)的HTTP狀態(tài)碼：

200 - 請(qǐng)求成功

301 - 資源（網(wǎng)頁(yè)等）被永久轉(zhuǎn)移到其它URL

404 - 請(qǐng)求的資源（網(wǎng)頁(yè)等）不存在

500 - 內(nèi)部服務(wù)器錯(cuò)誤

我們可以參考這樣的設(shè)計(jì)，這樣的好處就把錯(cuò)誤類(lèi)型歸類(lèi)到某個(gè)區(qū)間內(nèi)，如果區(qū)間不夠，可以設(shè)計(jì)成4位數(shù)。

#1000～1999 區(qū)間表示參數(shù)錯(cuò)誤#2000～2999 區(qū)間表示用戶(hù)錯(cuò)誤#3000～3999 區(qū)間表示接口異常

這樣前端開(kāi)發(fā)人員在得到返回值后，根據(jù)狀態(tài)碼就可以知道，大概什么錯(cuò)誤，再根據(jù)message相關(guān)的信息描述，可以快速定位。

Message

這個(gè)字段相對(duì)理解比較簡(jiǎn)單，就是發(fā)生錯(cuò)誤時(shí)，如何友好的進(jìn)行提示。一般的設(shè)計(jì)是和code狀態(tài)碼一起設(shè)計(jì)，如

再在枚舉中定義，狀態(tài)碼

狀態(tài)碼和信息就會(huì)一一對(duì)應(yīng)，比較好維護(hù)。

Data

返回?cái)?shù)據(jù)體，JSON格式，根據(jù)不同的業(yè)務(wù)又不同的JSON體。

我們要設(shè)計(jì)一個(gè)返回體類(lèi)Result

控制層Controller

我們會(huì)在controller層處理業(yè)務(wù)請(qǐng)求，并返回給前端，以order訂單為例

我們看到在獲得order對(duì)象之后，我們是用的Result構(gòu)造方法進(jìn)行包裝賦值，然后進(jìn)行返回。小伙伴們有沒(méi)有發(fā)現(xiàn)，構(gòu)造方法這樣的包裝是不是很麻煩，我們可以?xún)?yōu)化一下。

美觀優(yōu)化

我們可以在Result類(lèi)中，加入靜態(tài)方法，一看就懂

那我們來(lái)改造一下Controller

代碼是不是比較簡(jiǎn)潔了，也美觀了。

優(yōu)雅優(yōu)化

上面我們看到在Result類(lèi)中增加了靜態(tài)方法，使得業(yè)務(wù)處理代碼簡(jiǎn)潔了。但小伙伴們有沒(méi)有發(fā)現(xiàn)這樣有幾個(gè)問(wèn)題：

1、每個(gè)方法的返回都是Result封裝對(duì)象，沒(méi)有業(yè)務(wù)含義

2、在業(yè)務(wù)代碼中，成功的時(shí)候我們調(diào)用Result.success，異常錯(cuò)誤調(diào)用Result.failure。是不是很多余

3、上面的代碼，判斷id是否為null，其實(shí)我們可以使用hibernate validate做校驗(yàn)，沒(méi)有必要在方法體中做判斷。

我們最好的方式直接返回真實(shí)業(yè)務(wù)對(duì)象，最好不要改變之前的業(yè)務(wù)方式，如下圖

這個(gè)和我們平時(shí)的代碼是一樣的，非常直觀，直接返回order對(duì)象，這樣是不是很完美。那實(shí)現(xiàn)方案是什么呢？

實(shí)現(xiàn)方案

小伙伴們?cè)趺慈?shí)現(xiàn)是不是有點(diǎn)思路，在這個(gè)過(guò)程中，我們需要做幾個(gè)事情

1、定義一個(gè)注解@ResponseResult，表示這個(gè)接口返回的值需要包裝一下

2、攔截請(qǐng)求，判斷此請(qǐng)求是否需要被@ResponseResult注解

3、核心步驟就是實(shí)現(xiàn)接口ResponseBodyAdvice和@ControllerAdvice，判斷是否需要包裝返回值，如果需要，就把Controller接口的返回值進(jìn)行重寫(xiě)。

注解類(lèi)

用來(lái)標(biāo)記方法的返回值，是否需要包裝

攔截器

攔截請(qǐng)求，是否此請(qǐng)求返回的值需要包裝，其實(shí)就是運(yùn)行的時(shí)候，解析@ResponseResult注解

此代碼核心思想，就是獲取此請(qǐng)求，是否需要返回值包裝，設(shè)置一個(gè)屬性標(biāo)記。

重寫(xiě)返回體

上面的代碼就是判斷是否需要返回值包裝，如果需要就直接包裝。這里我們只處理了正常成功的包裝，如果方法體報(bào)異常的怎么辦？處理異常也比較簡(jiǎn)單，只要判斷body是否為異常類(lèi)。

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

重新Controller

在控制器類(lèi)上或者方法體上加上@ResponseResult注解，這樣就ok了，簡(jiǎn)單吧。

關(guān)于如何設(shè)計(jì)API接口實(shí)現(xiàn)統(tǒng)一格式返回就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，可以學(xué)到更多知識(shí)。如果覺(jué)得文章不錯(cuò)，可以把它分享出去讓更多的人看到。

當(dāng)前文章：如何設(shè)計(jì)API接口實(shí)現(xiàn)統(tǒng)一格式返回-創(chuàng)新互聯(lián)
網(wǎng)頁(yè)網(wǎng)址：http://www.chinadenli.net/article14/ceecde.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供手機(jī)網(wǎng)站建設(shè)、App開(kāi)發(fā)、域名注冊(cè)、網(wǎng)頁(yè)設(shè)計(jì)公司、外貿(mào)網(wǎng)站建設(shè)、網(wǎng)站導(dǎo)航

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶(hù)投稿、用戶(hù)轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請(qǐng)盡快告知，我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如需處理請(qǐng)聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來(lái)源： 創(chuàng)新互聯(lián)