目录


1 、 参数校验简介 2、 Validation介绍 Hibernate Validator与 Spring Validator 3、 应用示例  4、 补充

0 1PART 参数校验简介

开发过程中,后台的参数校验是必不可少的,所以经常会看到类似下面这样的代码



springboot 校验接口入参时间格式_requestmapping里面的参数

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02

这样写并没有什么错,还挺工整的,只是看起来不是很优雅而已。

接下来,用Validation来改写这段

02

PART Validation介绍

在Spring Boot的官网中,关于Validation只是简单的提了一句,如下



springboot 校验接口入参时间格式_requestmapping里面的参数_03

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02

其实,Spring Validator和Hibernate Validator是两套Validator,可以混着用,这里我们用Hibernate Validator

应用示例

1、引入spring-boot-starter-validation



springboot 校验接口入参时间格式_list @size 验证_05

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02

2、定义一个对象



springboot 校验接口入参时间格式_list @size 验证_07

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02

3、适用@Valid校验,并将校验结果放到BindingResult对象中



springboot 校验接口入参时间格式_layer.open传参数到子页面_09

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02

注意: 

  • 默认情况下,如果校验失败会抛javax.validation.ConstraintViolationException异常,可以用统一异常处理去对这些异常做处理 
  • An Errors/BindingResult argument is expected to be declared immediately after the model attribute

4、看效果


springboot 校验接口入参时间格式_list @size 验证_11

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02

如果在校验的对象后面再加上Model对象的话,如果返回的是ModelAndView就可以将这个Model设置到其中,这样在页面就可以取到错误消息了



springboot 校验接口入参时间格式_requestmapping里面的参数_13

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02

仅仅只是单字段校验的话未免也太不灵活了吧,如果字段之间有关联关系,那该如何校验呢?答案是自定义



5、自定义校验规则


文档: https://docs.jboss.org/hibernate/stable/validator/reference/en-US/html_single/#validator-customconstraints

springboot 校验接口入参时间格式_layer.open传参数到子页面_15

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02

这里,以优惠券创建为例来演示如何自定义校验规则 

首先,优惠券表单如下(仅仅只是演示用):


springboot 校验接口入参时间格式_requestmapping里面的参数_17

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02


这里除了自定义了两条校验规则之外,还用到了分组。 为什么要有分组这一说呢? 因为,举个例子,添加的时候不需要校验id,而修改的时候id不能为空,有了分组以后,就可以添加的时候校验用组A,修改的时候校验用组B 下面重点看一下@CheckTimeInterval 第一步、定义一个注解叫CheckTimeInterval


springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_19

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02

第二步、定义Validator去校验它



springboot 校验接口入参时间格式_list @size 验证_21

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02

顺便提一句,这里BeanWrapper去取对象的属性值,我们稍微看一下BeanWrapper是做什么的


springboot 校验接口入参时间格式_layer.open传参数到子页面_23

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02

springboot 校验接口入参时间格式_layer.open传参数到子页面_25

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02

第三步、验证


springboot 校验接口入参时间格式_requestmapping里面的参数_27

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02

springboot 校验接口入参时间格式_requestmapping里面的参数_29

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02

springboot 校验接口入参时间格式_requestmapping里面的参数_31

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02

自定义的校验已经生效了04PART补充


1、校验模式


文档:

https://docs.jboss.org/hibernate/stable/validator/reference/en-US/html_single/#section-fail-fast 下面补充一点,关于校验模式 默认会校验完所有属性,然后将错误信息一起返回,但很多时候不需要这样,一个校验失败了,其它就不必校验了 为此,需要这样设置

springboot 校验接口入参时间格式_requestmapping里面的参数_33

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02

2、单个参数校验


springboot 校验接口入参时间格式_requestmapping里面的参数_35

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02

springboot 校验接口入参时间格式_list @size 验证_37

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02

springboot 校验接口入参时间格式_list @size 验证_39

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02

如果是调整页面的时候参数校验失败的话,这时可以不做处理,让其调到错误页面。

如果是接口参数校验失败的话,可以在这里进行统一处理,并返回。例如:


springboot 校验接口入参时间格式_layer.open传参数到子页面_41

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02

3、错误页面


springboot 校验接口入参时间格式_requestmapping里面的参数_43

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02

springboot 校验接口入参时间格式_requestmapping里面的参数_45

springboot 校验接口入参时间格式_jpa自定义sql参数为空的传递_02


