spring boot 統(tǒng)一JSON格式的接口返回結(jié)果的實(shí)現(xiàn)
前后端分離的項(xiàng)目開發(fā)前,會(huì)提前規(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";
/**
* 錯(cuò)誤碼
*/
private int code = SUCCESS_CODE;
/**
* 錯(cuò)誤信息
*/
private String msg = SUCCESS_MSG;
/**
* 響應(yīng)內(nèi)容,默認(rèn)為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 錯(cuò)誤類型
*/
public static ApiResp retFail(BaseEnumError error) {
return retFail(error.getCode(), error.getMsg());
}
/**
* 有data的失敗返回
*
* @param error 錯(cuò)誤類型
* @param data 詳細(xì)錯(cuò)誤信息
*/
public static <T> ApiResp<T> retFail(BaseEnumError error, T data) {
return retFail(error.getCode(), error.getMsg(), data);
}
/**
* 無data的失敗返回
*
* @param code 錯(cuò)誤碼
* @param msg 錯(cuò)誤信息
*/
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>
* 失敗返回的場(chǎng)景不多,所以沒有嚴(yán)格要求T泛型
*
* @param code 錯(cuò)誤碼
* @param msg 錯(cuò)誤信息
*/
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)容如下:


當(dāng)然,ApiResp中的泛型,也可以使用復(fù)雜的數(shù)據(jù)對(duì)象。實(shí)際開發(fā)中,每種錯(cuò)誤響應(yīng)都有自己的響應(yīng)碼code,和錯(cuò)誤信息msg,示例中統(tǒng)一定義了一個(gè)BaseEnumError的枚舉類,具體內(nèi)容可參照我的github項(xiàng)目https://github.com/ye17186/myhelper-spring-boot-starter
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
Java調(diào)用C++程序的實(shí)現(xiàn)方式
這篇文章主要介紹了Java調(diào)用C++程序的實(shí)現(xiàn)方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-02-02
Java項(xiàng)目如何打包成Jar的實(shí)現(xiàn)步驟
一般情況下我們都是使用Java項(xiàng)目直接部署發(fā)布,有時(shí)需要我們將寫好的項(xiàng)目打成jar包,方便后期調(diào)用,本文主要介紹了Java項(xiàng)目如何打包成Jar,感興趣的可以了解一下2023-11-11
MyBatisPlus標(biāo)準(zhǔn)數(shù)據(jù)層CRUD的使用詳解
這篇文章主要介紹了MyBatisPlus標(biāo)準(zhǔn)數(shù)據(jù)層CRUD的使用,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2022-07-07
java.lang.NumberFormatException異常解決方案詳解
這篇文章主要介紹了java.lang.NumberFormatException異常解決方案詳解,本篇文章通過簡(jiǎn)要的案例,講解了該項(xiàng)技術(shù)的了解與使用,以下就是詳細(xì)內(nèi)容,需要的朋友可以參考下2021-08-08
詳解Spring Boot中整合Sharding-JDBC讀寫分離示例
這篇文章主要介紹了詳解Spring Boot中整合Sharding-JDBC讀寫分離示例,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2019-03-03
Spring中的@Autowired注解深入解析與實(shí)戰(zhàn)指南
本文介紹了Spring框架中的@Autowired注解,詳細(xì)講解了其基本用法、高級(jí)用法以及實(shí)際應(yīng)用場(chǎng)景,通過@Autowired注解,Spring容器可以自動(dòng)將依賴的Bean注入到目標(biāo)Bean中,從而簡(jiǎn)化代碼并提高可維護(hù)性,需要的朋友可以參考下2024-11-11
Java實(shí)現(xiàn)的打地鼠小游戲完整示例【附源碼下載】
這篇文章主要介紹了Java實(shí)現(xiàn)的打地鼠小游戲,結(jié)合完整實(shí)例形式分析了Java多線程操作及鍵盤按鍵響應(yīng)實(shí)現(xiàn)的打地鼠游戲功能相關(guān)操作技巧,需要的朋友可以參考下2018-07-07

