目錄

1、為什么要設計返回體？

2、返回體包含哪些內容（如何設計）？

舉例

3、總結

---

1、為什么要設計返回體？

????????在設計后端返回給前端的返回體時，通常需要遵循一定的規范，以確保前后端交互的清晰性、可維護性和可擴展性。

2、返回體包含哪些內容（如何設計）？

返回體通常包含以下內容：

• code: 狀態碼，用于表示請求的處理結果（如成功、失敗、異常等）。
• message: 消息描述，用于對狀態碼的補充說明（如錯誤原因、成功提示等）。
• data: 返回的具體數據，可以是對象、數組或其他數據類型。
• timestamp: 時間戳，表示返回體的生成時間（可選，用于調試或日志記錄）。（可選）

舉例

在utils工具包下，新建一個類：Result。

此類專門用來生成對象，返回給前端。

@Data//lombok提供的一個注解，自動生成get、set方法
public class Result<T> {//屬性private int code;//狀態碼，如：404代表資源未找到private String message;//描述消息，如：前端請求成功是，message為“操作成功”private T data;//返回的具體數據,用泛型可以接收各類的對象//提供幾種構造器，以應對不同的場景//無參構造public Result() {}//code + message  舉例：前端請求失敗時，返回401 + “用戶未登錄”public Result(int code, String message) {this.code = code;this.message = message;}//code + datapublic Result(int code, T data) {this.code = code;this.data = data;}//全參構造器public Result(int code, String message, T data) {this.code = code;this.message = message;this.data = data;}
}

3、總結

一個良好的返回體設計應具備以下特點：

1. 結構清晰：明確區分狀態碼、消息和數據。
2. 狀態碼規范：使用 HTTP 狀態碼或自定義狀態碼。
3. 消息友好：提供明確的成功或錯誤提示。
4. 數據靈活：根據業務需求返回不同類型的數據。
5. 異常處理：對異常情況提供明確的錯誤信息。

通過遵循這些原則，可以顯著提高前后端協作的效率和質量。

?

希望本篇文章能幫到你的，喜歡的話留個關注呦~~