SpringBoot 統(tǒng)一請(qǐng)求返回的實(shí)現(xiàn)
目前我們的返回是直接把實(shí)體類扔給請(qǐng)求方,這樣很不友好,一方面沒(méi)有統(tǒng)一的格式,二來(lái)請(qǐng)求方不知道請(qǐng)求成功與否,沒(méi)有一個(gè)可以判斷的東西,也沒(méi)有說(shuō)明性的返回。
本篇就來(lái)為所有接口提供一個(gè)統(tǒng)一的友好返回。
確定返回結(jié)構(gòu)
首先,我們先確定好我們接口返回的格式是什么樣的,然后再一步一步實(shí)現(xiàn)下面的。
{ "code": 200, "msg": "ok", "data": "" }
- code 字段表示狀態(tài)碼,調(diào)用方根據(jù)該碼來(lái)作為后續(xù)邏輯的依據(jù),比如 code 值為 200 表示操作成功,沒(méi)有邏輯錯(cuò)誤,此時(shí)可以提示用戶操作成功等;code 值不為 200 表示操作失敗,比如為 1001 ,表示用戶名已存在,此時(shí)前端做一些相應(yīng)操作。
- msg 字段用來(lái)充當(dāng)額外說(shuō)明,比如上面說(shuō)的狀態(tài)為 1001,這里的 msg 就可以是 username exists 這樣的說(shuō)明性文字,幫助調(diào)用方更好的理解。
- data 字段一般是在 code 值為 200 的時(shí)候,返回具體的業(yè)務(wù)數(shù)據(jù),可以是數(shù)組,也可以是對(duì)象。
創(chuàng)建返回碼
根據(jù)上面定的返回結(jié)構(gòu),我們可以把 code 和 msg 字段用枚舉類型整合,在項(xiàng)目中創(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; } }
之后每有一個(gè)不同的錯(cuò)誤代碼都需要在這里加上,然后調(diào)用這里的枚舉變量。可能會(huì)有點(diǎn)繁瑣,但當(dāng)項(xiàng)目逐漸大起來(lái)以后,這樣做就能很好的管理狀態(tài)碼。
創(chuàng)建返回類
在項(xià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; /** * 自定義返回說(shuō)明 */ private String msg; /** * 返回?cái)?shù)據(jù) */ private T data; /** * 成功返回,無(wú)數(shù)據(jù) * * @return 自定義的 ApiResponse 對(duì)象 */ public static ApiResponse<Object> success() { return new ApiResponse<>(ApiCode.API_OK.code(), ApiCode.API_OK.getMsg(), ""); } /** * 成功返回,有數(shù)據(jù) * * @param object 返回?cái)?shù)據(jù) * @param <T> 返回?cái)?shù)據(jù)類型 * @return 自定義的 ApiResponse 對(duì)象 */ public static <T> ApiResponse<T> success(T object) { return new ApiResponse<>(ApiCode.API_OK.code(), ApiCode.API_OK.getMsg(), object); } /** * 失敗返回 * * @param apiCode 錯(cuò)誤碼 * @return 自定義的 ApiResponse 對(duì)象 */ public static ApiResponse<Object> fail(ApiCode apiCode) { return new ApiResponse<>(apiCode.code(), apiCode.getMsg(), ""); } }
使用返回類
我們修改一下 Controller 里面的接口返回,現(xiàn)在不是直接返回實(shí)體類了,而是封裝成我們的返回類,再返回給調(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)一請(qǐng)求返回的實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)SpringBoot 統(tǒng)一請(qǐng)求返回內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Java算法練習(xí)題,每天進(jìn)步一點(diǎn)點(diǎn)(1)
方法下面小編就為大家?guī)?lái)一篇Java算法的一道練習(xí)題(分享)。小編覺得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧,希望可以幫到你2021-07-07Java中生成微信小程序太陽(yáng)碼的實(shí)現(xiàn)方案
這篇文章主要介紹了Java中生成微信小程序太陽(yáng)碼的實(shí)現(xiàn)方案,本文講解了如何生成微信小程序太陽(yáng)碼,通過(guò)微信提供的兩種方案都可以實(shí)現(xiàn),在實(shí)際的項(xiàng)目中建議采用第二種方案,需要的朋友可以參考下2022-05-05聊聊maven的pom.xml中的exclusions標(biāo)簽的作用
這篇文章主要介紹了maven的pom.xml中的exclusions標(biāo)簽的作用,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-12-12Java ShardingJDBC實(shí)戰(zhàn)演練
Sharding-JDBC 采用在 JDBC 協(xié)議層擴(kuò)展分庫(kù)分表,是一個(gè)以 jar 形式提供服務(wù)的輕量級(jí)組件,其核心思路是小而美地完成最核心的事情2021-11-11java通過(guò)jni調(diào)用opencv處理圖像的方法
今天小編就為大家分享一篇java通過(guò)jni調(diào)用opencv處理圖像的方法,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2018-08-08SpringBoot使用@Async注解可能會(huì)遇到的8大坑點(diǎn)匯總
SpringBoot中,@Async注解可以實(shí)現(xiàn)異步線程調(diào)用,用法簡(jiǎn)單,體驗(yàn)舒適,但是你一定碰到過(guò)異步調(diào)用不生效的情況,今天,我就列出90%的人都可能會(huì)遇到的8大坑點(diǎn),需要的朋友可以參考下2023-09-09SpringBoot實(shí)現(xiàn)類似鉤子函數(shù)的方法
這篇文章主要給大家介紹了關(guān)于SpringBoot實(shí)現(xiàn)類似鉤子函數(shù)的方法,文中通過(guò)代碼示例介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2024-04-04