【Spring MVC】获取 @RequsetBody 标识的对象，使用适配器模式增加代码可读性

news2024/10/6 20:32:01

1. 前言

一个技术需求引发的思考和实践：

思考
- 用 AOP 把校验代码
实践
- 用 Spring MVC 的 RequestBodyAdvice 做AOP逻辑
- 继承 RequestBodyAdviceAdapter 实现自己的适配器
- 用自己的适配器让代码可读性增加
- 熟悉 Spring MVC 、Java 反射的一些实践
本文内容
- 澄清一个AOP校验JSON内容的思路
- 复习适配器模式

在这里插入图片描述

2. 怎么选择切面？

一个大致的切面
从 Spring 4.2 开始，有新的切面出现，可以切到 RequestBody 上，这个切面更符合技术需求的粒度。

	public interface RequestBodyAdvice

3. RequestBody 的切面的描述

RequestBodyAdvice

public interface RequestBodyAdvice {
	// 什么时候切
	boolean supports(MethodParameter methodParameter, Type targetType,
			Class<? extends HttpMessageConverter<?>> converterType);

	// 切到读body前的位置
	HttpInputMessage beforeBodyRead(HttpInputMessage inputMessage, MethodParameter parameter,
			Type targetType, Class<? extends HttpMessageConverter<?>> converterType) throws IOException;

	// 切到读body后的位置
	Object afterBodyRead(Object body, HttpInputMessage inputMessage, MethodParameter parameter,
			Type targetType, Class<? extends HttpMessageConverter<?>> converterType);
	
	// 处理空body
	@Nullable
	Object handleEmptyBody(@Nullable Object body, HttpInputMessage inputMessage, MethodParameter parameter,
			Type targetType, Class<? extends HttpMessageConverter<?>> converterType);
}

根据接口描述，直接实现这个接口需要读很多参数的含义，其实实现业务需求仅需要：

实现少部分方法
了解少部分方法的参数

4. Spring 提供的 RequestBody 的适配器

RequestBodyAdviceAdapter

该适配器简化了一个方法，并提供了必要的三个方法的实现

public abstract class RequestBodyAdviceAdapter implements RequestBodyAdvice {

	@Override
	public HttpInputMessage beforeBodyRead(HttpInputMessage inputMessage, MethodParameter parameter,
			Type targetType, Class<? extends HttpMessageConverter<?>> converterType)
			throws IOException {
		return inputMessage;
	}

	@Override
	public Object afterBodyRead(Object body, HttpInputMessage inputMessage, MethodParameter parameter,
			Type targetType, Class<? extends HttpMessageConverter<?>> converterType) {
		return body;
	}

	@Override
	@Nullable
	public Object handleEmptyBody(@Nullable Object body, HttpInputMessage inputMessage,
			MethodParameter parameter, Type targetType,
			Class<? extends HttpMessageConverter<?>> converterType) {
		return body;
	}

}

根据适配器描述 afterBodyRead 方法能获取到 body 参数，我们能找到重点

afterBodyRead 方法
afterBodyRead 方法的 body 参数
我们可以根据这个特点，实现自己的适配器

5. 拓展 Spring 的适配器，实现自己的适配器

public abstract class AdviceAdapter extends RequestBodyAdviceAdapter {

	// 暴露关心的参数
	abstract void validate(Object body);

	@Override
	public boolean supports(MethodParameter methodParameter, @Nullable Type targetType, @Nullable Class<? extends HttpMessageConverter<?>> converterType) {
		return Objects.nonNull(methodParameter.getMethodAnnotation(RequestValidated.class));
	}

	@Override
	@Nonnull
	public Object afterBodyRead(@Nonnull Object body, @Nullable HttpInputMessage inputMessage, MethodParameter parameter,
								@Nullable Type targetType, @Nullable Class<? extends HttpMessageConverter<?>> converterType) {
		// 嵌入切面
		validate(body);
		return input;
	}
}

6. 在自己的适配器上实现逻辑

// 注意切 RequestBody 用的注解是 ControllerAdvice
@ControllerAdvice
public class ValidateAdvice extends AdviceAdapter {

	// 具体实现
    @Override
    void validate(Object json) {
        
    }
}