接口返回數(shù)據(jù)結(jié)構(gòu)以及狀態(tài)碼如何定義

數(shù)據(jù)返回格式

  • 正常返回
    • applicaiton/json格式進(jìn)行返回數(shù)據(jù)
    • data具體的業(yè)務(wù)數(shù)據(jù)
    • http status code為200
    • traceId為唯一的請求id
  • 業(yè)務(wù)邏輯異常,為了統(tǒng)一返回的數(shù)據(jù)結(jié)構(gòu)足丢,統(tǒng)一使用了zalando/problem項(xiàng)目作為返回的數(shù)據(jù)結(jié)構(gòu)粱腻。主要包括:
    • 定義統(tǒng)一的業(yè)務(wù)異常類,然后統(tǒng)一捕獲該異常類斩跌,然后轉(zhuǎn)換數(shù)據(jù)結(jié)構(gòu)绍些。
    • applicaiton/json格式進(jìn)行返回數(shù)據(jù)
    • detail為對應(yīng)的錯誤信息簡單描述
    • code為對應(yīng)的業(yè)務(wù)錯誤碼
    • type為異常請求的uri
    • http status code為200
    • traceId為唯一的請求id
  • 請求異常,統(tǒng)一識別異常類型耀鸦,然后轉(zhuǎn)換數(shù)據(jù)結(jié)構(gòu)
    • applicaiton/json格式進(jìn)行返回數(shù)據(jù)
    • detail為對應(yīng)的錯誤信息簡單描述
    • code為對應(yīng)的業(yè)務(wù)錯誤碼
    • type為異常請求的uri
    • http status code為400柬批、401、403揭糕、404萝快、405、406著角、415
    • traceId為唯一的請求id
  • 非業(yè)務(wù)異常類,統(tǒng)一處理
    • applicaiton/json格式進(jìn)行返回數(shù)據(jù)
    • detail為對應(yīng)的錯誤信息簡單描述
    • code為對應(yīng)的錯誤碼
    • type為異常請求的uri
    • http status code為500旋恼、501
    • traceId為唯一的請求id

統(tǒng)一異常捕獲

  • 通過繼承zalando/problem-spring-web項(xiàng)目的ProblemHandling
  • 通過使用@RestControllerAdvice來統(tǒng)一捕獲異常
  • 額外定義業(yè)務(wù)異常類的統(tǒng)一處理方法
  • 通過使用ResponseBodyAdvice接口和@RestControllerAdvice來統(tǒng)一添加traceId和請求的uri
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末吏口,一起剝皮案震驚了整個濱河市奄容,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌产徊,老刑警劉巖昂勒,帶你破解...
    沈念sama閱讀 218,122評論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異舟铜,居然都是意外死亡戈盈,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,070評論 3 395
  • 文/潘曉璐 我一進(jìn)店門谆刨,熙熙樓的掌柜王于貴愁眉苦臉地迎上來塘娶,“玉大人,你說我怎么就攤上這事痊夭〉蟀叮” “怎么了?”我有些...
    開封第一講書人閱讀 164,491評論 0 354
  • 文/不壞的土叔 我叫張陵她我,是天一觀的道長虹曙。 經(jīng)常有香客問我,道長番舆,這世上最難降的妖魔是什么酝碳? 我笑而不...
    開封第一講書人閱讀 58,636評論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮恨狈,結(jié)果婚禮上疏哗,老公的妹妹穿的比我還像新娘。我一直安慰自己拴事,他們只是感情好沃斤,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,676評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著刃宵,像睡著了一般衡瓶。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上牲证,一...
    開封第一講書人閱讀 51,541評論 1 305
  • 那天哮针,我揣著相機(jī)與錄音,去河邊找鬼坦袍。 笑死十厢,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的捂齐。 我是一名探鬼主播蛮放,決...
    沈念sama閱讀 40,292評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼奠宜!你這毒婦竟也來了包颁?” 一聲冷哼從身側(cè)響起瞻想,我...
    開封第一講書人閱讀 39,211評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎娩嚼,沒想到半個月后蘑险,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,655評論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡岳悟,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,846評論 3 336
  • 正文 我和宋清朗相戀三年佃迄,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片贵少。...
    茶點(diǎn)故事閱讀 39,965評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡呵俏,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出春瞬,到底是詐尸還是另有隱情柴信,我是刑警寧澤,帶...
    沈念sama閱讀 35,684評論 5 347
  • 正文 年R本政府宣布宽气,位于F島的核電站随常,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏萄涯。R本人自食惡果不足惜绪氛,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,295評論 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望涝影。 院中可真熱鬧枣察,春花似錦、人聲如沸燃逻。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,894評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽伯襟。三九已至猿涨,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間姆怪,已是汗流浹背叛赚。 一陣腳步聲響...
    開封第一講書人閱讀 33,012評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留稽揭,地道東北人俺附。 一個月前我還...
    沈念sama閱讀 48,126評論 3 370
  • 正文 我出身青樓,卻偏偏與公主長得像溪掀,于是被迫代替她去往敵國和親事镣。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,914評論 2 355

推薦閱讀更多精彩內(nèi)容