SpringMVC-ResponseBodyAdvice學習

一、ResponseBodyAdvice接口

這個接口是Spring 4.1開始加入的，在消息主體被HttpMessageConverter寫入之前,允許Controller控制器中@ResponseBody修飾的方法或ResponseEntity 執行之後自定義響應中的內容。ResponseBodyAdvice 只支持 @ResponseBody 註解的Controller方法。

具體實現類可以直接在RequestMappingHandlerAdapter和ExceptionHandlerExceptionResolver中註冊，或者更有可能使用@ControllerAdvice進行註解，在這種情況下，它們將被兩者自動檢測到。

 

二、ResponseBodyAdvice源碼

package org.springframework.web.servlet.mvc.method.annotation;

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.lang.Nullable;

public interface ResponseBodyAdvice<T> {
    boolean supports(MethodParameter var1, Class<? extends HttpMessageConverter<?>> var2);

    @Nullable
    T beforeBodyWrite(@Nullable T var1, MethodParameter var2, MediaType var3, 
Class<? extends HttpMessageConverter<?>> var4, ServerHttpRequest var5, ServerHttpResponse var6);
}

1.supports方法

該組件是否支持給定的控制器方法返回類型和選擇的HttpMessageConverter類型。如果返回True,則beforeBodyWrite方法將被執行。

2.beforeBodyWrite方法

在選擇HttpMessageConverter之後，以及在調用其寫方法之前調用它。

3.T  返回體類型

三、ResponseBodyAdvice應用

1. 對響應體進行封裝，對API接口進行統一格式返回
2. 對響應數據進行加密。

示例代碼

import com.soft.fireadmin.platform.api.model.ResultBody;
import lombok.extern.log4j.Log4j2;
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.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

import javax.servlet.http.HttpServletRequest;

/**
 * 全局響應體處理器
 *
 * @author David Lin
 * @version: 1.0
 * @date 2019-11-12 22:44
 */
@Log4j2
@ControllerAdvice
public class GlobalResponseHandler implements ResponseBodyAdvice<Object> {

    /**
     * 判斷哪些請求方法需要 重寫返回體
     *
     * @param methodParameter
     * @param aClass
     * @return
     */
    @Override
    public boolean supports(MethodParameter methodParameter, Class aClass) {
        //如果是@ResponseBody註解的方法則需要 重寫返回體
        //   return methodParameter.hasMethodAnnotation(ResponseBody.class);
       
       // 如果接口返回的類型本身就是ResultBody那就沒有必要進行額外的操作，返回false
       // return !methodParameter.getGenericParameterType().equals(ResultBody.class);

        //或者 從請求參數裏面判斷 該次請求是否需要重寫返回體
        ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = requestAttributes.getRequest();
        String have_flag = request.getParameter("have_flag");
        return have_flag.equals("123");
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter methodParameter, MediaType mediaType, Class aClass,
                                  ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
        
        log.info("此處重寫返回體!!");
        //封裝返回體
        return ResultBody.success(body);
    }
}