在前后端分離的專案中后端回傳的格式一定要友好，不然會對前端的開發人員帶來很多的作業量，那么SpringBoot如何做到統一的后端回傳格式呢？今天我們一起來看看，
為什么要對SpringBoot回傳統一的標準格式
在默認情況下，SpringBoot的回傳格式常見的有三種：
回傳String
@GetMapping("/hello")
public String hello() {
return "hello";
}
此時呼叫介面獲取到的回傳值是這樣：
hello
回傳自定義物件
@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;
}
此時呼叫介面獲取到的回傳值是這樣：
{"id":1,"name":"didiplus"}
介面例外
@GetMapping("/error")
public int error(){
int i = 9/0;
return i;
}
此時呼叫介面獲取到的回傳值是這樣：
SpringBoot的版本是v2.6.7，
定義回傳物件
package com.didiplus.common.web.response;
import lombok.Data;
import java.io.Serializable;
/**
* Author: didiplus
* Email: [email protected]
* CreateTime: 2022/4/24
* Desc: Ajax 返 回 JSON 結 果 封 裝 數 據
*/
@Data
public class Result<T> implements Serializable {
/**
* 是否回傳成功
*/
private boolean success;
/**
* 錯誤狀態
*/
private int code;
/***
* 錯誤資訊
*/
private String msg;
/**
* 回傳資料
*/
private T data;
/**
* 時間戳
*/
private long timestamp ;
public Result (){
this.timestamp = System.currentTimeMillis();
}
/**
* 成功的操作
*/
public static <T> Result<T> success() {
return success(null);
}
/**
* 成 功 操 作 , 攜 帶 數 據
*/
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);
}
/**
* 成 功 操 作, 攜 帶 消 息 和 攜 帶 數 據
*/
public static <T> Result<T> success(String message, T data) {
return success(ResultCode.RC100.getCode(), message, data);
}
/**
* 成 功 操 作, 攜 帶 自 定 義 狀 態 碼 和 消 息
*/
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;
}
/**
* 失 敗 操 作, 默 認 數 據
*/
public static <T> Result<T> failure() {
return failure(ResultCode.RC100.getMessage());
}
/**
* 失 敗 操 作, 攜 帶 自 定 義 消 息
*/
public static <T> Result<T> failure(String message) {
return failure(message, null);
}
/**
* 失 敗 操 作, 攜 帶 自 定 義 消 息 和 數 據
*/
public static <T> Result<T> failure(String message, T data) {
return failure(ResultCode.RC999.getCode(), message, data);
}
/**
* 失 敗 操 作, 攜 帶 自 定 義 狀 態 碼 和 自 定 義 消 息
*/
public static <T> Result<T> failure(int code, String message) {
return failure(ResultCode.RC999.getCode(), message, null);
}
/**
* 失 敗 操 作, 攜 帶 自 定 義 狀 態 碼 , 消 息 和 數 據
*/
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 返 回 操 作, 攜 帶 默 認 返 回 值
*/
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);
}
}
}
定義狀態碼
package com.didiplus.common.web.response;
import lombok.Getter;
/**
* Author: didiplus
* Email: [email protected]
* CreateTime: 2022/4/24
* Desc: 統 一 返 回 狀 態 碼
*/
public enum ResultCode {
/**操作成功**/
RC100(100,"操作成功"),
/**操作失敗**/
RC999(999,"操作失敗"),
/**服務限流**/
RC200(200,"服務開啟限流保護,請稍后再試!"),
/**服務降級**/
RC201(201,"服務開啟降級保護,請稍后再試!"),
/**熱點引數限流**/
RC202(202,"熱點引數限流,請稍后再試!"),
/**系統規則不滿足**/
RC203(203,"系統規則不滿足要求,請稍后再試!"),
/**授權規則不通過**/
RC204(204,"授權規則不通過,請稍后再試!"),
/**access_denied**/
RC403(403,"無訪問權限,請聯系管理員授予權限"),
/**access_denied**/
RC401(401,"匿名用戶訪問無權限資源時的例外"),
/**服務例外**/
RC500(500,"系統例外，請稍后重試"),
INVALID_TOKEN(2001,"訪問令牌不合法"),
ACCESS_DENIED(2003,"沒有權限訪問該資源"),
CLIENT_AUTHENTICATION_FAILED(1001,"客戶端認證失敗"),
USERNAME_OR_PASSWORD_ERROR(1002,"用戶名或密碼錯誤"),
UNSUPPORTED_GRANT_TYPE(1003, "不支持的認證模式");
/**自定義狀態碼**/
@Getter
private final int code;
/**
* 攜 帶 消 息
*/
@Getter
private final String message;
/**
* 構 造 方 法
*/
ResultCode(int code, String message) {
this.code = code;
this.message = message;
}
}
統一回傳格式
@GetMapping("/hello")
public Result<String> hello() {
return Result.success("操作成功","hello");
}
此時呼叫介面獲取到的回傳值是這樣：
{"success":true,"code":100,"msg":"操作成功","data":"hello","timestamp":1650785058049}
這樣確實已經實作了我們想要的結果，我在很多專案中看到的都是這種寫法，在Controller層通過Result.success()對回傳結果進行包裝后回傳給前端，這樣顯得不夠專業而且不夠優雅， 所以呢我們需要對代碼進行優化，目標就是不要每個介面都手工制定Result回傳值，
高級實作方式
要優化這段代碼很簡單，我們只需要借助SpringBoot提供的ResponseBodyAdvice即可，
ResponseBodyAdvice的原始碼：
public interface ResponseBodyAdvice<T> {
/**
* 是否支持advice功能
* true 支持，false 不支持
*/
boolean supports(MethodParameter var1, Class<? extends HttpMessageConverter<?>> var2);
/**
* 對回傳的資料進行處理
*/
@Nullable
T beforeBodyWrite(@Nullable T var1, MethodParameter var2, MediaType var3, Class<? extends HttpMessageConverter<?>> var4, ServerHttpRequest var5, ServerHttpResponse var6);
}
只需要撰寫一個具體實作類即可
@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);
}
}
需要注意兩個地方：
@RestControllerAdvice注解 @RestControllerAdvice是@RestController注解的增強，可以實作三個方面的功能：
- 全域例外處理
- 全域資料系結
- 全域資料預處理
String型別判斷
if (body instanceof String){
return objectMapper.writeValueAsString(Result.success(ResultCode.RC100.getMessage(),body));
}
這段代碼一定要加，如果Controller直接回傳String的話，SpringBoot是直接回傳，故我們需要手動轉換成json， 經過上面的處理我們就再也不需要通過ResultData.success()來進行轉換了，直接回傳原始資料格式，SpringBoot自動幫我們實作包裝類的封裝，
@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;
}
此時我們呼叫介面回傳的資料結果為：
{
"success": true,
"code": 100,
"msg": "操作成功",
"data": "hello,didiplus",
"timestamp": 1650786993454
}
本文來自博客園，作者：北根娃，轉載請注明原文鏈接：https://www.cnblogs.com/alanlin/p/16191008.html
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/464009.html
標籤：Java
上一篇：【面試普通人VS高手系列】Spring Boot中自動裝配機制的原理
下一篇：MyBatis:框架的搭建及測驗