Java設計 API 接口如何實現統一格式返回

這篇文章將為大家詳細講解有關Java設計 API 接口如何實現統一格式返回，文章內容質量較高，因此小編分享給大家做個參考，希望大家閱讀完這篇文章后對相關知識有一定的了解。

在移動互聯網，分布式、微服務盛行的今天，現在項目絕大部分都采用的微服務框架，前后端分離方式，

（題外話：前后端的工作職責越來越明確，現在的前端都稱之為大前端，技術棧以及生態圈都已經非常成熟；以前后端人員瞧不起前端人員，那現在后端人員要重新認識一下前端，前端已經很成體系了）

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

需要說明的是，有些小伙伴會回復說，這個架構太簡單了吧，太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 - 內部服務器錯誤

再在枚舉中定義，狀態碼

控制層Controller

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

那我們來改造一下Controller

這個和我們平時的代碼是一樣的，非常直觀，直接返回order對象，這樣是不是很完美。

那實現方案是什么呢？

實現方案

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

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

2. 攔截請求，判斷此請求是否需要被@ResponseResult注解

3. 核心步驟就是實現接口ResponseBodyAdvice和@ControllerAdvice，判斷是否需要包裝返回值，如果需要，就把Controller接口的返回值進行重寫。

注解類

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

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

重寫返回體

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

重寫Controller

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

這個方案還有沒有別的優化空間，當然是有的。

如：每次請求都要反射一下，獲取請求的方法是否需要包裝，其實可以做個緩存，不需要每次都需要解析。

關于Java設計 API 接口如何實現統一格式返回就分享到這里了，希望以上內容可以對大家有一定的幫助，可以學到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。