這篇文章主要講解了“SpringBoot統一返回格式怎么實現”，文中的講解內容簡單清晰，易于學習與理解，下面請大家跟著小編的思路慢慢深入，一起來研究和學習“SpringBoot統一返回格式怎么實現”吧！
先看一下最基本的例子，直接將結果原封不動返回：
@Data
@AllArgsConstructor
@JsonIgnoreProperties(ignoreUnknown = true)
public class TestVo {
private static final long serialVersionUID = 1L;
@Schema(name = "姓名")
private String name;
@Schema(name = "年齡")
private Integer age;
}@RestController
@RequestMapping(value = "/test")
public class TestApi {
@GetMapping("/simple")
public TestVo simple() {
TestVo testVo = new TestVo("張三", 30);
return testVo;
}
}返回結果：
{
"name": "張三",
"age": 30
}
假如已經與前端開發妹子約定好了格式，比如：
{
"code": 0,
"msg": "錯誤信息",
"data": 實際返回結果
}那么我們首先需要編寫一個封裝結果類Result。為了方便封裝，在這個類中增加一個success方法：
@Data
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Result<T> implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 返回編碼
*/
private Integer code;
/**
* 編碼描述
*/
private String msg;
/**
* 業務數據
*/
private T data;
/**
* 返回成功結果對象
*
* @param data
* @param <T>
* @return
*/
public static <T> Result<T> success(T data) {
Result result = new Result();
result.setCode(0);
result.setMsg("success");
result.setData(data);
return result;
}
}后臺接口代碼微調一下，返回值改為Result，泛型為原返回值的類型：
@RestController
@RequestMapping(value = "/test")
public class TestApi {
@GetMapping("/withResult")
public Result<TestVo> withResult() {
TestVo testVo = new TestVo("張三", 30);
return Result.success(testVo);
}
}返回結果：
{
"code": 0,
"msg": "success",
"data": {
"name": "張三",
"age": 30
}
}
至此，返回結果完美符合格式。
但是這樣的代碼并不算簡潔：每個接口的返回值都必須是Result<>，并且return的時候都要用Result.success()方法封裝一下。
那么，有沒有更優雅的方法？我們繼續往下看：
實際使用場景中，并不是所有接口都需要統一格式。我們這里使用一個注解作為開關，按需控制接口返回格式。
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ApiResult {
String value() default "";
int successCode() default 0;
String successMsg() default "success";
Class<? extends IResult> resultClass() default Result.class;
}@ControllerAdvice
public class MyResponseBodyAdvice implements ResponseBodyAdvice {
protected boolean isStringConverter(Class converterType) {
return converterType.equals(StringHttpMessageConverter.class);
}
protected boolean isApiResult(MethodParameter returnType) {
return returnType.hasMethodAnnotation(ApiResult.class);
}
@Override
public boolean supports(MethodParameter returnType, Class converterType) {
return !isStringConverter(converterType) && isApiResult(returnType);
}
@Override
public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,
Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
//關鍵
return Result.success(body);
}
}這里有一點要注意，這個advice中supports方法中判斷返回結果類型必須為非String類型。如果返回結果為String類型，那么result要轉為json字符串后再返回，需要再寫一個advice。
@ApiResult
@GetMapping("/withResultHide")
public TestVo withResultHide() {
TestVo testVo = new TestVo("張三", 30);
return testVo;
}這段代碼與最開始一樣，并沒有返回Result，僅僅加上了@ApiResult注解，我們看返回結果：
{
"code": 0,
"msg": "success",
"data": {
"name": "張三",
"age": 30
}
}
大功告成！
以上只是最精簡的例子，實際使用中還結合了 統一異常封裝、自定義返回格式 等功能。我們注意到@ApiResult注解中，有三個參數：successCode、successMsg、resultClass，就是為了自定義返回格式預留的，下面再看兩個場景：
如果個別接口的返回格式與默認格式相同，但是要求code等于200時才代表成功，那么修改下successCode參數即可：
@ApiResult(successCode = 200, successMsg = "ok")
@GetMapping("/withResultHide")
public TestVo withResultHide() {
TestVo testVo = new TestVo("張三", 30);
return testVo;
}返回成功時，結果中的code和msg都變為設置的值：
{
"code": 200,
"msg": "ok",
"data": {
"name": "張三",
"age": 30
}
}
如果某個接口的返回格式不是默認的返回格式，比如約定返回returnCode、returnDesc、data（對應默認的code、msg、data）。那么則需要新增一個返回結果類，比如ReturnResult：
@Data
@JsonInclude(JsonInclude.Include.NON_NULL)
public class ReturnResult<T> implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 返回編碼
*/
private String returnCode;
/**
* 編碼描述
*/
private String returnDesc;
/**
* 業務數據
*/
private T data;
/**
* 返回成功結果對象
*
* @param data
* @param <T>
* @return
*/
public static <T> ReturnResult<T> success(T data) {
ReturnResult result = new ReturnResult();
result.setReturnCode(0);
result.setReturnDesc("success");
result.setData(data);
return result;
}
}然后修改接口上的@ApiResult注解中的resultClass屬性
@ApiResult(resultClass = ReturnResult.class)
@GetMapping("/withResultHide")
public TestVo withResultHide() {
TestVo testVo = new TestVo("張三", 30);
return testVo;
}這時，返回結果就變為想要的格式了：
{
"returnCode": "0",
"returnDesc": "success",
"data": {
"name": "張三",
"age": 30
}
}
感謝各位的閱讀，以上就是“SpringBoot統一返回格式怎么實現”的內容了，經過本文的學習后，相信大家對SpringBoot統一返回格式怎么實現這一問題有了更深刻的體會，具體使用情況還需要大家實踐驗證。這里是億速云，小編將為大家推送更多相關知識點的文章，歡迎關注！
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
