快捷導(dǎo)航

詳解SpringBoot如何統(tǒng)一處理返回的信息

更新時間：2023年06月06日 09:14:12 作者：Jimmy

現(xiàn)在的項目是前后端開發(fā)的居多，那么我們怎么定義接口返回的數(shù)據(jù)，怎么使用?Spring?Boot?來統(tǒng)一處理返回的信息呢，本文就來和大家簡單講講

定義返回的信息格式

一個合理的信息返回格式，至少包含下面三個字段：

{
  "code": "0",
  "message": "請求成功",
  "data": {
    "name": "Jimmy"
  }
  ""
}

code 表示返回的狀態(tài)，我們這個可以自行定義，10000 代表成功; 20000 代表某某等；message 表示接口返回的信息，是否成功了，失敗的理由是什么等；data 是表示請求成功后，返回的數(shù)據(jù)，可以是數(shù)組也可以是對象等。

信息返回格式，是否應(yīng)該有其他字段，按照需求調(diào)整。

實踐

我們使用 Spring Boot 來實踐一下，通過 IDEA 新建一個名為 jimmy-response 的項目：

添加 lombok

Lombok 是一個插件，其主要的用途是提供了簡單注釋的形式來幫助我們簡化消除一些必須有但是顯得很臃腫的 java 代碼，提高編碼效率，使代碼更加簡潔。

pom.xml 中添加依賴：

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>

如果并沒有自動安裝。點擊 pom.xml 文件右上角同步圖案即可。

定義返回的對象

我們在 ResultData.java 中定義返回的類：

// ResultData.java
package com.example.jimmyresponse;
import lombok.Data;
@Data
public class ResultData<T> {
    private String code;
    private String message;
    private T data;
    // 擴(kuò)展字段，比如接口請求時間
    private long accessTimestamp;
    // 構(gòu)造函數(shù)
    public ResultData() {
        this.accessTimestamp = System.currentTimeMillis();
    }
    // 成功返回
    public static <T> ResultData<T> success(T data) {
        ResultData<T> resultData = new ResultData<>();
        resultData.setCode("10000");
        resultData.setMessage(("請求成功!"));
        resultData.setData(data);
        return resultData;
    }
    // 失敗返回
    public static <T> ResultData<T> fail(String code, String message) {
        ResultData<T> resultData = new ResultData<>();
        resultData.setCode(code);
        resultData.setMessage(message);
        return resultData;
    }
}

模擬數(shù)據(jù)

我們定義一個類來模擬用戶的數(shù)據(jù)：

package com.example.jimmyresponse;
public class User {
    public String name;
    public User(String name) {
        this.name = name; // 用戶名
    }
}

調(diào)用

最后，我們調(diào)用定義好的返回對象：

// ApiControll.java
package com.example.jimmyresponse;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class ApiController<T> {
    @GetMapping("/")
    public T getList() {
        // 模擬用戶數(shù)據(jù)
        User users[] = {
                new User("Jimmy"),
                new User("Ivy")
        };
        return (T) ResultData.success(users); // 信息成功返回
    }
}

結(jié)果的如下：