Spring类之ResponseBodyAdvice

一、概述

RequestBodyAdvice 是 Spring MVC 框架中的一个接口，允许在 HTTP 请求的请求体（request body）被反序列化为 Java 对象之前进行拦截和修改。它为开发者提供了一个钩子，可以在请求处理过程中插入自定义的逻辑，例如对请求体进行预处理、验证或日志记录。

1.1、源码定义

• supports()：该方法用于确定是否应该应用这个 RequestBodyAdvice 实例。返回 true 表示支持当前的转换。
• beforeBodyRead()：在读取请求体之前调用，可以用于包装或修改传入的 HttpInputMessage。
• afterBodyRead()：在请求体被读取并转换为 Java 对象之后调用，可以修改或替换读取到的对象。
• handleEmptyBody()：在请求体为空时调用，可以提供一个默认对象或处理空请求体的情况。

public interface RequestBodyAdvice {
​
  boolean supports(MethodParameter methodParameter, Type targetType,
      Class<? extends HttpMessageConverter<?>> converterType);
​
  HttpInputMessage beforeBodyRead(HttpInputMessage inputMessage, MethodParameter parameter,
      Type targetType, Class<? extends HttpMessageConverter<?>> converterType) throws IOException;
​
  Object afterBodyRead(Object body, HttpInputMessage inputMessage, MethodParameter parameter,
      Type targetType, Class<? extends HttpMessageConverter<?>> converterType);
​
  @Nullable
  Object handleEmptyBody(@Nullable Object body, HttpInputMessage inputMessage, MethodParameter parameter,
      Type targetType, Class<? extends HttpMessageConverter<?>> converterType);
​
}

1.2、实际应用

ResponseBodyAdvice 可以用于多种应用场景，例如：

• 数据加密：在将响应数据返回给客户端之前对其进行加密。
• 数据格式转换：根据客户端的请求参数动态调整响应数据的格式，例如 XML 转 JSON。
• 统一响应格式：对所有 API 接口的响应数据进行统一包装，确保一致的响应格式。
• 响应头设置：在返回响应体之前设置或修改响应头，例如添加自定义头部信息。

需要配合 @Component和@RestControllerAdvice 注解使用

• @RestControllerAdvice：用户标志此类用户拦截controller类的相应结果
• @Component：增加spring 对象管理
  基础代码实现

package com.zzx.util;

import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.SneakyThrows;
import org.springframework.beans.factory.annotation.Autowired;
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.stereotype.Component;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;


@Component
@RestControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice {

	@Autowired
	private ObjectMapper objectMapper;

	@Override
	public boolean supports(MethodParameter returnType, Class converterType) {
		return true;
	}

	/**
	 * 统一结果响应
	 * @param body
	 * @param returnType
	 * @param selectedContentType
	 * @param selectedConverterType
	 * @param request
	 * @param response
	 * @return
	 */
	@SneakyThrows
	@Override
	public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
		if (body == null) {
            return null;
        }
		Class<?> aClass = body.getClass();
		if ("springfox.documentation.spring.web.json.Json".equals(aClass.getName())) {
			return body;
		} else if (body instanceof String) {
			if ("getToken".equals(returnType.getMethod().getName())) {
				return body;
			}
			return objectMapper.writeValueAsString(Res.ok(body));
		} else if (body instanceof Res) {
			//Res 是自定义的返回对象
			ResponseResult<Object> result = new ResponseResult<>();
			result.setData(((Res<?>) body).getData());
			result.setCode(((Res<?>) body).getCode());
			result.setMsg(((Res<?>) body).getMsg());
			return result;
		}
		return body;
	}
}