SpringBoot統(tǒng)一數(shù)據(jù)返回的幾種方式

更新時間：2024年07月19日 09:35:55 作者：碼農(nóng)阿豪@新空間代碼工作室

在Web應用程序開發(fā)中,統(tǒng)一數(shù)據(jù)返回格式對于前后端分離項目尤為重要,本文就來介紹一下SpringBoot統(tǒng)一數(shù)據(jù)返回的幾種方式,具有一定的參考價值,感興趣的可以了解一下

在Web應用程序開發(fā)中，統(tǒng)一數(shù)據(jù)返回格式對于前后端分離項目尤為重要。通過統(tǒng)一的數(shù)據(jù)返回格式，可以大大簡化前端數(shù)據(jù)解析的復雜度，提高代碼的可維護性和一致性。本文將介紹如何在Spring Boot項目中實現(xiàn)統(tǒng)一的數(shù)據(jù)返回格式。

一、概念

統(tǒng)一數(shù)據(jù)返回指的是將所有接口的返回數(shù)據(jù)進行統(tǒng)一封裝，使用一致的格式返回給前端。例如，可以定義一個標準的響應格式，包括狀態(tài)碼、消息、數(shù)據(jù)等信息：

{
    "code": 200,
    "message": "Success",
    "data": { ... }
}

通過這種方式，前端開發(fā)人員只需處理一種響應格式，減少解析錯誤和代碼冗余。

二、實現(xiàn)統(tǒng)一數(shù)據(jù)返回

為了實現(xiàn)統(tǒng)一的數(shù)據(jù)返回格式，我們可以使用Spring Boot的ResponseBodyAdvice接口，該接口可以在響應返回之前對響應體進行處理。

2.1 重寫responseAdvice方法

首先，我們需要創(chuàng)建一個類，實現(xiàn)ResponseBodyAdvice接口，并重寫其中的方法：

import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

@ControllerAdvice
public class GlobalResponseAdvice implements ResponseBodyAdvice<Object> {

    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, 
                                  Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        if (body instanceof ResponseEntity) {
            return body;
        }
        return new ApiResponse(200, "Success", body);
    }
}

在上面的代碼中，supports方法用于判斷哪些接口的返回值需要處理，這里返回true表示處理所有接口的返回值。beforeBodyWrite方法則是在響應體寫入之前進行處理，將返回的數(shù)據(jù)封裝為統(tǒng)一格式的ApiResponse對象。

2.2 實現(xiàn)ApiResponse類

創(chuàng)建ApiResponse類，用于定義統(tǒng)一的響應格式：

public class ApiResponse<T> {

    private int code;
    private String message;
    private T data;

    public ApiResponse(int code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }

    // Getters and Setters
}

三、特殊類型-String的處理

由于Spring在處理String類型的返回值時，會直接將其寫入響應體，而不會經(jīng)過HttpMessageConverter，因此我們需要對String類型進行特殊處理：

import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

@ControllerAdvice
public class GlobalResponseAdvice implements ResponseBodyAdvice<Object> {

    private final ObjectMapper objectMapper;

    public GlobalResponseAdvice(ObjectMapper objectMapper) {
        this.objectMapper = objectMapper;
    }

    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, 
                                  Class<? extends HttpMessageConverter<?>> selectedConverterType, 
                                  ServerHttpRequest request, ServerHttpResponse response) {
        if (body instanceof String) {
            try {
                return objectMapper.writeValueAsString(new ApiResponse<>(200, "Success", body));
            } catch (Exception e) {
                throw new RuntimeException("Failed to write response as String", e);
            }
        }
        if (body instanceof ResponseEntity) {
            return body;
        }
        return new ApiResponse<>(200, "Success", body);
    }
}

在上面的代碼中，我們使用ObjectMapper將ApiResponse對象轉(zhuǎn)換為String，確保String類型的返回值也能統(tǒng)一為標準格式。

四、全部代碼

// ApiResponse.java
public class ApiResponse<T> {

    private int code;
    private String message;
    private T data;

    public ApiResponse(int code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }

    // Getters and Setters
}

// GlobalResponseAdvice.java
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

@ControllerAdvice
public class GlobalResponseAdvice implements ResponseBodyAdvice<Object> {

    private final ObjectMapper objectMapper;

    public GlobalResponseAdvice(ObjectMapper objectMapper) {
        this.objectMapper = objectMapper;
    }

    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, 
                                  Class<? extends HttpMessageConverter<?>> selectedConverterType, 
                                  ServerHttpRequest request, ServerHttpResponse response) {
        if (body instanceof String) {
            try {
                return objectMapper.writeValueAsString(new ApiResponse<>(200, "Success", body));
            } catch (Exception e) {
                throw new RuntimeException("Failed to write response as String", e);
            }
        }
        if (body instanceof ResponseEntity) {
            return body;
        }
        return new ApiResponse<>(200, "Success", body);
    }
}

通過上述代碼，我們可以實現(xiàn)Spring Boot項目中統(tǒng)一的數(shù)據(jù)返回格式。無論返回的數(shù)據(jù)類型如何，都可以通過統(tǒng)一封裝后的格式返回給前端，極大地提高了代碼的可維護性和前后端的開發(fā)效率。

到此這篇關于SpringBoot統(tǒng)一數(shù)據(jù)返回的幾種方式的文章就介紹到這了,更多相關SpringBoot統(tǒng)一數(shù)據(jù)返回內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: