Spring Boot 統一響應體處理器詳解

作者：柳岸花開 2023-11-30 07:00:56

通過ResultHandlerAdvice，我們實現了一個簡單而有效的全局響應體處理器，確保了API的統一響應格式。這樣的設計不僅提高了代碼的可維護性，還使得團隊開發中更容易達成統一規范，提升了項目的整體質量。

在Spring Boot應用中，統一處理響應體是一項非常重要的任務，它可以讓我們更方便地統一規范API的返回格式。今天，我們將深入探討一個優雅的解決方案——使用ResultHandlerAdvice，通過它實現統一響應體的增強處理。

背景

在實際項目中，我們經常會面臨API返回的統一格式要求，而不同的Controller可能返回不同類型的數據。為了解決這個問題，我們可以使用Spring Boot的ControllerAdvice和ResponseBodyAdvice來實現全局的響應體處理。

實現

首先，讓我們看一下如何通過代碼實現這個處理器。以下是一個簡單的例子：

import lombok.extern.slf4j.Slf4j;
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(basePackages = "com.example.controller")
@Slf4j
public class ResultHandlerAdvice implements ResponseBodyAdvice {


    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        log.info("returnType:" + returnType);
        log.info("converterType:" + converterType);
        return true;
    }


    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        if (MediaType.APPLICATION_JSON.equals(selectedContentType)) { // 判斷響應的Content-Type為JSON格式的body
            if (body instanceof Result) { // 如果響應返回的對象為統一響應體，則直接返回body
                return body;
            } else {
                // 只有正常返回的結果才會進入這個判斷流程，所以返回正常成功的狀態碼
                Result result = Result.buildSuccessResult(body);
                return result;
            }
        }
        // 非JSON格式body直接返回即可
        return body;
    }
}

@ControllerAdvice 注解：通過這個注解，我們告訴Spring Boot這是一個全局控制器增強的類，用于統一處理Controller的返回值。
supports 方法：在這個方法中，我們可以指定哪些類型的返回值需要被攔截。在這里，我們返回true表示攔截所有類型的返回值。
beforeBodyWrite 方法：這是關鍵的方法，它在響應體寫入之前被調用。我們可以在這里對返回的結果進行處理，確保其符合我們的統一格式。在這個例子中，我們判斷如果返回的不是統一響應體 Result 類型，就包裝成 Result 類型再返回。

應用

使用這個處理器后，所有被@ControllerAdvice注解標注的Controller都將受到影響。這意味著，無論哪個Controller返回的數據，都會經過我們定義的處理邏輯，確保響應的統一性。

@RestController
@RequestMapping("/api")
public class MyController {


    @GetMapping("/data")
    public MyData getData() {
        // 實際業務邏輯...
        return new MyData("Hello, World!");
    }
}

MyData
Result

總結

通過ResultHandlerAdvice，我們實現了一個簡單而有效的全局響應體處理器，確保了API的統一響應格式。這樣的設計不僅提高了代碼的可維護性，還使得團隊開發中更容易達成統一規范，提升了項目的整體質量。希望這篇文章對你理解和使用Spring Boot中的全局響應體處理有所幫助！

責任編輯：武曉燕來源：柳岸花開