<kbd id="afajh"><form id="afajh"></form></kbd>
<strong id="afajh"><dl id="afajh"></dl></strong>
    <del id="afajh"><form id="afajh"></form></del>
        1. <th id="afajh"><progress id="afajh"></progress></th>
          <b id="afajh"><abbr id="afajh"></abbr></b>
          <th id="afajh"><progress id="afajh"></progress></th>

          瞧瞧,人家那后端 API 接口寫得多優(yōu)雅!

          共 4323字,需瀏覽 9分鐘

           ·

          2020-12-27 15:21

             
          點(diǎn)擊上方“逆鋒起筆”,公眾號(hào)回復(fù) pdf
          領(lǐng)取大佬們推薦的學(xué)習(xí)資料

          作者:老顧

          編輯:陶家龍

          出處:https://www.toutiao.com/i6694404645827117572


          在移動(dòng)互聯(lián)網(wǎng),分布式、微服務(wù)盛行的今天,現(xiàn)在項(xiàng)目絕大部分都采用的微服務(wù)框架,前后端分離方式。

          題外話:前后端的工作職責(zé)越來(lái)越明確,現(xiàn)在的前端都稱之為大前端,技術(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í)候需要什么,就添加什么。


          如接口要返回用戶權(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ò)誤類型歸類到某個(gè)區(qū)間內(nèi),如果區(qū)間不夠,可以設(shè)計(jì)成 4 位數(shù)。
              
          #1000~1999 區(qū)間表示參數(shù)錯(cuò)誤
          #2000~2999 區(qū)間表示用戶錯(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è)返回體類 Result:

          控制層 Controller


          我們會(huì)在 Controller 層處理業(yè)務(wù)請(qǐng)求,并返回給前端,以 Order 訂單為例
          我們看到在獲得 Order 對(duì)象之后,我們是用的 Result 構(gòu)造方法進(jìn)行包裝賦值,然后進(jìn)行返回。關(guān)注公眾號(hào) 逆鋒起筆,回復(fù) pdf,下載你需要的各種學(xué)習(xí)資料。


          小伙伴們有沒(méi)有發(fā)現(xiàn),構(gòu)造方法這樣的包裝是不是很麻煩,我們可以優(yōu)化一下。


          美觀優(yōu)化


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



          那我們來(lái)改造一下 Controller
          代碼是不是比較簡(jiǎn)潔了,也美觀了。



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


          上面我們看到在 Result 類中增加了靜態(tài)方法,使得業(yè)務(wù)處理代碼簡(jiǎn)潔了。


          但小伙伴們有沒(méi)有發(fā)現(xiàn)這樣有幾個(gè)問(wèn)題:
          • 每個(gè)方法的返回都是 Result 封裝對(duì)象,沒(méi)有業(yè)務(wù)含義。

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

          • 上面的代碼,判斷 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è)事情:
          • 定義一個(gè)注解 @ResponseResult,表示這個(gè)接口返回的值需要包裝一下。

          • 攔截請(qǐng)求,判斷此請(qǐng)求是否需要被 @ResponseResult 注解。

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


          ①注解類

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


          ②攔截器

          攔截請(qǐng)求,是否此請(qǐng)求返回的值需要包裝,其實(shí)就是運(yùn)行的時(shí)候,解析 @ResponseResult 注解。
          此代碼核心思想,就是獲取此請(qǐng)求,是否需要返回值包裝,設(shè)置一個(gè)屬性標(biāo)記。


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


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


          ④重寫 Controller



          在控制器類上或者方法體上加上 @ResponseResult 注解,這樣就 OK 了,簡(jiǎn)單吧。到此返回的設(shè)計(jì)思路完成,是不是又簡(jiǎn)潔,又優(yōu)雅。


          總結(jié)

          這個(gè)方案還有沒(méi)有別的優(yōu)化空間,當(dāng)然是有的。如:每次請(qǐng)求都要反射一下,獲取請(qǐng)求的方法是否需要包裝,其實(shí)可以做個(gè)緩存,不需要每次都需要解析。



          當(dāng)然整體思路了解,小伙伴們就可以在此基礎(chǔ)上面自行擴(kuò)展。謝謝?。?!


          精彩文章推薦:
          字節(jié)跳動(dòng)三輪技術(shù)面_后端研發(fā)提前批
          7 個(gè)開(kāi)源的 Spring Boot 前后端分離項(xiàng)目,一定要收藏!

             
          點(diǎn)個(gè)『在看』支持下 
          瀏覽 51
          點(diǎn)贊
          評(píng)論
          收藏
          分享

          手機(jī)掃一掃分享

          分享
          舉報(bào)
          評(píng)論
          圖片
          表情
          推薦
          點(diǎn)贊
          評(píng)論
          收藏
          分享

          手機(jī)掃一掃分享

          分享
          舉報(bào)
          <kbd id="afajh"><form id="afajh"></form></kbd>
          <strong id="afajh"><dl id="afajh"></dl></strong>
            <del id="afajh"><form id="afajh"></form></del>
                1. <th id="afajh"><progress id="afajh"></progress></th>
                  <b id="afajh"><abbr id="afajh"></abbr></b>
                  <th id="afajh"><progress id="afajh"></progress></th>
                  国产高清肏屄自拍 | 国内精品无码 | 波多野成人无码精品视频 | 大香蕉亚洲网 | 天天干狠狠干 |