SpringBoot中集成参数校验

第一步，引入依赖

  1. <dependency>
  2.   <groupId>org.springframework.boot</groupId>
  3.   <artifactId>spring-boot-starter-web</artifactId>
  4. </dependency>
  5. <dependency>
  6.   <groupId>org.springframework.boot</groupId>
  7.   <artifactId>spring-boot-starter-validation</artifactId>
  8. </dependency>

“> 注：从springboot-2.3开始，校验包被独立成了一个starter组件，所以需要引入validation和web，而springboot-2.3之前的版本只需要引入 web 依赖就可以了。 ”

第二步，定义要参数校验的实体类

  1. @Data
  2. public class ValidVO {
  3.     private String id;
  4.     @Length(min = 6,max = 12,message = "appId长度必须位于6到12之间")
  5.     private String appId;
  6.     @NotBlank(message = "名字为必填项")
  7.     private String name;
  8.     @Email(message = "请填写正确的邮箱地址")
  9.     private String email;
  10.     private String sex;
  11.     @NotEmpty(message = "级别不能为空")
  12.     private String level;
  13. }

在实际开发中对于需要校验的字段都需要设置对应的业务提示，即message属性。
常见的约束注解如下：

注解 功能
@AssertFalse 可以为null,如果不为null的话必须为false
@AssertTrue 可以为null,如果不为null的话必须为true
@DecimalMax 设置不能超过最大值
@DecimalMin 设置不能超过最小值
@Digits 设置必须是数字且数字整数的位数和小数的位数必须在指定范围内
@Future 日期必须在当前日期的未来
@Past 日期必须在当前日期的过去
@Max 最大不得超过此最大值
@Min 最大不得小于此最小值
@NotNull 不能为null，可以是空
@Null 必须为null
@Pattern 必须满足指定的正则表达式
@Size 集合、数组、map等的size()值必须在指定范围内
@Email 必须是email格式
@Length 长度必须在指定范围内
@NotBlank 字符串不能为null,字符串trim()后也不能等于“”
@NotEmpty 不能为null，集合、数组、map等size()不能为0；字符串trim()后可以等于“”
@Range 值必须在指定范围内
@URL 必须是一个URL

注：此表格只是简单的对注解功能的说明，并没有对每一个注解的属性进行说明；可详见源码。

第三步，定义校验类进行测试

  1. @RestController
  2. @Slf4j
  3. @Validated
  4. public class ValidController {
  5.     @ApiOperation("RequestBody校验")
  6.     @PostMapping("/valid/test1")   
  7.     public String test1(@Validated @RequestBody ValidVO validVO){
  8.         log.info("validEntity is {}", validVO);
  9.         return "test1 valid success";
  10.     }
  11.     @ApiOperation("Form校验")
  12.     @PostMapping(value = "/valid/test2")
  13.     public String test2(@Validated ValidVO validVO){
  14.         log.info("validEntity is {}", validVO);
  15.         return "test2 valid success";
  16.     }
  18.    @ApiOperation("单参数校验")
  19.     @PostMapping(value = "/valid/test3")
  20.     public String test3(@Email String email){
  21.         log.info("email is {}", email);
  22.         return "email valid success";
  23.     }
  24. }

这里我们先定义三个方法test1，test2，test3，test1使用了@RequestBody注解，用于接受前端发送的json数据，test2模拟表单提交，test3模拟单参数提交。注意，当使用单参数校验时需要在Controller上加上@Validated注解，否则不生效。

