JSR(Java规范请求,Java Specification Requests)是Java的一个验证框架,它定义了很多注解来验证Bean 的属性。
spring-boot-starter-web包里面有hibernate-validator包,hibernate-validator实现了JSR的规范。所以如果开发 web 就不需要重复添加 spring-boot-starter-validation 依赖了。但如果没用 web 依赖时候想要实现 Bean 验证,则只要单单加入 spring-boot-starter-validation 依赖即可。
在开发中,我们经常需要对入参进行校验:
上图有4个常用JSR注解, 值得注意的是@NotEmpty 和 @NotBlank的区别
@NotEmpty: 表示sortingId不能为空。即:sortingId != null && sortingId != ‘’ (如果sortingId = ’ ’ , 里面有空格,则会通过校验)
@NotNull: 表示billCode不能为空。即: billCode != null
@NotBlank: 表示deviceCode不能为blank。即:deviceCode != null && deviceCode.trim() !=’’ (如果deviceCode = ’ ’ , 里面有空格,不会通过校验)
@Min(min=0):表示age的最小值是0. 即 age >= 0
@Pattern(regexp = ‘sorting|transferring’):regexp是一个正则表达式,在上述例子表示限制sortMode只能是sorting或者transferring这两种情况
上图只是列出几个常用的注解,还有很多校验注解到可以在javax.validation.constraints包下找到,具体使用哪种注解还需根据实际场景来选择。
打上注解后具体是什么时候去校验的呢?
比如我请求的接口是:
这里讲一个大致的流程。
当发起请求时,请求会先到ApplicationFilterChain的dofilter方法,接着请求会到DispatcherServlet的doDispatch,这这个类里会找到对应的mappedHandler,我们写的Controller就是一个handler,
会根据request对象的url找到对应的handler,也就是我们的controller
可以看到这个handler就是我们的Controller:
紧接着会将请求的body通过RequestResponseBodyMethodProcessor的resolveArgument将请求参数转化成我们的Controller接口的实体类(通常我们将xxVO, xxxDTO)。
接着回到ValidatorImpl类的validateConstraintsForDefaultGroup方法,查到实体类的所有JSR注解。可以在下图看到,我们Controller的请求参数SortingReqDTO;里面包含了5个JSR注解。
后面会针对每个有注解的属性进行校验,然后调用到ConstraintTree类的validateSingleConstraint方法,
里面会根据具体的validator进行校验(不同的校验类都实现了ConstraintValidator接口,这里也是使用了java的多态性质)
可以看到现在校验的是deviceCode这个属性, 这个属性使用了@NotBlank,具体校验是由NotBlanValidator实现。
由于deviceCode传的是571WX- 001,执行下面isValid方法时,会返回true. 即校验通过。 下图也可以看出@NotBlank的检验是 参数.toString().trim().length > 0
至此,这个参数
的校验已经结束了。其余的一些JSR注解,如@Min, @Max, @Pattern 也是类似的流程,只不过是不同的实现类去实现isValid方法。
hibernate-validator相关的JSR实现类可以在 org.hibernate.validator.internal.constraintvalidators.bv 包下找到,平时对于不确定的注解可以去这个包下面的具体实现类去查看。前提是使用的hibernate-validator哦。