Spring Boot 实现各种参数校验(附项目源码)
本文会详细介绍Spring Validation各种场景下的最佳实践及其实现原理,死磕到底!
项目源码:spring-validation
一、简单使用
Java API 规范 (JSR303) 定义了 Bean 校验的标准 validation-api,但没有提供实现。hibernate validation 是对这个规范的实现,并增加了校验注解如 @Email、@Length 等。
Spring Validation 是对 hibernate validation 的二次封装,用于支持 spring mvc 参数自动校验。接下来,我们以 spring-boot 项目为例,介绍 Spring Validation 的使用。
1、引入依赖
如果 spring-boot 版本小于
2.3.x
,spring-boot-starter-web 会自动传入 hibernate-validator 依赖。如果 spring-boot 版本大于 2.3.x,则需要手动引入依赖:
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.1.Final</version>
</dependency>
对于 web 服务来说,为防止非法参数对业务造成影响,在 Controller 层一定要做参数校验的!大部分情况下,请求参数分为如下两种形式:
- POST、PUT 请求,使用requestBody传递参数;
- GET 请求,使用requestParam/PathVariable传递参数。
下面我们简单介绍下 requestBody 和 requestParam/PathVariable 的参数校验实战!
2、requestBody 参数校验
POST、PUT 请求一般会使用requestBody传递参数,这种情况下,后端使用DTO 对象进行接收。
只要给 DTO 对象加上 @Validated 注解就能实现自动参数校验。
比如,有一个保存 User 的接口,要求 userName 长度是 2-10,age 在 1 到 99 之间。如果校验失败,会抛出MethodArgumentNotValidException异常,Spring 默认会将其转为 400(Bad Request)请求。
- 在 DTO 字段上声明约束注解
@Data
public class UserDTO {
<span class="hljs-meta">@NotNull</span>
<span class="hljs-keyword">private</span> Long userId;
<span class="hljs-meta">@Length(min = 2, max = 10)</span>
<span class="hljs-keyword">private</span> String userName;
<span class="hljs-meta">@Min(1)</span>
<span class="hljs-meta">@Max(99)</span>
<span class="hljs-keyword">private</span> <span class="hljs-type">int</span> age;
- 在方法参数上声明校验注解
@PostMapping("/save")
public Result saveUser(@RequestBody @Validated UserQO userDTO) {
// 校验通过,才会执行业务逻辑处理
return Result.success();
}
这种情况下,使用 @Valid 和 @Validated 都可以。
3、requestParam 参数校验
GET 请求一般会使用requestParam/PathVariable传参。如果参数比较多 (比如超过 6 个),还是推荐使用 DTO 对象接收。否则,推荐将一个个参数平铺到方法入参中。
在这种情况下,必须在 Controller 类上标注 @Validated 注解,并在入参上声明约束注解 (如 @Min 等)。如果校验失败,会抛出ConstraintViolationException异常。
@RequestMapping("/api/user")
@RestController
@Validated
public class UserController {
// 路径变量
@GetMapping("{userId}")
public Result detail(@PathVariable("userId") @Min(10000000000000000L) Long userId) {
// 校验通过,才会执行业务逻辑处理
return Result.success();
}
<span class="hljs-comment">// 查询参数</span>
<span class="hljs-meta">@GetMapping("getByUserName")</span>
<span class="hljs-keyword">public</span> Result <span class="hljs-title function_">getByUserName</span><span class="hljs-params">(<span class="hljs-meta">@Length(min = 6, max = 20)</span> <span class="hljs-meta">@NotNull</span> String userName)</span> {
<span class="hljs-comment">// 校验通过,才会执行业务逻辑处理</span>
<span class="hljs-keyword">return</span> Result.success();
}
}
4、统一异常处理
前面说过,如果校验失败,会抛出MethodArgumentNotValidException或者ConstraintViolationException异常。在实际项目开发中,通常会用统一异常处理来返回一个更友好的提示。比如我们系统要求无论发送什么异常,http 的状态码必须返回 200,由业务码去区分系统的异常情况。
@RestControllerAdvice
@Slf4j
public class CommonExceptionHandler {
<span class="hljs-meta">@ExceptionHandler({MethodArgumentNotValidException.class})</span>
<span class="hljs-meta">@ResponseStatus(HttpStatus.OK)</span>
<span class="hljs-meta">@ResponseBody</span>
<span class="hljs-keyword">public</span> Result <span class="hljs-title function_">handleMethodArgumentNotValidException</span><span class="hljs-params">(MethodArgumentNotValidException ex)</span> {
<span class="hljs-type">BindingResult</span> <span class="hljs-variable">bindingResult</span> <span class="hljs-operator">=</span> ex.getBindingResult();
<span class="hljs-type">StringJoiner</span> <span class="hljs-variable">joiner</span> <span class="hljs-operator">=</span> <span class="hljs-keyword">new</span> <span class="hljs-title class_">StringJoiner</span>(<span class="hljs-string">","</span>);
<span class="hljs-keyword">for</span> (FieldError fieldError : bindingResult.getFieldErrors()) {
joiner.add(fieldError.getField()).add(<span class="hljs-string">":"</span>).add(fieldError.getDefaultMessage());
}
<span class="hljs-type">String</span> <span class="hljs-variable">msg</span> <span class="hljs-operator">=</span> joiner.toString();
<span class="hljs-keyword">return</span> Result.fail(BusinessCode.MISSING_PARAMETERS, msg);
}
<span class="hljs-meta">@ExceptionHandler({ConstraintViolationException.class})</span>
<span class="hljs-meta">@ResponseStatus(HttpStatus.OK)</span>
<span class="hljs-meta">@ResponseBody</span>
<span class="hljs-keyword">public</span> Result <span class="hljs-title function_">handleConstraintViolationException</span><span class="hljs-params">(ConstraintViolationException ex)</span> {
<span class="hljs-keyword">return</span> Result.fail(BusinessCode.MISSING_PARAMETERS, ex.getMessage());
}
<span class="hljs-meta">@ExceptionHandler({NotReadablePropertyException.class})</span>
<span class="hljs-meta">@ResponseStatus(HttpStatus.OK)</span>
<span class="hljs-meta">@ResponseBody</span>
<span class="hljs-keyword">public</span> Result <span class="hljs-title function_">handleNotReadablePropertyException</span><span class="hljs-params">(NotReadablePropertyException ex)</span> {
<span class="hljs-keyword">return</span> Result.fail(BusinessCode.MISSING_PARAMETERS, ex.getMessage());
}
<span class="hljs-meta">@ExceptionHandler({Exception.class})</span>
<span class="hljs-meta">@ResponseStatus(HttpStatus.OK)</span>
<span class="hljs-meta">@ResponseBody</span>
<span class="hljs-keyword">public</span> Result <span class="hljs-title function_">handleException</span><span class="hljs-params">(Exception ex)</span> {
log.error(<span class="hljs-string">"未知系统错误"</span>, ex);
<span class="hljs-keyword">return</span> Result.fail(BusinessCode.MISSING_PARAMETERS, ex.getMessage());
}
}
二、进阶使用
1、分组校验
在实际项目中,可能多个方法需要使用同一个DTO类来接收参数,而不同方法的校验规则很可能是不一样的。这个时候,简单地在 DTO 类的字段上加约束注解无法解决这个问题。因此,spring-validation 支持了分组校验的功能,专门用来解决这类问题。还是上面的例子,比如保存User的时候,userId 是可空的,但是更新User的时候,UserId 的值不能为空;其它字段的校验规则在两种情况下一样。这个时候使用分组校验的代码示例如下:
@Data
public class UserDTO {
<span class="hljs-meta">@NotNull(groups = Update.class)</span>
<span class="hljs-meta">@Null(groups = Save.class)</span>
<span class="hljs-keyword">private</span> Long userId;
<span class="hljs-meta">@NotNull(groups = {Save.class, Update.class})</span>
<span class="hljs-meta">@Length(min = 2, max = 10, groups = {Save.class, Update.class})</span>
<span class="hljs-keyword">private</span> String userName;
<span class="hljs-meta">@Min(value = 1, groups = {Save.class, Update.class})</span>
<span class="hljs-meta">@Max(value = 99, groups = {Save.class, Update.class})</span>
<span class="hljs-keyword">private</span> <span class="hljs-type">int</span> age;
<span class="hljs-comment">/**
* 保存的时候校验分组
*/</span>
<span class="hljs-keyword">public</span> <span class="hljs-keyword">interface</span> <span class="hljs-title class_">Save</span> {
}
<span class="hljs-comment">/**
* 更新的时候校验分组
*/</span>
<span class="hljs-keyword">public</span> <span class="hljs-keyword">interface</span> <span class="hljs-title class_">Update</span> {
}
}
- @Validated 注解上指定校验分组
@PostMapping("/save")
public Result saveUser(@RequestBody @Validated(UserDTO.Save.class) UserDTO userDTO) {
// 校验通过,才会执行业务逻辑处理
return Result.success();
}
<span class="hljs-meta">@PostMapping("/update")</span>
public Result updateUser(@RequestBody @Validated(UserDTO.Update.class) UserDTO userDTO) {
// 校验通过,才会执行业务逻辑处理
return Result.success();
}
优化,正常我们如果一个 DTO 进行通用的话,一般就类似userId,保存和更新不一样,其它都会一样,所以没必要每个属性都要加 groups = {Save.class, Update.class})。我们可以这样
@Data
public class UserGroupsDTO {
<span class="hljs-meta">@NotNull(groups = Update.class)</span>
<span class="hljs-meta">@Null(groups = Save.class)</span>
<span class="hljs-keyword">private</span> Long userId;
<span class="hljs-meta">@NotNull</span>
<span class="hljs-meta">@Length(min = 2, max = 10)</span>
<span class="hljs-keyword">private</span> String userName;
<span class="hljs-meta">@Min(1)</span>
<span class="hljs-meta">@Max(99)</span>
<span class="hljs-keyword">private</span> <span class="hljs-type">int</span> age;
}
我们只需要 userId 分组就可以了,其它不用分组。
接口请求也稍微修改下
@PostMapping("/save")
public Result saveUser(@RequestBody @Validated({UserDTO.Save.class, Default.class}) UserDTO userDTO) {
// 校验通过,才会执行业务逻辑处理
return Result.success();
}
<span class="hljs-meta">@PostMapping("/update")</span>
<span class="hljs-keyword">public</span> Result <span class="hljs-title function_">updateUser</span><span class="hljs-params">(<span class="hljs-meta">@RequestBody</span> <span class="hljs-meta">@Validated({UserDTO.Update.class, Default.class})</span> UserDTO userDTO)</span> {
<span class="hljs-comment">// 校验通过,才会执行业务逻辑处理</span>
<span class="hljs-keyword">return</span> Result.success();
}
只要在分组这里多传入一个默认分组 Default.class 就可以,是不是比上面要简便些。
2、嵌套校验
前面的示例中,DTO类里面的字段都是基本数据类型和String类型。但是实际场景中,有可能某个字段也是一个对象,这种情况先,可以使用嵌套校验
。比如,上面保存User信息的时候同时还带有Interest
信息。需要注意的是,
此时 DTO 类的对应字段必须标记
@Valid
注解。
@Data
public class UserGroupsDTO {
<span class="hljs-meta">@NotNull(groups = Update.class)</span>
<span class="hljs-meta">@Null(groups = Save.class)</span>
<span class="hljs-keyword">private</span> Long userId;
<span class="hljs-meta">@NotNull</span>
<span class="hljs-meta">@Length(min = 2, max = 10)</span>
<span class="hljs-keyword">private</span> String userName;
<span class="hljs-meta">@Min(1)</span>
<span class="hljs-meta">@Max(99)</span>
<span class="hljs-keyword">private</span> <span class="hljs-type">int</span> age;
<span class="hljs-meta">@NotNull</span>
<span class="hljs-meta">@Valid</span>
<span class="hljs-keyword">private</span> Interest interest;
<span class="hljs-comment">/**
* 兴趣实体
*/</span>
<span class="hljs-meta">@Data</span>
<span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">class</span> <span class="hljs-title class_">Interest</span> {
<span class="hljs-meta">@Min(1)</span>
<span class="hljs-keyword">private</span> Long interestId;
<span class="hljs-meta">@NotNull</span>
<span class="hljs-meta">@Length(min = 2, max = 10)</span>
<span class="hljs-keyword">private</span> String interestName;
}
<span class="hljs-comment">/**
* 保存的时候校验分组
*/</span>
<span class="hljs-keyword">public</span> <span class="hljs-keyword">interface</span> <span class="hljs-title class_">Save</span> {
}
<span class="hljs-comment">/**
* 更新的时候校验分组
*/</span>
<span class="hljs-keyword">public</span> <span class="hljs-keyword">interface</span> <span class="hljs-title class_">Update</span> {
}
}
嵌套校验可以结合分组校验一起使用。还有就是
嵌套集合校验
会对集合里面的每一项都进行校验,例如List<Job>字段会对这个list里面的每一个Interest对象都进行校验。
3、集合校验
如果请求体直接传递了json数组给后台,并希望对数组中的每一项都进行参数校验。此时,如果我们直接使用java.util.Collection
下的list或者set来接收数据,参数校验并不会生效!我们可以使用自定义 list 集合来接收参数:
@Data
public class ValidationList<E> implements List<E> {
<span class="hljs-meta">@Delegate</span> <span class="hljs-comment">// @Delegate是lombok注解</span>
<span class="hljs-meta">@Valid</span> <span class="hljs-comment">// 一定要加@Valid注解</span>
<span class="hljs-keyword">public</span> List<E> list = <span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayList</span><>();
<span class="hljs-comment">/**
* 一定要记得重写toString方法
*/</span>
<span class="hljs-meta">@Override</span>
<span class="hljs-keyword">public</span> String <span class="hljs-title function_">toString</span><span class="hljs-params">()</span> {
<span class="hljs-keyword">return</span> list.toString();
}
}
@Delegate 注解受 lombok 版本限制,1.18.6以上版本可支持, 否则启动报错。如果校验不通过,会抛出NotReadablePropertyException,同样可以使用统一异常进行处理。
比如,我们需要一次性保存多个User对象,Controller层的方法可以这么写:
@PostMapping("/saveList")
public Result saveList(@RequestBody @Validated(UserDTO.Save.class) ValidationList<UserDTO> userList) {
// 校验通过,才会执行业务逻辑处理
return Result.success();
}
4、自定义校验
业务需求总是比框架提供的这些简单校验要复杂的多,我们可以自定义校验来满足我们的需求。自定义spring validation 非常简单,假设我们自定义sex
(性别只有 man 跟 woman)校验,主要分为两步:
- 自定义约束注解
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {SexValidator.class})
public @interface Sex {
<span class="hljs-comment">// 默认错误消息</span>
String <span class="hljs-title function_">message</span><span class="hljs-params">()</span> <span class="hljs-keyword">default</span> <span class="hljs-string">"性别格式格式错误"</span>;
<span class="hljs-comment">// 分组</span>
Class<?>[] groups() <span class="hljs-keyword">default</span> {};
<span class="hljs-comment">// 负载</span>
Class<? <span class="hljs-keyword">extends</span> <span class="hljs-title class_">Payload</span>>[] payload() <span class="hljs-keyword">default</span> {};
}
- 实现
ConstraintValidator
接口编写约束校验器
public class SexValidator implements ConstraintValidator<Sex, String> {
<span class="hljs-keyword">private</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> <span class="hljs-type">String</span> <span class="hljs-variable">MAN</span> <span class="hljs-operator">=</span> <span class="hljs-string">"man"</span>;
<span class="hljs-keyword">private</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> <span class="hljs-type">String</span> <span class="hljs-variable">WOMAN</span> <span class="hljs-operator">=</span> <span class="hljs-string">"woman"</span>;
<span class="hljs-meta">@Override</span>
<span class="hljs-keyword">public</span> <span class="hljs-type">boolean</span> <span class="hljs-title function_">isValid</span><span class="hljs-params">(String value, ConstraintValidatorContext context)</span> {
<span class="hljs-comment">// 不为null才进行校验</span>
<span class="hljs-keyword">if</span> (value != <span class="hljs-literal">null</span>) {
<span class="hljs-keyword">if</span>(!Objects.equals(value,MAN) && !Objects.equals(value,WOMAN)) {
<span class="hljs-keyword">return</span> Boolean.FALSE;
}
}
<span class="hljs-keyword">return</span> Boolean.TRUE;
}
}
这样我们就可以使用@Sex
进行参数校验了!
5、编程式校验
上面的示例都是基于注解来实现自动校验的,在某些情况下,我们可能希望以编程方式
调用验证。这个时候可以注入javax.validation.Validator
对象,然后再调用其api。
@Autowired
private javax.validation.Validator globalValidator;
<span class="hljs-comment">// 编程式校验</span>
<span class="hljs-meta">@PostMapping("/saveWithCodingValidate")</span>
<span class="hljs-meta">@ApiOperation("编程式校验")</span>
<span class="hljs-keyword">public</span> Result <span class="hljs-title function_">saveWithCodingValidate</span><span class="hljs-params">(<span class="hljs-meta">@RequestBody</span> UserDTO userDTO)</span> {
Set<ConstraintViolation<UserDTO>> validate = globalValidator.validate(userDTO, UserDTO.Save.class);
<span class="hljs-comment">// 如果校验通过,validate为空;否则,validate包含未校验通过项</span>
<span class="hljs-keyword">if</span> (validate.isEmpty()) {
<span class="hljs-comment">// 校验通过,才会执行业务逻辑处理</span>
} <span class="hljs-keyword">else</span> {
<span class="hljs-keyword">for</span> (ConstraintViolation<UserDTO> userDTOConstraintViolation : validate) {
<span class="hljs-comment">// 校验失败,做其它逻辑</span>
System.out.println(userDTOConstraintViolation);
}
}
<span class="hljs-keyword">return</span> Result.success();
}
6、快速失败 (Fail Fast)
Spring Validation 默认会校验完所有字段,然后才抛出异常。可以通过一些简单的配置,开启Fali Fast
模式,一旦校验失败就立即返回。
@Bean
public Validator validator() {
ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
.configure()
// 快速失败模式
.failFast(true)
.buildValidatorFactory();
return validatorFactory.getValidator();
}
7、@Valid 和 @Validated 区别
区别 | @Valid | @Validated |
---|---|---|
提供者 | JSR-303 规范 | Spring |
是否支持分组 | 不支持 | 支持 |
标注位置 | METHOD, FIELD, CONSTRUCTOR, PARAMETER, TYPE_USE | TYPE, METHOD, PARAMETER |
嵌套校验 | 支持 | 不支持 |
三、实现原理
1、requestBody 参数校验实现原理
在 spring-mvc 中,RequestResponseBodyMethodProcessor 是用于解析 @RequestBody 标注的参数以及处理 @ResponseBody 标注方法的返回值的。显然,执行参数校验的逻辑肯定就在解析参数的方法resolveArgument()
中:
public class RequestResponseBodyMethodProcessor extends AbstractMessageConverterMethodProcessor {
@Override
public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {
parameter = parameter.nestedIfOptional();
<span class="hljs-comment">//将请求数据封装到DTO对象中</span>
<span class="hljs-type">Object</span> <span class="hljs-variable">arg</span> <span class="hljs-operator">=</span> readWithMessageConverters(webRequest, parameter, parameter.getNestedGenericParameterType());
<span class="hljs-type">String</span> <span class="hljs-variable">name</span> <span class="hljs-operator">=</span> Conventions.getVariableNameForParameter(parameter);
<span class="hljs-keyword">if</span> (binderFactory != <span class="hljs-literal">null</span>) {
<span class="hljs-type">WebDataBinder</span> <span class="hljs-variable">binder</span> <span class="hljs-operator">=</span> binderFactory.createBinder(webRequest, arg, name);
<span class="hljs-keyword">if</span> (arg != <span class="hljs-literal">null</span>) {
<span class="hljs-comment">// 执行数据校验</span>
validateIfApplicable(binder, parameter);
<span class="hljs-keyword">if</span> (binder.getBindingResult().hasErrors() && isBindExceptionRequired(binder, parameter)) {
<span class="hljs-keyword">throw</span> <span class="hljs-keyword">new</span> <span class="hljs-title class_">MethodArgumentNotValidException</span>(parameter, binder.getBindingResult());
}
}
<span class="hljs-keyword">if</span> (mavContainer != <span class="hljs-literal">null</span>) {
mavContainer.addAttribute(BindingResult.MODEL_KEY_PREFIX + name, binder.getBindingResult());
}
}
<span class="hljs-keyword">return</span> adaptArgumentIfNecessary(arg, parameter);
}
}
可以看到,resolveArgument()调用了 validateIfApplicable() 进行参数校验。
protected void validateIfApplicable(WebDataBinder binder, MethodParameter parameter) {
// 获取参数注解,比如 @RequestBody、@Valid、@Validated
Annotation[] annotations = parameter.getParameterAnnotations();
for (Annotation ann : annotations) {
// 先尝试获取 @Validated 注解
Validated validatedAnn = AnnotationUtils.getAnnotation(ann, Validated.class);
// 如果直接标注了 @Validated,那么直接开启校验。
// 如果没有,那么判断参数前是否有 Valid 起头的注解。
if (validatedAnn != null || ann.annotationType().getSimpleName().startsWith("Valid")) {
Object hints = (validatedAnn != null ? validatedAnn.value() : AnnotationUtils.getValue(ann));
Object[] validationHints = (hints instanceof Object[] ? (Object[]) hints : new Object[] {hints});
// 执行校验
binder.validate(validationHints);
break;
}
}
}
看到这里,大家应该能明白为什么这种场景下@Validated、@Valid两个注解可以混用。我们接下来继续看WebDataBinder.validate()
实现。
@Override
public void validate(Object target, Errors errors, Object... validationHints) {
if (this.targetValidator != null) {
processConstraintViolations(
// 此处调用 Hibernate Validator 执行真正的校验
this.targetValidator.validate(target, asValidationGroups(validationHints)), errors);
}
}
最终发现底层最终还是调用了Hibernate Validator 进行真正的校验处理。
2、方法级别的参数校验实现原理
上面提到的将参数一个个平铺到方法参数中,然后在每个参数前面声明约束注解的校验方式,就是方法级别的参数校验。实际上,这种方式可用于任何Spring Bean的方法上,比如Controller/Service等。其底层实现原理就是 AOP,具体来说是通过 MethodValidationPostProcessor 动态注册 AOP 切面,然后使用 MethodValidationInterceptor 对切点方法织入增强。
public class MethodValidationPostProcessor extends AbstractBeanFactoryAwareAdvisingPostProcessorimplements InitializingBean {
@Override
public void afterPropertiesSet() {
// 为所有 `@Validated` 标注的 Bean 创建切面
Pointcut pointcut = new AnnotationMatchingPointcut(this.validatedAnnotationType, true);
// 创建 Advisor 进行增强
this.advisor = new DefaultPointcutAdvisor(pointcut, createMethodValidationAdvice(this.validator));
}
<span class="hljs-comment">//创建Advice,本质就是一个方法拦截器</span>
<span class="hljs-keyword">protected</span> Advice <span class="hljs-title function_">createMethodValidationAdvice</span><span class="hljs-params">(<span class="hljs-meta">@Nullable</span> Validator validator)</span> {
<span class="hljs-keyword">return</span> (validator != <span class="hljs-literal">null</span> ? <span class="hljs-keyword">new</span> <span class="hljs-title class_">MethodValidationInterceptor</span>(validator) : <span class="hljs-keyword">new</span> <span class="hljs-title class_">MethodValidationInterceptor</span>());
}
}
接着看一下MethodValidationInterceptor
:
public class MethodValidationInterceptor implements MethodInterceptor {
@Override
public Object invoke(MethodInvocation invocation) throws Throwable {
// 无需增强的方法,直接跳过
if (isFactoryBeanMetadataMethod(invocation.getMethod())) {
return invocation.proceed();
}
// 获取分组信息
Class<?>[] groups = determineValidationGroups(invocation);
ExecutableValidator execVal = this.validator.forExecutables();
Method methodToValidate = invocation.getMethod();
Set<ConstraintViolation<Object>> result;
try {
// 方法入参校验,最终还是委托给 Hibernate Validator 来校验
result = execVal.validateParameters(
invocation.getThis(), methodToValidate, invocation.getArguments(), groups);
}
catch (IllegalArgumentException ex) {
...
}
// 有异常直接抛出
if (!result.isEmpty()) {
throw new ConstraintViolationException(result);
}
// 真正的方法调用
Object returnValue = invocation.proceed();
// 对返回值做校验,最终还是委托给 Hibernate Validator 来校验
result = execVal.validateReturnValue(invocation.getThis(), methodToValidate, returnValue, groups);
// 有异常直接抛出
if (!result.isEmpty()) {
throw new ConstraintViolationException(result);
}
return returnValue;
}
}
实际上,不管是 requestBody 参数校验还是方法级别的校验,最终都是调用 Hibernate Validator 执行校验,Spring Validation 只是做了一层封装。
感谢
这篇文章基本上来自 https://juejin.cn/post/6856541106626363399
自己只是跟着做了个 demo,修改了其中个别的错误。