SpringBoot 如何統一後端返回格式

来源:https://www.cnblogs.com/alanlin/archive/2022/04/25/16191008.html
-Advertisement-
Play Games

在前後端分離的項目中後端返回的格式一定要友好，不然會對前端的開發人員帶來很多的工作量。那麼SpringBoot如何做到統一的後端返回格式呢？今天我們一起來看看。 為什麼要對SpringBoot返回統一的標準格式 在預設情況下，SpringBoot的返回格式常見的有三種： 返回String @GetM ...


在前後端分離的項目中後端返回的格式一定要友好，不然會對前端的開發人員帶來很多的工作量。那麼SpringBoot如何做到統一的後端返回格式呢？今天我們一起來看看。

為什麼要對SpringBoot返回統一的標準格式

在預設情況下，SpringBoot的返回格式常見的有三種：

返回String

@GetMapping("/hello")
public String hello() {
    return  "hello";
}

此時調用介面獲取到的返回值是這樣：

hello

返回自定義對象

@GetMapping("/student")
public Student getStudent() {
        Student student = new Student();
        student.setId(1);
        student.setName("didiplus");
        return  student;
}


//student的類
@Data
public class Student {
    private Integer id;
    private String name;
}

此時調用介面獲取到的返回值是這樣：

{"id":1,"name":"didiplus"}

介面異常

@GetMapping("/error")
public int error(){
    int i = 9/0;
    return i;
}

此時調用介面獲取到的返回值是這樣：
image.png

SpringBoot的版本是v2.6.7，

定義返回對象

package com.didiplus.common.web.response;

import lombok.Data;

import java.io.Serializable;

/**
 * Author: didiplus
 * Email: [email protected]
 * CreateTime: 2022/4/24
 * Desc: Ajax 返 回 JSON 結 果 封 裝 數 據
 */

@Data
public class Result<T> implements Serializable {

    /**
     * 是否返回成功
     */
    private boolean success;

    /**
     * 錯誤狀態
     */
    private int code;

    /***
     * 錯誤信息
     */
    private String msg;

    /**
     * 返回數據
     */
    private T data;

    /**
     * 時間戳
     */
    private long timestamp ;


    public Result (){
        this.timestamp = System.currentTimeMillis();
    }
    /**
     * 成功的操作
     */
    public static <T> Result<T> success() {
        return  success(null);
    }

    /**
     * 成 功 操 作 , 攜 帶 數 據
     */
    public static <T> Result<T> success(T data){
        return success(ResultCode.RC100.getMessage(),data);
    }

    /**
     * 成 功 操 作, 攜 帶 消 息
     */
    public static <T> Result<T> success(String message) {
        return success(message, null);
    }

        /**
         * 成 功 操 作, 攜 帶 消 息 和 攜 帶 數 據
         */
    public static <T> Result<T> success(String message, T data) {
        return success(ResultCode.RC100.getCode(), message, data);
    }

    /**
     * 成 功 操 作, 攜 帶 自 定 義 狀 態 碼 和 消 息
     */
    public static <T> Result<T> success(int code, String message) {
        return success(code, message, null);
    }

    public static <T> Result<T> success(int code,String message,T data) {
        Result<T> result = new Result<T>();
        result.setCode(code);
        result.setMsg(message);
        result.setSuccess(true);
        result.setData(data);
        return result;
    }

    /**
     * 失 敗 操 作, 默 認 數 據
     */
    public static <T> Result<T> failure() {
        return failure(ResultCode.RC100.getMessage());
    }

    /**
     * 失 敗 操 作, 攜 帶 自 定 義 消 息
     */
    public static <T> Result<T> failure(String message) {
        return failure(message, null);
    }

    /**
     * 失 敗 操 作, 攜 帶 自 定 義 消 息 和 數 據
     */
    public static <T> Result<T> failure(String message, T data) {
        return failure(ResultCode.RC999.getCode(), message, data);
    }

    /**
     * 失 敗 操 作, 攜 帶 自 定 義 狀 態 碼 和 自 定 義 消 息
     */
    public static <T> Result<T> failure(int code, String message) {
        return failure(ResultCode.RC999.getCode(), message, null);
    }

    /**
     * 失 敗 操 作, 攜 帶 自 定 義 狀 態 碼 , 消 息 和 數 據
     */
    public static <T> Result<T> failure(int code, String message, T data) {
        Result<T> result = new Result<T>();
        result.setCode(code);
        result.setMsg(message);
        result.setSuccess(false);
        result.setData(data);
        return result;
    }

    /**
     * Boolean 返 回 操 作, 攜 帶 默 認 返 回 值
     */
    public static <T> Result<T> decide(boolean b) {
        return decide(b, ResultCode.RC100.getMessage(), ResultCode.RC999.getMessage());
    }

    /**
     * Boolean 返 回 操 作, 攜 帶 自 定 義 消 息
     */
    public static <T> Result<T> decide(boolean b, String success, String failure) {
        if (b) {
            return success(success);
        } else {
            return failure(failure);
        }
    }
}

定義狀態碼

package com.didiplus.common.web.response;

import lombok.Getter;

/**
 * Author: didiplus
 * Email: [email protected]
 * CreateTime: 2022/4/24
 * Desc: 統 一 返 回 狀 態 碼
 */
public enum ResultCode {
    /**操作成功**/
    RC100(100,"操作成功"),
    /**操作失敗**/
    RC999(999,"操作失敗"),
    /**服務限流**/
    RC200(200,"服務開啟限流保護,請稍後再試!"),
    /**服務降級**/
    RC201(201,"服務開啟降級保護,請稍後再試!"),
    /**熱點參數限流**/
    RC202(202,"熱點參數限流,請稍後再試!"),
    /**系統規則不滿足**/
    RC203(203,"系統規則不滿足要求,請稍後再試!"),
    /**授權規則不通過**/
    RC204(204,"授權規則不通過,請稍後再試!"),
    /**access_denied**/
    RC403(403,"無訪問許可權,請聯繫管理員授予許可權"),
    /**access_denied**/
    RC401(401,"匿名用戶訪問無許可權資源時的異常"),
    /**服務異常**/
    RC500(500,"系統異常，請稍後重試"),

    INVALID_TOKEN(2001,"訪問令牌不合法"),
    ACCESS_DENIED(2003,"沒有許可權訪問該資源"),
    CLIENT_AUTHENTICATION_FAILED(1001,"客戶端認證失敗"),
    USERNAME_OR_PASSWORD_ERROR(1002,"用戶名或密碼錯誤"),
    UNSUPPORTED_GRANT_TYPE(1003, "不支持的認證模式");

    /**自定義狀態碼**/
    @Getter
    private final int code;

    /**
     * 攜 帶 消 息
     */
    @Getter
    private final String message;
    /**
     * 構 造 方 法
     */
    ResultCode(int code, String message) {

        this.code = code;

        this.message = message;
    }
}

統一返回格式

    @GetMapping("/hello")
    public Result<String> hello() {
        return  Result.success("操作成功","hello");
    }

此時調用介面獲取到的返回值是這樣：

{"success":true,"code":100,"msg":"操作成功","data":"hello","timestamp":1650785058049}

這樣確實已經實現了我們想要的結果，我在很多項目中看到的都是這種寫法，在Controller層通過Result.success()對返回結果進行包裝後返回給前端。這樣顯得不夠專業而且不夠優雅。 所以呢我們需要對代碼進行優化，目標就是不要每個介面都手工制定Result返回值。

高級實現方式

要優化這段代碼很簡單，我們只需要藉助SpringBoot提供的ResponseBodyAdvice即可。

ResponseBodyAdvice的源碼：

public interface ResponseBodyAdvice<T> {
		/**
		* 是否支持advice功能
		* true 支持，false 不支持
		*/
    boolean supports(MethodParameter var1, Class<? extends HttpMessageConverter<?>> var2);

	  /**
		* 對返回的數據進行處理
		*/
    @Nullable
    T beforeBodyWrite(@Nullable T var1, MethodParameter var2, MediaType var3, Class<? extends HttpMessageConverter<?>> var4, ServerHttpRequest var5, ServerHttpResponse var6);
}

只需要編寫一個具體實現類即可

@RestControllerAdvice
public class ResponseAdvice  implements ResponseBodyAdvice<Object> {


    @Autowired
    ObjectMapper objectMapper;

    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        return true;
    }

    @SneakyThrows
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response)  {
        if (body instanceof  String){
            return objectMapper.writeValueAsString(Result.success(ResultCode.RC100.getMessage(),body));
        }
        return Result.success(ResultCode.RC100.getMessage(),body);
    }
}

