詳解SpringBoot如何實(shí)現(xiàn)統(tǒng)一后端返回格式

更新時(shí)間：2022年04月26日 11:35:29 作者：北根娃

在前后端分離的項(xiàng)目中后端返回的格式一定要友好，不然會(huì)對(duì)前端的開發(fā)人員帶來很多的工作量。那么SpringBoot如何做到統(tǒng)一的后端返回格式呢？本文將為大家詳細(xì)講講

1.為什么要對(duì)SpringBoot返回統(tǒng)一的標(biāo)準(zhǔn)格式

在默認(rèn)情況下，SpringBoot的返回格式常見的有三種：

1.1 返回String

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

此時(shí)調(diào)用接口獲取到的返回值是這樣：

hello

1.2 返回自定義對(duì)象

@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;
}

此時(shí)調(diào)用接口獲取到的返回值是這樣：

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

1.3 接口異常

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

此時(shí)調(diào)用接口獲取到的返回值是這樣

SpringBoot的版本是v2.6.7，

2.定義返回對(duì)象

package com.didiplus.common.web.response;

import lombok.Data;

import java.io.Serializable;

/**
 * Author: didiplus
 * Email: 972479352@qq.com
 * CreateTime: 2022/4/24
 * Desc: Ajax 返 回 JSON 結(jié) 果 封 裝 數(shù) 據(jù)
 */

@Data
public class Result<T> implements Serializable {

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

    /**
     * 錯(cuò)誤狀態(tài)
     */
    private int code;

    /***
     * 錯(cuò)誤信息
     */
    private String msg;

    /**
     * 返回?cái)?shù)據(jù)
     */
    private T data;

    /**
     * 時(shí)間戳
     */
    private long timestamp ;


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

    /**
     * 成 功 操 作 , 攜 帶 數(shù) 據(jù)
     */
    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);
    }

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

    /**
     * 成 功 操 作, 攜 帶 自 定 義 狀 態(tài) 碼 和 消 息
     */
    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;
    }

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

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

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

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

    /**
     * 失 敗 操 作, 攜 帶 自 定 義 狀 態(tài) 碼 , 消 息 和 數(shù) 據(jù)
     */
    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 返 回 操 作, 攜 帶 默 認(rèn) 返 回 值
     */
    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);
        }
    }
}

3.定義狀態(tài)碼

package com.didiplus.common.web.response;

import lombok.Getter;

/**
 * Author: didiplus
 * Email: 972479352@qq.com
 * CreateTime: 2022/4/24
 * Desc: 統(tǒng) 一 返 回 狀 態(tài) 碼
 */
public enum ResultCode {
    /**操作成功**/
    RC100(100,"操作成功"),
    /**操作失敗**/
    RC999(999,"操作失敗"),
    /**服務(wù)限流**/
    RC200(200,"服務(wù)開啟限流保護(hù),請(qǐng)稍后再試!"),
    /**服務(wù)降級(jí)**/
    RC201(201,"服務(wù)開啟降級(jí)保護(hù),請(qǐng)稍后再試!"),
    /**熱點(diǎn)參數(shù)限流**/
    RC202(202,"熱點(diǎn)參數(shù)限流,請(qǐng)稍后再試!"),
    /**系統(tǒng)規(guī)則不滿足**/
    RC203(203,"系統(tǒng)規(guī)則不滿足要求,請(qǐng)稍后再試!"),
    /**授權(quán)規(guī)則不通過**/
    RC204(204,"授權(quán)規(guī)則不通過,請(qǐng)稍后再試!"),
    /**access_denied**/
    RC403(403,"無訪問權(quán)限,請(qǐng)聯(lián)系管理員授予權(quán)限"),
    /**access_denied**/
    RC401(401,"匿名用戶訪問無權(quán)限資源時(shí)的異常"),
    /**服務(wù)異常**/
    RC500(500,"系統(tǒng)異常，請(qǐng)稍后重試"),

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

    /**自定義狀態(tài)碼**/
    @Getter
    private final int code;

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

        this.code = code;

        this.message = message;
    }
}

4.統(tǒng)一返回格式

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

此時(shí)調(diào)用接口獲取到的返回值是這樣：

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

這樣確實(shí)已經(jīng)實(shí)現(xiàn)了我們想要的結(jié)果，我在很多項(xiàng)目中看到的都是這種寫法，在Controller層通過Result.success()對(duì)返回結(jié)果進(jìn)行包裝后返回給前端。這樣顯得不夠?qū)I(yè)而且不夠優(yōu)雅。所以呢我們需要對(duì)代碼進(jìn)行優(yōu)化，目標(biāo)就是不要每個(gè)接口都手工制定Result返回值。

5.高級(jí)實(shí)現(xiàn)方式

要優(yōu)化這段代碼很簡單，我們只需要借助SpringBoot提供的ResponseBodyAdvice即可。

5.1 ResponseBodyAdvice的源碼

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

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

只需要編寫一個(gè)具體實(shí)現(xiàn)類即可

@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);
    }
}

需要注意兩個(gè)地方：

@RestControllerAdvice注解 @RestControllerAdvice是@RestController注解的增強(qiáng)，可以實(shí)現(xiàn)三個(gè)方面的功能：

全局異常處理
全局?jǐn)?shù)據(jù)綁定
全局?jǐn)?shù)據(jù)預(yù)處理

5.2 String類型判斷

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

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

    @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;
    }

此時(shí)我們調(diào)用接口返回的數(shù)據(jù)結(jié)果為：