Spring Boot 統(tǒng)一響應(yīng)體處理器詳解
作者：柳岸花開
通過ResultHandlerAdvice，我們實現(xiàn)了一個簡單而有效的全局響應(yīng)體處理器，確保了API的統(tǒng)一響應(yīng)格式。這樣的設(shè)計不僅提高了代碼的可維護(hù)性，還使得團(tuán)隊開發(fā)中更容易達(dá)成統(tǒng)一規(guī)范，提升了項目的整體質(zhì)量。
在Spring Boot應(yīng)用中，統(tǒng)一處理響應(yīng)體是一項非常重要的任務(wù)，它可以讓我們更方便地統(tǒng)一規(guī)范API的返回格式。今天，我們將深入探討一個優(yōu)雅的解決方案——使用ResultHandlerAdvice，通過它實現(xiàn)統(tǒng)一響應(yīng)體的增強處理。
背景
在實際項目中，我們經(jīng)常會面臨API返回的統(tǒng)一格式要求，而不同的Controller可能返回不同類型的數(shù)據(jù)。為了解決這個問題，我們可以使用Spring Boot的ControllerAdvice和ResponseBodyAdvice來實現(xiàn)全局的響應(yīng)體處理。
實現(xiàn)
首先，讓我們看一下如何通過代碼實現(xiàn)這個處理器。以下是一個簡單的例子：
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;
/**
* 統(tǒng)一響應(yīng)體增強處理器
*/
@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)) { // 判斷響應(yīng)的Content-Type為JSON格式的body
if (body instanceof Result) { // 如果響應(yīng)返回的對象為統(tǒng)一響應(yīng)體，則直接返回body
return body;
} else {
// 只有正常返回的結(jié)果才會進(jìn)入這個判斷流程，所以返回正常成功的狀態(tài)碼
Result result = Result.buildSuccessResult(body);
return result;
}
}
// 非JSON格式body直接返回即可
return body;
}
}- @ControllerAdvice 注解：通過這個注解，我們告訴Spring Boot這是一個全局控制器增強的類，用于統(tǒng)一處理Controller的返回值。
- supports 方法：在這個方法中，我們可以指定哪些類型的返回值需要被攔截。在這里，我們返回true表示攔截所有類型的返回值。
- beforeBodyWrite 方法：這是關(guān)鍵的方法，它在響應(yīng)體寫入之前被調(diào)用。我們可以在這里對返回的結(jié)果進(jìn)行處理，確保其符合我們的統(tǒng)一格式。在這個例子中，我們判斷如果返回的不是統(tǒng)一響應(yīng)體 Result 類型，就包裝成 Result 類型再返回。
應(yīng)用
使用這個處理器后，所有被@ControllerAdvice注解標(biāo)注的Controller都將受到影響。這意味著，無論哪個Controller返回的數(shù)據(jù)，都會經(jīng)過我們定義的處理邏輯，確保響應(yīng)的統(tǒng)一性。
@RestController
@RequestMapping("/api")
public class MyController {
@GetMapping("/data")
public MyData getData() {
// 實際業(yè)務(wù)邏輯...
return new MyData("Hello, World!");
}
}MyData
Result總結(jié)
通過ResultHandlerAdvice，我們實現(xiàn)了一個簡單而有效的全局響應(yīng)體處理器，確保了API的統(tǒng)一響應(yīng)格式。這樣的設(shè)計不僅提高了代碼的可維護(hù)性，還使得團(tuán)隊開發(fā)中更容易達(dá)成統(tǒng)一規(guī)范，提升了項目的整體質(zhì)量。希望這篇文章對你理解和使用Spring Boot中的全局響應(yīng)體處理有所幫助！
責(zé)任編輯：武曉燕
來源：
柳岸花開