需要註意兩個地方：
@RestControllerAdvice註解 @RestControllerAdvice是@RestController註解的增強，可以實現三個方面的功能：

  1. 全局異常處理
  2. 全局數據綁定
  3. 全局數據預處理

String類型判斷

        if (body instanceof  String){
            return objectMapper.writeValueAsString(Result.success(ResultCode.RC100.getMessage(),body));
        }

這段代碼一定要加，如果Controller直接返回String的話，SpringBoot是直接返回，故我們需要手動轉換成json。 經過上面的處理我們就再也不需要通過ResultData.success()來進行轉換了，直接返回原始數據格式，SpringBoot自動幫我們實現包裝類的封裝。

    @GetMapping("/hello")
    public String hello() {
        return "hello,didiplus";
    }


    @GetMapping("/student")
    public Student getStudent() {
        Student student = new Student();
        student.setId(1);
        student.setName("didiplus");
        return student;
    }

此時我們調用介面返回的數據結果為：

{
	"success": true,
	"code": 100,
	"msg": "操作成功",
	"data": "hello,didiplus",
	"timestamp": 1650786993454
}

本文來自博客園，作者：北根娃，轉載請註明原文鏈接：https://www.cnblogs.com/alanlin/p/16191008.html


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 【2022天梯賽】L1-081 今天我要贏
    L1-081 今天我要贏 #include <iostream> using namespace std; int main() { cout << "I'm gonna win! Today!\n2022-04-23"; } 2018 年我們曾經出過一題，是輸出“2018 我們要贏”。今年是 20 ...
  • Python爬取某短視頻熱點
    隨著短視頻的大火，不僅可以給人們帶來娛樂，還有熱點新聞時事以及各種知識，刷短視頻也逐漸成為了日常生活的一部分。本文以一個簡單的小例子，簡述如何通過Pyhton依托Selenium來爬取短視頻，僅供學習分享使用，如有不足之處，還請指正。 ...
  • OO第二單元總結
    OO第二單元電梯總結 架構模式 Hw5, Hw6, Hw7三次作業架構基本沒有巨大變化，屬於增量的疊加開發 hw5 一級生產者消費者模型with策略類分離 第一次作業， 我做了兩種架構的嘗試， 寫了： 調度線程祭天型 單托盤 帶調度器線程的兩級托盤 在嘗試寫了兩種架構的基礎上， 我分析了一下兩種架構 ...
  • 神奇的巨集定義
    今天的是Python第三話，前面的知識點給大家放在上面了，零基礎的小伙伴可以自己動手領取,學好Python的基礎知識對我們後期 去實現Python案例幫助很大，知其然才能更好解決問題，話不多說，直接開始了。 函數 Python學習交流Q群：906715085#### print(" 定義函數 "); ...
  • python如何實現網路測試，瞭解一下speedtest-cli...
    第二話來了 這一章的知識緊接上一章，零基礎的小伙伴可以從上 一章學起來。當然，你也可以收藏起來慢慢學習，學習是不可操之過急的啦… 列表 Python學習交流Q群：906715085### print(" 創建列表 "); list1 = ['JAVA', 'Hello', 'Python', 'VS ...
  • python數據處理-matplotlib入門(2)-利用隨機函數生成變化圖形
    綜合前述的類、函數、matplotlib等，完成一個隨機移動的過程（註意要確定移動的次數，比如10萬次），每次行走都完全是隨機的，沒有明確的方向，結果是由一系列隨機決策確定的，最後顯示出每次移動的位置的圖表。 思考： 1）每次走動多少個像素，由隨機函數決定，每次移動方向也隨機確定。由隨機方向和隨機像 ...
  • Spring Boot 怎麼做監控？這篇總算整明白了。。。
    作者：雙子孤狼 來源：https://blog.csdn.net/zwx900102/article/details/115446997 任何一個服務如果沒有監控，那就是兩眼一抹黑，無法知道當前服務的運行情況，也就無法對可能出現的異常狀況進行很好的處理，所以對任意一個服務來說，監控都是必不可少的。 ...
  • MyBatis:框架的搭建及測試
    1.開發環境 新建一個工程-配置jdk版本-配置maven 2.創建maven工程 修改打包方式為jar 導入依賴： <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" x ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類