欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

spring boot 統(tǒng)一JSON格式的接口返回結(jié)果的實現(xiàn)

 更新時間:2019年10月08日 15:30:52   作者:ye17186  
這篇文章主要介紹了spring boot 統(tǒng)一JSON格式的接口返回結(jié)果的實現(xiàn),文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

前后端分離的項目開發(fā)前,會提前規(guī)定好數(shù)據(jù)返回格式,本文以JSON為例。

第一步,定義好JavaBean。

package com.yclouds.myhelper.web.response;
 
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.yclouds.myhelper.web.error.code.BaseEnumError;
import java.io.Serializable;
import lombok.Data;
 
/**
 * 所有服務(wù)統(tǒng)一響應(yīng)數(shù)據(jù)格式
 *
 * @author ye17186
 * @version 2019/2/15 14:40
 */
@Data
public class ApiResp<T> implements Serializable {
 
  private static final long serialVersionUID = 9211889136173018364L;
 
  /**
   * 正常響應(yīng)碼
   */
  private static final int SUCCESS_CODE = 0;
 
  /**
   * 正常響應(yīng)消息
   */
  private static final String SUCCESS_MSG = "SUCCESS";
 
  /**
   * 錯誤碼
   */
  private int code = SUCCESS_CODE;
 
  /**
   * 錯誤信息
   */
  private String msg = SUCCESS_MSG;
 
  /**
   * 響應(yīng)內(nèi)容,默認為null
   */
  private T data = null;
 
  /**
   * 是否的正常響應(yīng)
   *
   * @return true=正常;false=異常
   */
  @JsonIgnore
  public boolean isOK() {
    return code == SUCCESS_CODE;
  }
 
  /**
   * 無data的正常返回
   */
  public static ApiResp retOK() {
    return new ApiResp();
  }
 
  /**
   * 有data的正常返回
   *
   * @param data data內(nèi)容
   * @param <T> data類型
   */
  public static <T> ApiResp<T> retOK(T data) {
    ApiResp<T> response = new ApiResp<>();
    response.setData(data);
    return response;
  }
 
  /**
   * 無data的失敗返回
   *
   * @param error 錯誤類型
   */
  public static ApiResp retFail(BaseEnumError error) {
    return retFail(error.getCode(), error.getMsg());
  }
 
  /**
   * 有data的失敗返回
   *
   * @param error 錯誤類型
   * @param data 詳細錯誤信息
   */
  public static <T> ApiResp<T> retFail(BaseEnumError error, T data) {
    return retFail(error.getCode(), error.getMsg(), data);
  }
 
  /**
   * 無data的失敗返回
   *
   * @param code 錯誤碼
   * @param msg 錯誤信息
   */
  public static <T> ApiResp<T> retFail(int code, String msg) {
    ApiResp<T> response = new ApiResp<>();
    response.setCode(code);
    response.setMsg(msg);
    return response;
  }
 
  /**
   * 有data的失敗返回
   * <br>
   * 失敗返回的場景不多,所以沒有嚴格要求T泛型
   *
   * @param code 錯誤碼
   * @param msg 錯誤信息
   */
  public static <T> ApiResp<T> retFail(int code, String msg, T data) {
    ApiResp<T> response = new ApiResp<>();
    response.setCode(code);
    response.setMsg(msg);
    response.setData(data);
    return response;
  }
}

第二步,在Controller中使用

  @GetMapping("/test1")
  public ApiResp test1() {
 
    return ApiResp.retOK("Hello World");
  }
 
  @GetMapping("/test2")
  public ApiResp test2() {
 
    return ApiResp.retFail(BaseEnumError.SYSTEM_NO_LOGIN);
  }

可以在Postman查看具體的響應(yīng)內(nèi)容如下:

當然,ApiResp中的泛型,也可以使用復(fù)雜的數(shù)據(jù)對象。實際開發(fā)中,每種錯誤響應(yīng)都有自己的響應(yīng)碼code,和錯誤信息msg,示例中統(tǒng)一定義了一個BaseEnumError的枚舉類,具體內(nèi)容可參照我的github項目https://github.com/ye17186/myhelper-spring-boot-starter

以上就是本文的全部內(nèi)容,希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。

相關(guān)文章

  • mybatisplus解除分頁限制的實現(xiàn)

    mybatisplus解除分頁限制的實現(xiàn)

    這篇文章主要介紹了mybatisplus解除分頁限制的實現(xiàn),文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
    2020-12-12
  • SpringCloud Finchley Gateway 緩存請求Body和Form表單的實現(xiàn)

    SpringCloud Finchley Gateway 緩存請求Body和Form表單的實現(xiàn)

    在接入Spring-Cloud-Gateway時,可能有需求進行緩存Json-Body數(shù)據(jù)或者Form-Urlencoded數(shù)據(jù)的情況。這篇文章主要介紹了SpringCloud Finchley Gateway 緩存請求Body和Form表單的實現(xiàn),感興趣的小伙伴們可以參考一下
    2019-01-01
  • Java源碼解析HashMap的tableSizeFor函數(shù)

    Java源碼解析HashMap的tableSizeFor函數(shù)

    今天小編就為大家分享一篇關(guān)于Java源碼解析HashMap的tableSizeFor函數(shù),小編覺得內(nèi)容挺不錯的,現(xiàn)在分享給大家,具有很好的參考價值,需要的朋友一起跟隨小編來看看吧
    2019-01-01
  • Java類的訪問權(quán)限關(guān)鍵字用法說明

    Java類的訪問權(quán)限關(guān)鍵字用法說明

    這篇文章主要介紹了Java類的訪問權(quán)限關(guān)鍵字用法說明,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧
    2020-09-09
  • servlet3文件上傳操作

    servlet3文件上傳操作

    這篇文章主要介紹了servlet3文件上傳操作的相關(guān)資料,需要的朋友可以參考下
    2017-11-11
  • 淺談java獲取服務(wù)器基本信息

    淺談java獲取服務(wù)器基本信息

    這篇文章主要介紹了java獲取服務(wù)器基本信息,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
    2019-03-03
  • SpringBoot整合阿里云短信服務(wù)的案例代碼

    SpringBoot整合阿里云短信服務(wù)的案例代碼

    這篇文章主要介紹了SpringBoot整合阿里云短信服務(wù)的案例代碼,在Spring Boot項目的pom.xml文件中添加阿里云短信服務(wù)SDK的依賴,本文通過示例代碼給大家介紹的非常詳細,需要的朋友參考下吧
    2024-06-06
  • Java生成表格圖片的實例代碼

    Java生成表格圖片的實例代碼

    這篇文章主要介紹了Java生成表格圖片的實例代碼,幫助大家更好的理解和學(xué)習(xí)Java,感興趣的朋友可以了解下
    2020-09-09
  • Spring Boot自定義配置實現(xiàn)IDE自動提示功能

    Spring Boot自定義配置實現(xiàn)IDE自動提示功能

    這篇文章主要介紹了Spring Boot自定義配置實現(xiàn)IDE自動提示功能,本文圖文并茂給大家介紹的非常詳細,具有一定的參考借鑒價值,需要的朋友可以參考下
    2019-08-08
  • Java?Guava的使用技巧整理

    Java?Guava的使用技巧整理

    Guava是Google發(fā)布的一個開源庫,主要提供了一些在Java開發(fā)中非常有用的工具類和API,不管是工作還是學(xué)習(xí)都是非常值得我們?nèi)ナ煜さ模黄饋砜纯窗?/div> 2023-03-03

最新評論