偷偷摘套内射激情视频,久久精品99国产国产精,中文字幕无线乱码人妻,中文在线中文a,性爽19p

Spring Boot 統(tǒng)一響應(yīng)體處理器詳解

開發(fā) 前端
通過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;
    }
}
  1. @ControllerAdvice 注解:通過這個注解,我們告訴Spring Boot這是一個全局控制器增強的類,用于統(tǒng)一處理Controller的返回值。
  2. supports 方法:在這個方法中,我們可以指定哪些類型的返回值需要被攔截。在這里,我們返回true表示攔截所有類型的返回值。
  3. 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é)任編輯:武曉燕 來源: 柳岸花開
相關(guān)推薦

2024-08-01 09:10:03

2025-02-13 00:34:22

Spring對象系統(tǒng)

2024-09-25 08:10:00

Spring后端

2025-06-30 01:45:00

2024-08-09 08:25:32

Spring流程注解

2025-02-28 08:14:53

2021-04-30 07:34:01

Spring BootController項目

2010-03-29 02:21:12

AMDMagny Cours12核

2013-05-10 10:12:32

英特爾至強處理器

2011-04-21 16:51:16

一體電腦處理器

2011-03-18 09:37:40

spring

2017-05-18 14:14:25

過濾器Spring ClouZuul

2024-10-28 08:32:22

統(tǒng)一接口響應(yīng)SpringBoot響應(yīng)框架

2012-06-27 15:09:31

戴爾一體機

2019-08-22 14:02:00

Spring BootRestful APIJava

2023-04-07 07:49:19

PC處理器移動

2017-05-19 15:13:05

過濾器Spring ClouZuul

2017-07-31 15:47:50

Zuul統(tǒng)一處理

2014-09-09 09:49:59

2017-04-26 11:00:34

Spring BootHelloWorld詳解
點贊
收藏

51CTO技術(shù)棧公眾號