Spring Validation是对hibernate validation的二次封装，用于支持spring mvc参数自动校验。
Spring Boot 实现各种参数校验
添加数据效验
如果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.15.Final</version>
</dependency>
@Valid和@Validated的区别
@Valid是属于javax.validation，而@Validated是属于spring的，可以将@Validated看做是@Valid的升级版，属于是HibernateValid的封装应用。
@valid
其往往与bindingResult一起应用,它是验证结果的收集类
@Data
public class UserDTO {
@NotNull
private Long userId;
@Length(min = 2, max = 10)
private String userName;
@Min(1)
@Max(99)
private int age;
}
@PostMapping("/save")
public Result saveUser(@RequestBody @Valid UserQO userDTO,BindingResult bindingResult) {
if (bindingResult.hasErrors()){
Result.error (bindingResult.getErrors().get(0).getDefaultMessage()); //获取第一个错误
}
// 校验通过，才会执行业务逻辑处理
return Result.success();
}
但是值得注意的是，如果写了bindingResult接收错误信息，但是业务代码没有写处理逻辑的话，即没有判断bindingResult.hasErrors()，则会跳过这个@Valid，什么都不判断。如果没有写bindingResult的话，只写@Valid的话，还是会进行判断的。
@Validated
使用@Validated不需要BindingResult，直接在参数前使用@Validated即可，效果是一样的，遇到校验出错会抛出异常，可以使用@ControllerAdvice注解来的异常处理类来接收处理，如下：
@PostMapping("/save")
public Result saveUser(@RequestBody @Validated UserQO userDTO) {
return Result.success();
}
@RestControllerAdvice
@Slf4j
public class CommonExceptionHandler {
@ExceptionHandler({MethodArgumentNotValidException.class})
@ResponseStatus(HttpStatus.OK)
@ResponseBody
public Result handleMethodArgumentNotValidException(MethodArgumentNotValidException ex) {
BindingResult bindingResult = ex.getBindingResult();
StringJoiner joiner = new StringJoiner(",");
for (FieldError fieldError : bindingResult.getFieldErrors()) {
joiner.add(fieldError.getField()).add(":").add(fieldError.getDefaultMessage());
}
String msg = joiner.toString();
return Result.error(BusinessCode.MISSING_PARAMETERS, msg);
}
@ExceptionHandler({NotReadablePropertyException.class})
@ResponseStatus(HttpStatus.OK)
@ResponseBody
public Result handleNotReadablePropertyException(NotReadablePropertyException ex) {
return Result.error(BusinessCode.MISSING_PARAMETERS, ex.getMessage());
}
@ExceptionHandler({Exception.class})
@ResponseStatus(HttpStatus.OK)
@ResponseBody
public Result handleException(Exception ex) {
log.error("未知系统错误", ex);
return Result.fail(BusinessCode.MISSING_PARAMETERS, ex.getMessage());
}
}
@Valid 和 @Validated 两个注解进行总结下：
（1）@Valid 和 @Validated 两者都可以对数据进行校验，待校验字段上打的规则注解（@NotNull, @NotEmpty等）都可以对 @Valid 和 @Validated 生效；
（2）@Valid 进行校验的时候，需要用 BindingResult 来做一个校验结果接收。当校验不通过的时候，如果手动不 return ，则并不会阻止程序的执行；
（3）@Validated 进行校验的时候，当校验不通过的时候，程序会抛出400异常，阻止方法中的代码执行，这时需要再写一个全局校验异常捕获处理类，然后返回校验提示。
（4）总体来说，@Validated 使用起来要比 @Valid 方便一些，它可以帮我们节省一定的代码，并且使得方法看上去更加的简洁。
请求校验
对于web服务来说，为防止非法参数对业务造成影响，在Controller层一定要做参数校验的！大部分情况下，请求参数分为如下两种形式：
- POST、PUT请求，使用requestBody传递参数；
- GET 请求，使用requestParam/PathVariable传递参数。
requestBody参数校验
POST、PUT 请求一般会使用requestBody传递参数，这种情况下，后端使用DTO对象进行接收。
只要给DTO对象加上@Validated注解就能实现自动参数校验。
比如，有一个保存User的接口，要求userName长度是2-10，age在1到99之间。如果校验失败，会抛出MethodArgumentNotValidException异常，Spring默认会将其转为400（Bad Request）请求。
- 在DTO字段上声明约束注解
@Data
public class UserDTO {
@NotNull
private Long userId;
@Length(min = 2, max = 10)
private String userName;
@Min(1)
@Max(99)
private int age;
- 在方法参数上声明校验注解，使用@Valid和@Validated都可以
@PostMapping("/save")
public Result saveUser(@RequestBody @Validated UserQO userDTO) {
// 校验通过，才会执行业务逻辑处理
return Result.success();
}
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();
}
// 查询参数
@GetMapping("getByUserName")
public Result getByUserName(@Length(min = 6, max = 20) @NotNull String userName) {
// 校验通过，才会执行业务逻辑处理
return Result.success();
}
}
分组校验
在实际项目中，可能多个方法需要使用同一个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分组就可以了，其它不用分组。
接口请求也稍微修改下: 只要在分组这里多传入一个默认分组 Default.class 就可以
@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();
}
嵌套校验
前面的示例中，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 {
}
}
自定义校验
业务需求总是比框架提供的这些简单校验要复杂的多，我们可以自定义校验来满足我们的需求。自定义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进行参数校验
快速失败(Fail Fast)
Spring Validation默认会校验完所有字段，然后才抛出异常。可以通过一些简单的配置，开启Fali Fast模式，一旦校验失败就立即返回。
@Bean
public Validator validator() {
ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
.configure()
// 快速失败模式
.failFast(true)
.buildValidatorFactory();
return validatorFactory.getValidator();
}