快捷導(dǎo)航

SpringBoot 統(tǒng)一請求返回的實現(xiàn)

更新時間：2020年07月15日 09:17:05 作者：阿亮叨逼叨

這篇文章主要介紹了SpringBoot 統(tǒng)一請求返回的實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

目前我們的返回是直接把實體類扔給請求方，這樣很不友好，一方面沒有統(tǒng)一的格式，二來請求方不知道請求成功與否，沒有一個可以判斷的東西，也沒有說明性的返回。

本篇就來為所有接口提供一個統(tǒng)一的友好返回。

確定返回結(jié)構(gòu)

首先，我們先確定好我們接口返回的格式是什么樣的，然后再一步一步實現(xiàn)下面的。

{
 "code": 200,
  "msg": "ok",
  "data": ""
}

code 字段表示狀態(tài)碼，調(diào)用方根據(jù)該碼來作為后續(xù)邏輯的依據(jù)，比如 code 值為 200 表示操作成功，沒有邏輯錯誤，此時可以提示用戶操作成功等；code 值不為 200 表示操作失敗，比如為 1001 ，表示用戶名已存在，此時前端做一些相應(yīng)操作。
msg 字段用來充當額外說明，比如上面說的狀態(tài)為 1001，這里的 msg 就可以是 username exists 這樣的說明性文字，幫助調(diào)用方更好的理解。
data 字段一般是在 code 值為 200 的時候，返回具體的業(yè)務(wù)數(shù)據(jù)，可以是數(shù)組，也可以是對象。

創(chuàng)建返回碼

根據(jù)上面定的返回結(jié)構(gòu)，我們可以把 code 和 msg 字段用枚舉類型整合，在項目中創(chuàng)建 common 目錄，新建 ApiCode.java 如下代碼所示：

package com.foxescap.wxbox.common;

/**
 * 全局接口狀態(tài)碼
 * @author xfly
 */
public enum ApiCode {
  /**
   * 通用成功
   */
  API_OK(200, "ok"),
  /**
   * 用戶名已存在
   */
  API_USERNAME_EXIST(1001, "username exists");

  private final int code;

  private final String msg;

  ApiCode(int code, String msg) {
    this.code = code;
    this.msg = msg;
  }

  public int code() {
    return this.code;
  }

  public String getMsg() {
    return this.msg;
  }
}

之后每有一個不同的錯誤代碼都需要在這里加上，然后調(diào)用這里的枚舉變量?？赡軙悬c繁瑣，但當項目逐漸大起來以后，這樣做就能很好的管理狀態(tài)碼。

創(chuàng)建返回類

在項目中創(chuàng)建 common 目錄，新建 HttpResponse.java 文件：

package com.foxescap.wxbox.common;

import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import lombok.AllArgsConstructor;
import lombok.Data;

import java.io.Serializable;

/**
 * @author xfly
 * @param <T>
 */
@Data
@AllArgsConstructor
@JsonPropertyOrder({"code", "msg", "data"})
public class ApiResponse<T> implements Serializable {
  private static final long serialVersionUID = 1L;

  /**
   * 自定義返回碼
   */
  private int code;

  /**
   * 自定義返回說明
   */
  private String msg;

  /**
   * 返回數(shù)據(jù)
   */
  private T data;

  /**
   * 成功返回，無數(shù)據(jù)
   *
   * @return 自定義的 ApiResponse 對象
   */
  public static ApiResponse<Object> success() {
    return new ApiResponse<>(ApiCode.API_OK.code(), ApiCode.API_OK.getMsg(), "");
  }

  /**
   * 成功返回，有數(shù)據(jù)
   *
   * @param object 返回數(shù)據(jù)
   * @param <T>  返回數(shù)據(jù)類型
   * @return 自定義的 ApiResponse 對象
   */
  public static <T> ApiResponse<T> success(T object) {
    return new ApiResponse<>(ApiCode.API_OK.code(), ApiCode.API_OK.getMsg(), object);
  }

  /**
   * 失敗返回
   *
   * @param apiCode 錯誤碼
   * @return 自定義的 ApiResponse 對象
   */
  public static ApiResponse<Object> fail(ApiCode apiCode) {
    return new ApiResponse<>(apiCode.code(), apiCode.getMsg(), "");
  }
}

使用返回類

我們修改一下 Controller 里面的接口返回，現(xiàn)在不是直接返回實體類了，而是封裝成我們的返回類，再返回給調(diào)用方：

@GetMapping("/user/{username}")
public ApiResponse<User> findUserByUsername(@PathVariable(name = "username") String username) {
  return ApiResponse.success(userService.findByUsername(username));
}

到此這篇關(guān)于SpringBoot 統(tǒng)一請求返回的實現(xiàn)的文章就介紹到這了,更多相關(guān)SpringBoot 統(tǒng)一請求返回內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: