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);
    }
}

如果项目集成了Swagger2，则supports方法里面要加判断：Swagger2响应的数据不封装返回体，否则Swagger2将不显示接口文档