以刚才优惠券详情为例 http://localhost:8080/coupon/detail.html      400 http://localhost:8080/coupon/detail.html?id=    400 http://localhost:8080/coupon/detail.html?id=abc   400 http://localhost:8080/coupon/detail222.html?id=123  404 无权限  403 int a = 1 / 0;  500 4、@Valid与@Validated

Spring Validation验证框架对参数的验证机制提供了@Validated(Spring's JSR-303规范,是标准JSR-303的一个变种),javax提供了@Valid(标准JSR-303规范),配合BindingResult可以直接提供参数验证结果。其中对于字段的特定验证注解比如@NotNull等网上到处都有,这里不详述 在检验Controller的入参是否符合规范时,使用@Validated或者@Valid在基本验证功能上没有太多区别。但是在分组、注解地方、嵌套验证等功能上两个有所不同: 1. 分组

@Validated:

提供了一个分组功能,可以在入参验证时,根据不同的分组采用不同的验证机制,这个网上也有资料,不详述。 @Valid:

作为标准JSR-303规范,还没有吸收分组的功能。 2. 注解地方

@Validated:

可以用在类型、方法和方法参数上。但是不能用在成员属性(字段)上。 @Valid:

可以用在方法、构造函数、方法参数和成员属性(字段)上两者是否能用于成员属性(字段)上直接影响能否提供嵌套验证的功能。 3. 嵌套验证

在比较两者嵌套验证时,先说明下什么叫做嵌套验证。比如我们现在有个实体叫做Item:

public class Item {    @NotNull(message = "id不能为空")    @Min(value = 1, message = "id必须为正整数")    private Long id;    @NotNull(message = "props不能为空")    @Size(min = 1, message = "至少要有一个属性")    private List props;}

Item带有很多属性,属性里面有属性id,属性值id,属性名和属性值,如下所示:

public class Prop {    @NotNull(message = "pid不能为空")    @Min(value = 1, message = "pid必须为正整数")    private Long pid;    @NotNull(message = "vid不能为空")    @Min(value = 1, message = "vid必须为正整数")    private Long vid;    @NotBlank(message = "pidName不能为空")    private String pidName;    @NotBlank(message = "vidName不能为空")    private String vidName;}

属性这个实体也有自己的验证机制,比如属性和属性值id不能为空,属性名和属性值不能为空等。


现在我们有个ItemController接受一个Item的入参,想要对Item进行验证,如下所示:

@RestControllerpublic class ItemController {    @RequestMapping("/item/add")    public void addItem(@Validated Item item, BindingResult bindingResult) {        doSomething();    }}


在上代码中,如果Item实体的props属性不额外加注释,只有@NotNull和@Size,无论入参采用@Validated还是@Valid验证,Spring Validation框架只会对Item的id和props做非空和数量验证,不会对props字段里的Prop实体进行字段验证,也就是 @Validated和@Valid加在方法参数前,都不会自动对参数进行嵌套验证。 也就是说如果传的List中有Prop的pid为空或者是负数,入参验证不会检测出来。 为了能够进行嵌套验证,必须手动在Item实体的props字段上明确指出这个字段里面的实体也要进行验证。 由于@Validated不能用在成员属性(字段)上,但是@Valid能加在成员属性(字段)上,而且@Valid类注解上也说明了它支持嵌套验证功能,那么我们能够推断出: @Valid加在方法参数时并不能够自动进行嵌套验证,而是用在需要嵌套验证类的相应字段上,来配合方法参数上@Validated或@Valid来进行嵌套验证。 我们修改Item类如下所示:

public class Item {    @NotNull(message = "id不能为空")    @Min(value = 1, message = "id必须为正整数")    private Long id;    @Valid // 嵌套验证必须用@Valid    @NotNull(message = "props不能为空")    @Size(min = 1, message = "props至少要有一个自定义属性")    private List props;}


然后我们在ItemController的addItem函数上再使用@Validated或者@Valid,就能对Item的入参进行嵌套验证。此时Item里面的props如果含有Prop的相应字段为空的情况,Spring Validation框架就会检测出来,bindingResult就会记录相应的错误。 总结一下@Validated和@Valid在嵌套验证功能上的区别:


  • @Validated:用在方法入参上无法单独提供嵌套验证功能。不能用在成员属性(字段)上,也无法提示框架进行嵌套验证。能配合嵌套验证注解@Valid进行嵌套验证。
  • @Valid:用在方法入参上无法单独提供嵌套验证功能。能够用在成员属性(字段)上,提示验证框架进行嵌套验证。能配合嵌套验证注解@Valid进行嵌套验证。

springboot 校验接口入参时间格式_list @size 验证_47