JSR303校验

156 阅读3分钟

1. 统一校验的需求

  • 前端请求后端接口传输参数,是在controller中校验还是在Service中校验? 答案是都需要校验,只是分工不同。

  • Contoller中校验请求参数的合法性,包括:必填项校验,数据格式校验,比如:是否是符合一定的日期格式等。 Service中要校验的是业务规则相关的内容,比如:课程已经审核通过所以提交失败。

  • Service中根据业务规则去校验不方便写成通用代码,Controller中则可以将校验的代码写成通用代码。

  • 早在JavaEE6规范中就定义了参数校验的规范,它就是JSR-303,它定义了Bean Validation,即对bean属性进行校验。 SpringBoot提供了JSR-303的支持,它就是spring-boot-starter-validation,它的底层使用Hibernate Validator,Hibernate Validator是Bean Validation 的参考实现。 所以,需要在Controller层使用spring-boot-starter-validation完成对请求参数的基本合法性进行校验。

2. 统一校验实现

  • 添加spring-boot-starter-validation的依赖

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-validation</artifactId>
    </dependency>
    
  • 对某个口进行参数校验,如下

    @PostMapping("/course")
    public CourseBaseInfoDto createCourseBase(@RequestBody CourseDto courseDto){
        return courseService.createCours(CourseDto);
    }
    
  • CourseDto类中在属性上添加校验规则

    @NotEmpty(message = "适用人群不能为空")
    @Size(message = "适用人群内容过少",min = 10)
    private String users;
    

    上边用到了@NotEmpty@Size两个注解,@NotEmpty表示属性不能为空,@Size表示限制属性内容的长短。

  • 在javax.validation.constraints包下有很多这样的校验注解,如下表

    image.png

  • 定义好校验规则还需要开启校验,在controller方法中添加@Validated注解,如下:

    @PostMapping("/course")
    public CourseBaseInfoDto createCourseBase(@RequestBody @Validated CourseDto courseDto){
        return courseService.createCours(CourseDto);
    }
    
  • 如果校验出错Spring会抛出MethodArgumentNotValidException异常,我们需要在统一异常处理器中捕获异常,解析出异常信息。代码如下

    @ResponseBody
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    public RestErrorResponse doValidException(MethodArgumentNotValidException argumentNotValidException) {
      // RestErrorResponse是自定义的错误响应参数包装类
      BindingResult bindingResult = argumentNotValidException.getBindingResult();
      StringBuffer errMsg = new StringBuffer();
    
      List<FieldError> fieldErrors = bindingResult.getFieldErrors();
      fieldErrors.forEach(error -> {
          errMsg.append(error.getDefaultMessage()).append(",");
      });
      log.error(errMsg.toString());
      return new RestErrorResponse(errMsg.toString());
    }
    

3. 分组校验

  • 有时候在同一个属性上设置一个校验规则不能满足要求,比如:订单编号由系统生成,在添加订单时要求订单编号为空,在更新 订单时要求订单编写不能为空。此时就用到了分组校验,同一个属性定义多个校验规则属于不同的分组,比如:添加订单定义@NULL规则属于insert分组,更新订单定义@NotEmpty规则属于update分组,insert和update是分组的名称,是可以修改的。

  • 下边举例说明 我们用class类型来表示不同的分组,所以我们定义不同的接口类型(空接口)表示不同的分组,由于校验分组是公用的,所以定义在 base工程中。如下:

    public class ValidationGroups {
       public interface Inster{};
       public interface Update{};
       public interface Delete{};
    }
    
  • 下边在定义校验规则时指定分组

    @NotEmpty(groups = {ValidationGroups.Inster.class},message = "添加课程名称不能为空")
    @NotEmpty(groups = {ValidationGroups.Update.class},message = "修改课程名称不能为空")
    private String name;
    
  • 在Controller方法中启动校验规则指定要使用的分组名

    @PostMapping("/course")
    public CourseBaseInfoDto createCourseBase(@RequestBody @Validated({ValidationGroups.Inster.class}) CourseDto courseDto){
       return courseService.createCours(CourseDto);
    }
    

    再次测试,由于这里指定了Insert分组,所以抛出异常信息:添加课程名称不能为空。

    如果修改分组为ValidationGroups.Update.class,异常信息为:修改课程名称不能为空。

  • 注意事项

    分组校验只会校验指定字段。例如只添加了@Validated那么就会校验除了name的其他字段;如果添加了分组那么就只会校验name字段。如果需要所有字段都校验,那么需要在添加分组中再添加一个Default.class

4. 校验规则不满足

如果javax.validation.constraints包下的校验规则满足不了需求怎么办?

1、手写校验代码。 2、自定义校验规则注解