Spring Bean Validation 校验入口篇Spring Bean Validation 校验入口篇 - 在

Spring Bean Validation 校验入口篇

在讲述Bean Validation的开篇，我们并不深入的了解相关的用法。

而是着重于以下两个问题：

在什么场景下使用Bean Validation。
在配合Spring框架时，代码又是如何流转到Bean Validation的。

在什么样的场景下使用`Bean Validation`

1. `Controller`层对`HTTP`请求的校验

在Controller层对HTTP请求的参数进行校验，这是最常见的用例之一，在处理 RESTful API 时尤其如此。

1.1 配合`@PathVariable`校验路径变量

@GetMapping("/{userId}")
public User getUser(@PathVariable 
			@Positive(message = "用户id必须为正数") Integer userId) {
	return userService.getById(userId);
}

1.2 配合`@ModelAttribute`校验请求参数

@GetMapping("/page")
public IPage<User> pageUser(@ModelAttribute @Valid UserQueryDTO queryDTO) {
	return userService.page(queryDTO);
}

1.3 配合`@RequestBody`校验请求体

@PostMapping("/users") 
public Long createUser(@RequestBody @Valid User user) { 
	return userService.createUser(user);  
}

2. 通用`Spring Bean`方法校验

想要让Spring Bean的方法具有参数或返回值校验的能力，需要遵循如下两个步骤：

类上声明 @Validated ，以让该bean被Spring代理增强。

@Service
@Validated
public class UserServiceImpl implements UserService {
    @Override
    public void updateUser(User user) {
        // update logic
    }
}

对接口方法参数使用@Valid注解，启用方法级别的参数验证。

public interface UserService {
    void updateUser(@Valid User user);
}

这样，任何通过 Spring 调用的方法都可以自动验证其参数。

代码如何流转到`Bean Validation`

1. `Controller`层对`HTTP`请求的校验

该图片描述了Spring MVC的执行流程。

在处理器适配器阶段，即调用控制器方法前，HandlerAdapter需要准备所有必要的方法参数，这就涉及到了方法参数的解析。

方法参数的解析会由一系列的HandlerMethodArgumentResolver完成，每个解析器负责将请请求中的特定部分（如路径变量、请求参数、请求体等）解析并转换为控制器方法期望的参数类型。

路径变量：PathVariableMethodArgumentResolver
请求参数：ServletModelAttributeMethodProcessor
请求体：RequestResponseBodyMethodProcessor

以请求体解析为例，RequestResponseBodyMethodProcessor会将请求体的JSON数据转换为由@RequestBody注解的Java对象。

这一流程的核心代码在RequestResponseBodyMethodProcessor的resolveArgument函数中，通过如下三个阶段完成：

解析请求体，对于JSON数据，通常使用MappingJackson2HttpMessageConverter将请求数据转换为Java对象。
数据绑定与校验，为解析的对象创建WebDataBinder实例，并执行校验。
处理校验结果，如果校验失败，WebDataBinder的BindingResult将包含错误详情，抛出MethodArgumentNotValidException异常，该异常描述了校验失败的细节。

2. 通用`Spring Bean`方法校验

想要开启方法参数校验，首先需要在Spring Bean的类上声明@Validated。

在该场景下， @Validated相当于AOP的声明。通过在类上加入@Validated注解，帮助Spring对该类的对象创建用于参数校验的代理。

这一过程涉及到几个关键的组件和步骤：

2.1 注册`MethodValidationPostProcessor`

MethodValidationPostProcessor是Spring提供的一个Bean后置处理器。

它在容器启动时自动检测使用了@Validated注解的组件，并为这些组件创建代理，以便在实际调用目标方法前拦截调用并执行验证。

在Spring Boot应用中，它通常由自动配置机制注册（FilteredMethodValidationPostProcessor）。

2.2 创建代理

当MethodValidationPostProcessor处理Bean时，如果该Bean的类被@Validated注解，它会为这个Bean创建一个代理。

代理执行的类为MethodValidationInterceptor。

2.3 校验方法参数与返回值

当目标函数被调用时，AOP拦截了方法调用，并在MethodValidationInterceptor的invoke方法中执行了参数校验。

该函数会在调用目标方法前后，对方法参数和返回值进行校验。

其中比较有意思的是：

adaptViolations属性为true时，会将异常包装为MethodValidationException抛出。
为false时（默认值），抛出Bean Validation规范中的异常ConstraintViolationException。

Set<ConstraintViolation<Object>> violations;
if (this.adaptViolations) {
	this.validationAdapter.applyArgumentValidation(
					target, method, null, arguments, groups);
}
else {
	violations = this.validationAdapter.invokeValidatorForArguments(
					target, method, arguments, groups);
	if (!violations.isEmpty()) {
		throw new ConstraintViolationException(violations);
	}
}

Spring Bean Validation 校验入口篇