第四步，体验效果

  1. 调用test1方法，提示的是org.springframework.web.bind.MethodArgumentNotValidException异常

    1. POST http://localhost:8080/valid/test1
    2. Content-Type: application/json
    3. {
    4. "id": 1,
    5. "level": "12",
    6. "email": "47693899",
    7. "appId": "ab1c"
    8. }
    1. {
    2. "status": 500,
    3. "message": "Validation failed for argument [0] in public java.lang.String com.jianzh5.blog.valid.ValidController.test1(com.jianzh5.blog.valid.ValidVO) with 3 errors: [Field error in object 'validVO' on field 'email': rejected value [47693899]; codes [Email.validVO.email,Email.email,Email.java.lang.String,Email]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [validVO.email,email]; arguments []; default message [email],[Ljavax.validation.constraints.Pattern$Flag;@26139123,.*]; default message [不是一个合法的电子邮件地址]]...",
    4. "data": null,
    5. "timestamp": 1628239624332
    6. }

  2. 调用test2方法，提示的是org.springframework.validation.BindException异常

    1. POST http://localhost:8080/valid/test2
    2. Content-Type: application/x-www-form-urlencoded
    3. id=1&level=12&email=476938977&appId=ab1c
    1. {
    2. "status": 500,
    3. "message": "org.springframework.validation.BeanPropertyBindingResult: 3 errors\nField error in object 'validVO' on field 'name': rejected value [null]; codes [NotBlank.validVO.name,NotBlank.name,NotBlank.java.lang.String,NotBlank]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [validVO.name,name]; arguments []; default message [name]]; default message [名字为必填项]...",
    4. "data": null,
    5. "timestamp": 1628239301951
    6. }

  3. 调用test3方法，提示的是javax.validation.ConstraintViolationException异常

    1. POST http://localhost:8080/valid/test3
    2. Content-Type: application/x-www-form-urlencoded
    3. email=476938977
    1. {
    2. "status": 500,
    3. "message": "test3.email: 不是一个合法的电子邮件地址",
    4. "data": null,
    5. "timestamp": 1628239281022
    6. }

    通过加入Validator校验框架可以帮助我们自动实现参数的校验。

    参数异常加入全局异常处理器

    虽然我们之前定义了全局异常拦截器，也看到了拦截器确实生效了，但是Validator校验框架返回的错误提示太臃肿了，不便于阅读，为了方便前端提示，我们需要将其简化一下。
    直接修改之前定义的RestExceptionHandler，单独拦截参数校验的三个异常：javax.validation.ConstraintViolationException，org.springframework.validation.BindException，org.springframework.web.bind.MethodArgumentNotValidException，代码如下：

    1. @ExceptionHandler(value = {BindException.class, ValidationException.class, MethodArgumentNotValidException.class})
    2. public ResponseEntity<ResultData<String>> handleValidatedException(Exception e) {
    3. ResultData<String> resp = null;
    4. if (e instanceof MethodArgumentNotValidException) {
    5.  // BeanValidation exception
    6.  MethodArgumentNotValidException ex = (MethodArgumentNotValidException) e;
    7.  resp = ResultData.fail(HttpStatus.BAD_REQUEST.value(),
    8.                         ex.getBindingResult().getAllErrors().stream()
    9.                         .map(ObjectError::getDefaultMessage)
    10.                         .collect(Collectors.joining("; "))
    11.                        );
    12. } else if (e instanceof ConstraintViolationException) {
    13.  // BeanValidation GET simple param
    14.  ConstraintViolationException ex = (ConstraintViolationException) e;
    15.  resp = ResultData.fail(HttpStatus.BAD_REQUEST.value(),
    16.                         ex.getConstraintViolations().stream()
    17.                         .map(ConstraintViolation::getMessage)
    18.                         .collect(Collectors.joining("; "))
    19.                        );
    20. } else if (e instanceof BindException) {
    21.  // BeanValidation GET object param
    22.  BindException ex = (BindException) e;
    23.  resp = ResultData.fail(HttpStatus.BAD_REQUEST.value(),
    24.                         ex.getAllErrors().stream()
    25.                         .map(ObjectError::getDefaultMessage)
    26.                         .collect(Collectors.joining("; "))
    27.                        );
    28. }
    29. return new ResponseEntity<>(resp,HttpStatus.BAD_REQUEST);
    30. }

    体验效果

    1. POST http://localhost:8080/valid/test1
    2. Content-Type: application/json
    3. {
    4. "id": 1,
    5. "level": "12",
    6. "email": "47693899",
    7. "appId": "ab1c"
    8. }
    1. {
    2. "status": 400,
    3. "message": "名字为必填项; 不是一个合法的电子邮件地址; appId长度必须位于6到12之间",
    4. "data": null,
    5. "timestamp": 1628435116680
    6. }

    是不是感觉清爽多了？

    自定义参数校验

    虽然Spring Validation 提供的注解基本上够用，但是面对复杂的定义，我们还是需要自己定义相关注解来实现自动校验。
    比如上面实体类中的sex性别属性，只允许前端传递传 M，F 这2个枚举值，如何实现呢？

    第一步，创建自定义注解

    1. @Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
    2. @Retention(RUNTIME)
    3. @Repeatable(EnumString.List.class)
    4. @Documented
    5. @Constraint(validatedBy = EnumStringValidator.class)//标明由哪个类执行校验逻辑
    6. public @interface EnumString {
    7.  String message() default "value not in enum values.";
    8.  Class<?>[] groups() default {};
    9.  Class<? extends Payload>[] payload() default {};
    10.  /**
    11.   * @return date must in this value array
    12.   */
    13.  String[] value();
    14.  /**
    15.   * Defines several {@link EnumString} annotations on the same element.
    16.   *
    17.   * @see EnumString
    18.   */
    19.  @Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
    20.  @Retention(RUNTIME)
    21.  @Documented
    22.  @interface List {
    23.      EnumString[] value();
    24.  }
    25. }

    第二步，自定义校验逻辑

    1. public class EnumStringValidator implements ConstraintValidator<EnumString, String> {
    2.  private List<String> enumStringList;
    3.  @Override
    4.  public void initialize(EnumString constraintAnnotation) {
    5.      enumStringList = Arrays.asList(constraintAnnotation.value());
    6.  }
    7.  @Override
    8.  public boolean isValid(String value, ConstraintValidatorContext context) {
    9.      if(value == null){
    10.          return true;
    11.      }
    12.      return enumStringList.contains(value);
    13.  }
    14. }

    第三步，在字段上增加注解

    1. @ApiModelProperty(value = "性别")
    2. @EnumString(value = {"F","M"}, message="性别只允许为F或M")
    3. private String sex;

    第四步，体验效果

    1. POST http://localhost:8080/valid/test2
    2. Content-Type: application/x-www-form-urlencoded
    3. id=1&name=javadaily&level=12&email=476938977@qq.com&appId=ab1cdddd&sex=N
    1. {
    2. "status": 400,
    3. "message": "性别只允许为F或M",
    4. "data": null,
    5. "timestamp": 1628435243723
    6. }

    分组校验

    一个VO对象在新增的时候某些字段为必填，在更新的时候又非必填。如上面的ValidVO中 id 和 appId 属性在新增操作时都是非必填，而在编辑操作时都为必填，name在新增操作时为必填，面对这种场景你会怎么处理呢？
    在实际开发中我见到很多同学都是建立两个VO对象，ValidCreateVO，ValidEditVO来处理这种场景，这样确实也能实现效果，但是会造成类膨胀，而且极其容易被开发老鸟们嘲笑。
    SprinBoot中集成参数校验Validator - 图1
    其实Validator校验框架已经考虑到了这种场景并且提供了解决方案，就是分组校验，只不过很多同学不知道而已。要使用分组校验，只需要三个步骤：

    第一步：定义分组接口

    1. public interface ValidGroup extends Default {
    3.  interface Crud extends ValidGroup{
    4.      interface Create extends Crud{
    5.      }
    6.      interface Update extends Crud{
    7.      }
    8.      interface Query extends Crud{
    9.      }
    10.      interface Delete extends Crud{
    11.      }
    12.  }
    13. }

    这里我们定义一个分组接口ValidGroup让其继承javax.validation.groups.Default，再在分组接口中定义出多个不同的操作类型，Create，Update，Query，Delete。至于为什么需要继承Default我们稍后再说。

    第二步，在模型中给参数分配分组

    1. @Data
    2. @ApiModel(value = "参数校验类")
    3. public class ValidVO {
    4.  @ApiModelProperty("ID")
    5.  @Null(groups = ValidGroup.Crud.Create.class)
    6.  @NotNull(groups = ValidGroup.Crud.Update.class, message = "应用ID不能为空")
    7.  private String id;
    8.  @Null(groups = ValidGroup.Crud.Create.class)
    9.  @NotNull(groups = ValidGroup.Crud.Update.class, message = "应用ID不能为空")
    10.  @ApiModelProperty(value = "应用ID",example = "cloud")
    11.  private String appId;
    12.  @ApiModelProperty(value = "名字")
    13.  @NotBlank(groups = ValidGroup.Crud.Create.class,message = "名字为必填项")
    14.  private String name;
    16. @ApiModelProperty(value = "邮箱")
    17.  @Email(message = "请填写正取的邮箱地址")
    18.  privte String email;
    19.  ...
    20. }

    给参数指定分组，对于未指定分组的则使用的是默认分组。

    第三步，给需要参数校验的方法指定分组

    1. @RestController
    2. @Api("参数校验")
    3. @Slf4j
    4. @Validated
    5. public class ValidController {
    6.  @ApiOperation("新增")
    7.  @PostMapping(value = "/valid/add")
    8.  public String add(@Validated(value = ValidGroup.Crud.Create.class) ValidVO validVO){
    9.      log.info("validEntity is {}", validVO);
    10.      return "test3 valid success";
    11.  }
    12.  @ApiOperation("更新")
    13.  @PostMapping(value = "/valid/update")
    14.  public String update(@Validated(value = ValidGroup.Crud.Update.class) ValidVO validVO){
    15.      log.info("validEntity is {}", validVO);
    16.      return "test4 valid success";
    17.  }
    18. }

    这里我们通过value属性给add()和update()方法分别指定Create和Update分组。

    第四步，体验效果

    1. POST http://localhost:8080/valid/add
    2. Content-Type: application/x-www-form-urlencoded
    3. name=javadaily&level=12&email=476938977@qq.com&sex=F

    在Create时我们没有传递id和appId参数，校验通过。
    当我们使用同样的参数调用update方法时则提示参数校验错误。

    1. {
    2. "status": 400,
    3. "message": "ID不能为空; 应用ID不能为空",
    4. "data": null,
    5. "timestamp": 1628492514313
    6. }

    由于email属于默认分组，而我们的分组接口ValidGroup已经继承了Default分组，所以也是可以对email字段作参数校验的。如：

    1. POST http://localhost:8080/valid/add
    2. Content-Type: application/x-www-form-urlencoded
    3. name=javadaily&level=12&email=476938977&sex=F
    1. {
    2. "status": 400,
    3. "message": "请填写正取的邮箱地址",
    4. "data": null,
    5. "timestamp": 1628492637305
    6. }

    当然如果你的ValidGroup没有继承Default分组，那在代码属性上就需要加上@Validated(value = {ValidGroup.Crud.Create.class, Default.class}才能让email字段的校验生效。

    小结

    参数校验在实际开发中使用频率非常高，但是很多同学还只是停留在简单的使用上，像分组校验，自定义参数校验这2个高阶技巧基本没怎么用过，经常出现譬如建立多个VO用于接受Create，Update场景的情况，很容易被老鸟被所鄙视嘲笑，希望大家好好掌握。