Spring Validation验证框架对参数的验证机制提供了@Validated(Spring's JSR-303规范,是标准JSR-303的一个变种)
,javax提供了@Valid(标准JSR-303规范)
,配合BindingResult可以直接提供参数验证结果。其中对于字段的特定验证注解比如@NotNull等网上到处都有,这里不详述
在检验Controller的入参是否符合规范时,使用@Validated或者@Valid在基本验证功能上没有太多区别。但是在分组、注解地方、嵌套验证等功能上两个有所不同:
1. 分组
@Validated:提供了一个分组功能,可以在入参验证时,根据不同的分组采用不同的验证机制,这个网上也有资料,不详述。@Valid:作为标准JSR-303规范,还没有吸收分组的功能。
注意:一旦分组就将所有的属性带上分组,否则没有带分组的就不会检测
分组校验
public class ValidationDemo {
private String id;
@Length(min = 2, max = 6, message = "用户名长度要求在{min}-{max}之间")
@NotNull(message = "用户名不可为空")
private String userName;
// 表示分组为Adult时使用该校验规则
@Email(message = "邮箱格式错误")
@NotBlank(message = "邮箱不可为空", groups = {ValidationDemo.Adult.class})
private String email;
@Past(message = "出生日期错误")
private Date birthDay;
@Min(value = 18, message = "年龄错误")
@Max(value = 80, message = "年龄错误")
private Integer age;
@Range(min = 0, max = 1, message = "性别选择错误")
private Integer sex;
// 添加两个分组
public interface Adult {
}
public interface Minor {
}
}
测试一下
// 这里将分组设置为Minor,目的是不校验邮箱字段
@RequestMapping(value = "validation", method = RequestMethod.POST)
public JsonResult validation(@Validated({ValidationDemo.Adult.class}) @RequestBody ValidationDemo demo) {
return null;
}
RequestBody:
{
"age": 0,
"birthDay": "2019-04-14T10:39:08.501Z",
"email": "",
"id": "string",
"sex": 0,
"userName": "string"
}
Response:
{
"code": 1,
"msg": "[\"邮箱不可为空\"]",
"total": 0,
"totalpage": 0
}
RequestBody:
{
"age": 0,
"birthDay": "2019-04-14T10:39:08.501Z",
"email": "",
"id": "string",
"sex": 0,
"userName": "string"
}
Response:
{
"code": 0,
"data": [
{}
],
"extra": "string",
"msg": "string",
"result": {},
"total": 0,
"totalpage": 0
}
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<Prop> 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进行验证,如下所示:
@RestController
public 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<Prop> props;
}
然后我们在ItemController的addItem函数上再使用@Validated或者@Valid,就能对Item的入参进行嵌套验证。此时Item里面的props如果含有Prop的相应字段为空的情况,Spring Validation框架就会检测出来,bindingResult就会记录相应的错误。
总结一下@Validated和@Valid在嵌套验证功能上的区别:
@Validated:用在方法入参上无法单独
提供嵌套验证
功能。不能用在成员属性(字段)
上,也无法提示
框架进行嵌套验证
。能配合
嵌套验证注解@Valid进行嵌套验证。
@Valid:用在方法入参上无法单独提供嵌套验证功能。能够用在成员属性(字段)上,提示验证框架进行嵌套验证。能配合嵌套验证注解@Valid进行嵌套验证。
@Validated对VO的多个参数进行顺序校验
一、目的
使用@Validated对VO进行校验时,对多个参数进行顺序校验。
二、操作方法
/**
* Created by @author shibinbin on 2018/3/3.
* 此处若写的有GroupSequence则代表重写了Default的验证方法,验证顺序按照顺序进行
*/
@Data
public class User{
@NotEmpty(message ="userName不能为空", groups = {UserNameCheck.class})
private StringuserName;
@NotEmpty(message ="password不能为空", groups = {PasswordCheck.class})
private Stringpassword;
}
新建三个校验接口UserNameCheck、PasswordCheck、UserCheckSequence.
UserNameCheck接口
public interface UserNameCheck {
}
PasswordCheck接口
public interface PasswordCheck {
}
UserCheckSequence顺序接口
/**
* Created by @author shibinbin on 2018/3/3.
* 此处的GroupSequence是根据目前的先后顺序进行验证,当存在一个验证不通过的情况则不会验证后一个分组
* 直接返回验证错误信息,验证顺序是PasswordCheck--》UserNameCheck--》Default
*
* 关于Default,此处我springvalidation默认生成的验证接口,验证的范围是所有带有验证信息的属性,
* 若是属性上方写了验证组,则是验证该组内的属性
* 若是验证实体类类上写了GroupSequence({}) 则说明重写了Default验证接口,Default就
* 按照GroupSequence里所写的组信息进行验证
*/
@GroupSequence({PasswordCheck.class, UserNameCheck.class})
public interface UserCheckSequence {
}
在Controller层进行如下设置即可使用顺序验证:
@RestController
public class UserController {
@RequestMapping(value = "/", method = RequestMethod.POST)
public Object login(@RequestBody @Validated({UserCheckSequence.class}) User user){
return "succ";
}
}
自定义校验规则
这里,以优惠券创建为例来演示如何自定义校验规则
首先,优惠券表单如下(仅仅只是演示用):
这里除了自定义了两条校验规则之外,还用到了分组。
为什么要有分组这一说呢?因为,举个例子,添加的时候不需要校验id,而修改的时候id不能为空,有了分组以后,就可以添加的时候校验用组A,修改的时候校验用组B
下面重点看一下@CheckTimeInterval
第一步、定义一个注解叫CheckTimeInterval
第二步、定义Validator去校验它
第三步、验证
校验模式
下面补充一点,关于校验模式
默认会校验完所有属性,然后将错误信息一起返回,但很多时候不需要这样,一个校验失败了,其它就不必校验了
为此,需要这样设置