Spring Bean Validation 校验入口篇
在讲述Bean Validation
的开篇,我们并不深入的了解相关的用法。
而是着重于以下两个问题:
- 在什么场景下使用
Bean Validation
。 - 在配合
Spring
框架时,代码又是如何流转到Bean Validation
的。
在什么样的场景下使用Bean Validation
1. Controller
层对HTTP
请求的校验
在Controller
层对HTTP
请求的参数进行校验,这是最常见的用例之一,在处理 RESTful API
时尤其如此。
1.1 配合@PathVariable
校验路径变量
Java
代码解读
复制代码
@GetMapping("/{userId}") public User getUser(@PathVariable @Positive(message = "用户id必须为正数") Integer userId) { return userService.getById(userId); }
1.2 配合@ModelAttribute
校验请求参数
Java
代码解读
复制代码
@GetMapping("/page") public IPage<User> pageUser(@ModelAttribute @Valid UserQueryDTO queryDTO) { return userService.page(queryDTO); }
1.3 配合@RequestBody
校验请求体
整理了一份核心面试笔记包括了:Java面试、Spring、JVM、MyBatis、Redis、MySQL、并发编程、微服务、Linux、Springboot、SpringCloud、MQ、Kafka 面试专题
需要全套面试笔记的【点击此处即可】即可免费获取
JAVA
代码解读
复制代码
@PostMapping("/users") public Long createUser(@RequestBody @Valid User user) { return userService.createUser(user); }
2. 通用Spring Bean
方法校验
想要让Spring Bean
的方法具有参数或返回值校验的能力,需要遵循如下两个步骤:
- 类上声明
@Validated
,以让该bean
被Spring
代理增强。
Java
代码解读
复制代码
@Service @Validated public class UserServiceImpl implements UserService { @Override public void updateUser(User user) { // update logic } }
- 对接口方法参数使用
@Valid
注解,启用方法级别的参数验证。
Java
代码解读
复制代码
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
。
Java
代码解读
复制代码
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); } }