一、简单使用
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>
如果是 spring boot项目,则推荐如下方式:通过引入 spring-boot-starter-validation
引入org.hibernate.hibernate-validator,无需指定版本,由 spring boot来 保证 版本 间的 兼容性
。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
创建 参数校验类 的 示例
import java.util.List;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
// 如果org.hibernate.hibernate-validator的版本为5.x.x,则这里必须引入该包下的NotBlank和NotEmpty,否则会报错
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
import lombok.Data;
import org.hibernate.validator.constraints.Length;
import org.hibernate.validator.constraints.Range;
@Data
public class User {
@Max(value = 10, message = "最大不能超过10")
private Integer i1;
@Min(value = 20, message = "最小不能小于20")
private Integer i2;
@NotNull(message = "不能为null")
@Min(value = 30, message = "最小不能小于30")
@Max(value = 100, message = "最大不能超过100")
private Integer i3;
@Range(min = 40, max = 40, message = "值必须等于40")
private int i4;
@NotNull(message = "不能为null")
private String s1;
@NotBlank(message = "不能为空")
private String s2;
@NotEmpty(message = "不能为空")
private String s3;
@Length(min = 2, max = 5, message = "范围为2~5")
private String s4;
@NotNull(message = "不能null")
private List<String> l1;
@NotEmpty(message = "不能为空")
private List<String> l2;
}
在Controller层一定要做参数校验的!大部分情况下,请求参数分为如下两种形式:
-
POST、PUT请求,使用 requestBody 传递参数;
-
GET 请求,使用 requestParam/PathVariable 传递参数。
2、requestBody参数校验
POST、PUT 请求一般会使用requestBody传递参数,这种情况下,后端使用DTO对象进行接收。
只要给DTO对象加上@Validated注解就能实现自动参数校验
比如,有一个保存User的接口,要求userName长度是2-10,age在1到99之间。如果校验失败,会抛出MethodArgumentNotValidException异常,Spring默认会将其转为400(Bad Request)请求。
- 在DTO字段上声明约束注解
package com.wtt.dto;
import lombok.Data;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
@Data
public class User {
@NotNull(message = "id不能为空")
@Min(value = 1, message = "最小不能小于1")
private Integer id;
@NotBlank(message = "name 不可为空")
private String name;
@NotNull(message = "sex 不能为空")
private boolean sex;
}
- 在方法参数上声明校验注解
package com.wtt.controller;
import com.wtt.dto.User;
import org.springframework.validation.BindingResult;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
import java.util.StringJoiner;
@RestController
public class UsersController {
@PostMapping("/a1")
public int a1(@RequestBody @Validated User userDto, BindingResult result) {
// 判断 是否有 参数解析、校验 错误
if (result.hasErrors()) {
// 字符串拼接器, 通过 | 符号 进行 多个错误信息的 连接
StringJoiner errorMsg = new StringJoiner(" | ");
result.getFieldErrors().forEach(data -> errorMsg.add(data.getDefaultMessage()));
System.out.println(errorMsg.toString());
return 1;
}
System.out.println(userDto);
return 0;
}
}
这种情况下,使用
@Valid
和@Validated
都可以。
3、requestParam参数校验
GET请求一般会使用requestParam / PathVariable传参。
如果参数比较多(比如超过6个),还是推荐使用DTO对象接收。否则,推荐将一个个参数平铺到方法入参中。
在这种情况下,必须在 Controller类上标注@Validated注解,并在入参上声明约束注解(如@Min等)。
如果校验失败,会抛出** ConstraintViolationException **异常。
package com.wtt.controller;
import com.wtt.dto.User;
import org.springframework.validation.BindingResult;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import java.util.StringJoiner;
@RestController
@Validated
public class UsersController {
@GetMapping("/a1")
public int a1(@NotNull(message = "name 不可为空") String name, @Min(value = 1, message = "最小不能小于1") int id) {
System.out.println(name);
System.out.println(id);
return 0;
}
}
4、统一异常处理
前面说过,如果校验失败,会抛出**MethodArgumentNotValidException
或者ConstraintViolationException
**异常,这两个异常 都 继承于 BindException
。
在实际项目开发中,通常会用 统一异常处理 来返回一个更友好的提示。
package com.wtt.global;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;
import java.net.BindException;
@ControllerAdvice
public class ErrDeal {
@ExceptionHandler({BindException.class})
@ResponseStatus(HttpStatus.OK)
@ResponseBody
public String handleBindException(BindException ex) {
StringBuilder errorMsg = new StringBuilder();
// 获取所有字段验证出错的信息
String msg = ex.getMessage();
return msg;
}
}
二、进阶使用
1、分组校验
在实际项目中,可能多个方法需要使用同一个DTO类来接收参数,而不同方法的校验规则很可能是不一样的。这个时候,简单地在DTO类的字段上加约束注解无法解决这个问题。
因此,spring-validation支持了分组校验的功能,专门用来解决这类问题。还是上面的例子,比如保存User的时候,userId是可空的,但是更新User的时候,UserId的值不能为空;其它字段的校验规则在两种情况下一样。这个时候使用分组校验的代码示例如下:
@Data
public class UserDTO {
@NotNull(groups = Update.class)
@Null(groups = Save.class)
private Long userId;
@NotNull(groups = {Save.class, Update.class})
@Length(min = 2, max = 10, groups = {Save.class, Update.class})
private String userName;
@Min(value = 1, groups = {Save.class, Update.class})
@Max(value = 99, groups = {Save.class, Update.class})
private int age;
/**
* 保存的时候校验分组
*/
public interface Save {
}
/**
* 更新的时候校验分组
*/
public interface Update {
}
}
- @Validated注解上指定校验分组
@PostMapping("/save")
public Result saveUser(@RequestBody @Validated(UserDTO.Save.class) UserDTO userDTO) {
// 校验通过,才会执行业务逻辑处理
return Result.success();
}
@PostMapping("/update")
public Result updateUser(@RequestBody @Validated(UserDTO.Update.class) UserDTO userDTO) {
// 校验通过,才会执行业务逻辑处理
return Result.success();
}
优化,正常我们如果一个DTO进行通用的话,一般就类似userId,保存和更新不一样,其它都会一样,所以没必要每个属性都要加 groups = {Save.class, Update.class})。我们可以这样
@Data
public class UserGroupsDTO {
@NotNull(groups = Update.class)
@Null(groups = Save.class)
private Long userId;
@NotNull
@Length(min = 2, max = 10)
private String userName;
@Min(1)
@Max(99)
private int age;
}
我们只需要userId分组就可以了,其它不用分组。
接口请求也稍微修改下
@PostMapping("/save")
public Result saveUser(@RequestBody @Validated({UserDTO.Save.class, Default.class}) UserDTO userDTO) {
// 校验通过,才会执行业务逻辑处理
return Result.success();
}
@PostMapping("/update")
public Result updateUser(@RequestBody @Validated({UserDTO.Update.class, Default.class}) UserDTO userDTO) {
// 校验通过,才会执行业务逻辑处理
return Result.success();
}
只要在分组这里多传入一个默认分组 Default.class 就可以,是不是比上面要简便些。
2、嵌套校验
前面的示例中,DTO类里面的字段都是基本数据类型和String类型。但是实际场景中,有可能某个字段也是一个对象,这种情况先,可以使用嵌套校验
。比如,上面保存User信息的时候同时还带有Interest
信息。需要注意的是,
此时DTO类的对应字段必须标记
@Valid
注解。
@Data
public class UserGroupsDTO {
@NotNull(groups = Update.class)
@Null(groups = Save.class)
private Long userId;
@NotNull
@Length(min = 2, max = 10)
private String userName;
@Min(1)
@Max(99)
private int age;
@NotNull
@Valid
private Interest interest;
/**
* 兴趣实体
*/
@Data
public static class Interest {
@Min(1)
private Long interestId;
@NotNull
@Length(min = 2, max = 10)
private String interestName;
}
/**
* 保存的时候校验分组
*/
public interface Save {
}
/**
* 更新的时候校验分组
*/
public interface Update {
}
}
嵌套校验可以结合分组校验一起使用。还有就是
嵌套集合校验
会对集合里面的每一项都进行校验,例如List字段会对这个list里面的每一个Interest对象都进行校验。
3、集合校验
如果请求体直接传递了json数组给后台,并希望对数组中的每一项都进行参数校验。此时,如果我们直接使用java.util.Collection
下的list或者set来接收数据,参数校验并不会生效!我们可以使用自定义list集合来接收参数:
@Data
public class ValidationList<E> implements List<E> {
@Delegate // @Delegate是lombok注解
@Valid // 一定要加@Valid注解
public List<E> list = new ArrayList<>();
/**
* 一定要记得重写toString方法
*/
@Override
public String toString() {
return 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 {
// 默认错误消息
String message() default "性别格式格式错误";
// 分组
Class<?>[] groups() default {};
// 负载
Class<? extends Payload>[] payload() default {};
}
- 实现
ConstraintValidator
接口编写约束校验器
public class SexValidator implements ConstraintValidator<Sex, String> {
private static final String MAN = "man";
private static final String WOMAN = "woman";
@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
// 不为null才进行校验
if (value != null) {
if(!Objects.equals(value,MAN) && !Objects.equals(value,WOMAN)) {
return Boolean.FALSE;
}
}
return Boolean.TRUE;
}
}
这样我们就可以使用@Sex
进行参数校验了!
5、编程式校验
上面的示例都是基于注解来实现自动校验的,在某些情况下,我们可能希望以编程方式
调用验证。这个时候可以注入javax.validation.Validator
对象,然后再调用其api。
@Autowired
private javax.validation.Validator globalValidator;
// 编程式校验
@PostMapping("/saveWithCodingValidate")
@ApiOperation("编程式校验")
public Result saveWithCodingValidate(@RequestBody UserDTO userDTO) {
Set<ConstraintViolation<UserDTO>> validate = globalValidator.validate(userDTO, UserDTO.Save.class);
// 如果校验通过,validate为空;否则,validate包含未校验通过项
if (validate.isEmpty()) {
// 校验通过,才会执行业务逻辑处理
} else {
for (ConstraintViolation<UserDTO> userDTOConstraintViolation : validate) {
// 校验失败,做其它逻辑
System.out.println(userDTOConstraintViolation);
}
}
return 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();
//将请求数据封装到DTO对象中
Object arg = readWithMessageConverters(webRequest, parameter, parameter.getNestedGenericParameterType());
String name = Conventions.getVariableNameForParameter(parameter);
if (binderFactory != null) {
WebDataBinder binder = binderFactory.createBinder(webRequest, arg, name);
if (arg != null) {
// 执行数据校验
validateIfApplicable(binder, parameter);
if (binder.getBindingResult().hasErrors() && isBindExceptionRequired(binder, parameter)) {
throw new MethodArgumentNotValidException(parameter, binder.getBindingResult());
}
}
if (mavContainer != null) {
mavContainer.addAttribute(BindingResult.MODEL_KEY_PREFIX + name, binder.getBindingResult());
}
}
return 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));
}
//创建Advice,本质就是一个方法拦截器
protected Advice createMethodValidationAdvice(@Nullable Validator validator) {
return (validator != null ? new MethodValidationInterceptor(validator) : new MethodValidationInterceptor());
}
}
接着看一下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只是做了一层封装。
好文分享,一起加油!