亚洲乱码中文字幕综合,中国熟女仑乱hd,亚洲精品乱拍国产一区二区三区,一本大道卡一卡二卡三乱码全集资源,又粗又黄又硬又爽的免费视频

Spring MVC 接口 ResponseBodyAdvice 及其應用最佳實踐記錄

 更新時間：2025年04月15日 09:56:37   作者：法天象地 日月同輝  
ResponseBodyAdvice?是 Spring MVC 提供的一個強大接口,允許你在響應體被寫入 HTTP 響應之前對其進行全局處理,下面我將全面介紹它的工作原理、使用場景和最佳實踐,感興趣的朋友一起看看吧

ResponseBodyAdvice 是 Spring MVC 提供的一個強大接口，允許你在響應體被寫入 HTTP 響應之前對其進行全局處理。

下面我將全面介紹它的工作原理、使用場景和最佳實踐。

基本概念

接口定義

public interface ResponseBodyAdvice<T> {
    boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType);
    @Nullable
    T beforeBodyWrite(@Nullable T body, MethodParameter returnType, 
                     MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType,
                     ServerHttpRequest request, ServerHttpResponse response);
}

核心方法

supports()

  • 決定是否對該方法的返回值應用 advice
  • 參數(shù)：
    • returnType: 控制器方法的返回類型信息
    • converterType: 將用于序列化響應體的消息轉(zhuǎn)換器類型

beforeBodyWrite()

  • 在消息轉(zhuǎn)換器寫入響應體之前對其進行處理
  • 參數(shù)：
    • body: 控制器返回的原始響應體
    • 其他參數(shù)與 supports() 相同
    • request/response: 當前請求和響應對象

典型應用場景

1. 統(tǒng)一響應封裝

最常見的用途是將所有控制器的返回值包裝成統(tǒng)一格式：

@RestControllerAdvice
public class UnifiedResponseAdvice implements ResponseBodyAdvice<Object> {
    @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 ApiResponse) {
            return body;
        }
        return ApiResponse.success(body);
    }
}

2. 響應數(shù)據(jù)脫敏

對敏感數(shù)據(jù)進行自動處理：

@Override
public Object beforeBodyWrite(Object body, MethodParameter returnType, 
                            MediaType selectedContentType,
                            Class<? extends HttpMessageConverter<?>> selectedConverterType,
                            ServerHttpRequest request, ServerHttpResponse response) {
    if (body instanceof UserInfo) {
        UserInfo user = (UserInfo) body;
        user.setIdCard(desensitize(user.getIdCard()));
    }
    return body;
}

3. 響應數(shù)據(jù)緩存

緩存特定響應：

@Override
public Object beforeBodyWrite(Object body, MethodParameter returnType, 
                            MediaType selectedContentType,
                            Class<? extends HttpMessageConverter<?>> selectedConverterType,
                            ServerHttpRequest request, ServerHttpResponse response) {
    if (request.getURI().getPath().contains("/api/cacheable")) {
        cacheManager.put(generateCacheKey(request), body);
    }
    return body;
}

高級用法與最佳實踐

1. 精確控制應用范圍

通過 supports() 方法精確控制哪些方法需要處理：

@Override
public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
    // 只處理標注了@ResponseWrap注解的方法
    return returnType.hasMethodAnnotation(ResponseWrap.class);
    // 或者排除特定包下的控制器
    // return !returnType.getDeclaringClass().getPackage().getName().startsWith("org.springdoc");
}

2. 處理特殊情況 處理String類型返回值

@Override
public Object beforeBodyWrite(Object body, MethodParameter returnType, 
                            MediaType selectedContentType,
                            Class<? extends HttpMessageConverter<?>> selectedConverterType,
                            ServerHttpRequest request, ServerHttpResponse response) {
    if (body instanceof String) {
        response.getHeaders().setContentType(MediaType.APPLICATION_JSON);
        return objectMapper.writeValueAsString(ApiResponse.success(body));
    }
    // 其他處理...
}

處理文件下載等非JSON響應

@Override
public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
    // 排除文件下載等場景
    return !ResourceHttpMessageConverter.class.isAssignableFrom(converterType);
}

3. 性能優(yōu)化

@RestControllerAdvice
public class CustomResponseAdvice implements ResponseBodyAdvice<Object> {
    // 重用ObjectMapper實例
    private static final ObjectMapper objectMapper = new ObjectMapper();
    // 預定義的成功響應
    private static final ApiResponse<?> EMPTY_SUCCESS = ApiResponse.success(null);
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, 
                                MediaType selectedContentType,
                                Class<? extends HttpMessageConverter<?>> selectedConverterType,
                                ServerHttpRequest request, ServerHttpResponse response) {
        if (body == null) {
            return EMPTY_SUCCESS;
        }
        // 其他處理...
    }
}

常見問題解決方案

1. 與Swagger的兼容性問題

@Override
public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
    // 排除Swagger相關的控制器
    return !returnType.getDeclaringClass().getPackage().getName().startsWith("springfox.documentation");
}

2. 循環(huán)引用問題

當包裝的對象存在循環(huán)引用時，需要在ObjectMapper中配置：

objectMapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
objectMapper.configure(SerializationFeature.FAIL_ON_SELF_REFERENCES, false);

3. 異常處理

雖然ResponseBodyAdvice不處理異常，但可以與@ExceptionHandler配合使用：

@ExceptionHandler(Exception.class)
public ApiResponse<?> handleException(Exception e) {
    return ApiResponse.failure(e.getMessage());
}

完整示例

@RestControllerAdvice
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) {
        // 排除Swagger和Actuator端點
        return !(returnType.getDeclaringClass().getName().contains("springfox") || 
                returnType.getDeclaringClass().getName().contains("org.springframework.boot.actuate"));
    }
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, 
                                MediaType selectedContentType,
                                Class<? extends HttpMessageConverter<?>> selectedConverterType,
                                ServerHttpRequest request, ServerHttpResponse response) {
        // 非JSON響應不處理
        if (!selectedContentType.includes(MediaType.APPLICATION_JSON)) {
            return body;
        }
        // 已經(jīng)是包裝類型不處理
        if (body instanceof ApiResponse) {
            return body;
        }
        // 處理String類型返回值
        if (body instanceof String) {
            try {
                response.getHeaders().setContentType(MediaType.APPLICATION_JSON);
                return objectMapper.writeValueAsString(ApiResponse.success(body));
            } catch (JsonProcessingException e) {
                throw new RuntimeException("JSON序列化失敗", e);
            }
        }
        // 空值處理
        if (body == null) {
            return ApiResponse.success();
        }
        // 默認包裝
        return ApiResponse.success(body);
    }
    @Data
    @NoArgsConstructor
    @AllArgsConstructor
    public static class ApiResponse<T> {
        private int code;
        private String message;
        private T data;
        private long timestamp = System.currentTimeMillis();
        public static <T> ApiResponse<T> success() {
            return new ApiResponse<>(200, "success", null);
        }
        public static <T> ApiResponse<T> success(T data) {
            return new ApiResponse<>(200, "success", data);
        }
    }
}

通過合理使用ResponseBodyAdvice，你可以實現(xiàn)響應處理的集中管理，使代碼更加整潔和一致。

到此這篇關于Spring MVC 接口 ResponseBodyAdvice 及其應用最佳實踐記錄的文章就介紹到這了,更多相關Spring MVC ResponseBodyAdvice 內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

相關文章

  • Java如何配置IDEA自定義注釋

    Java如何配置IDEA自定義注釋

    在IDEA中設置自動創(chuàng)建類和方法的注釋可以提高編碼效率,確保代碼的一致性和可讀性,首先,對于創(chuàng)建類的注釋,可以通過修改File→Settings→File and Code Templates→Class的模板來實現(xiàn),其次,對于方法注釋
    2024-10-10
  • 巧妙mybatis避免Where 空條件的尷尬

    巧妙mybatis避免Where 空條件的尷尬

    這篇文章主要介紹了巧妙mybatis避免Where 空條件的尷尬，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧
    2020-11-11
  • 使用JavaMail發(fā)送郵件保證成功的方法

    使用JavaMail發(fā)送郵件保證成功的方法

    JavaMail是利用現(xiàn)有的郵件賬戶發(fā)送郵件的工具，使用過JavaMail的api發(fā)送郵件的人可能會有這樣一個疑惑：我如何知道我調(diào)用該api發(fā)送的郵件是否成功呢？那么通過下面這篇文章大家一起來看看使用JavaMail保證郵件發(fā)送成功的方法，有需要的朋友們可以參考借鑒。
    2016-11-11
  • Java中的HashMap內(nèi)存泄漏問題詳解

    Java中的HashMap內(nèi)存泄漏問題詳解

    這篇文章主要介紹了Java中的HashMap內(nèi)存泄漏問題詳解,WeakHashMap中的key是弱引用,如果再使用之后沒有及時remove掉這個key,那么當GC時key就可能會被回收,導致key對應的value對象占用的內(nèi)存無法回收進而導致內(nèi)存泄漏,需要的朋友可以參考下
    2023-09-09
  • mybatis中resulthandler的用法

    mybatis中resulthandler的用法

    這篇文章主要介紹了mybatis中resulthandler的用法，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
    2022-01-01
  • 基于Java編寫簡易的算式測試程序

    基于Java編寫簡易的算式測試程序

    本文將利用Java語言編寫一個簡易的算式測試程序，這個程序可以自動生成指定數(shù)量的加減乘三則運算題目，感興趣的小伙伴可以了解一下
    2022-05-05
  • 解決idea中yml文件圖標問題及自動提示失效的情況

    解決idea中yml文件圖標問題及自動提示失效的情況

    這篇文章主要介紹了解決idea中yml文件圖標問題及自動提示失效的情況，具有很好的價值，希望對大家有所幫助。一起跟隨小編過來看看吧
    2021-01-01
  • MyBatis-Plus內(nèi)置接口方法的具體使用

    MyBatis-Plus內(nèi)置接口方法的具體使用

    java開發(fā)應用程序與數(shù)據(jù)庫交互使用比較多的就是mybatisPlus接口,本文主要介紹了MyBatis-Plus內(nèi)置接口方法的具體使用,具有一定的參考價值,感興趣的可以了解一下
    2023-12-12
  • 解決因jdk版本引起的TypeNotPresentExceptionProxy異常

    解決因jdk版本引起的TypeNotPresentExceptionProxy異常

    這篇文章介紹了解決因jdk版本引起的TypeNotPresentExceptionProxy異常的方法，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧
    2021-12-12
  • SpringCache緩存處理詳解

    SpringCache緩存處理詳解

    這篇文章主要介紹了SpringCache緩存處理詳解,SpringCache是一個框架,實現(xiàn)了基于注解緩存功能,只需要簡單地加一個注解,就能實現(xiàn)緩存功能,需要的朋友可以參考下
    2023-09-09

最新評論