- 概述
- 注解位置
- 分组校验
- 组序列
- 嵌套校验
概述
@Valid
是使用Hibernate validation
的时候使用@Validated
是只用Spring Validator
校验机制使用
说明:java的JSR303声明了
@Valid
这类接口,而Hibernate-validator
对其进行了实现
@Validation
对@Valid
进行了二次封装,在使用上并没有区别,但在分组、注解位置、嵌套验证等功能上有所不同,这里主要就这几种情况进行说明。
基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能。
注解位置
@Validated
:用在类型、方法和方法参数上。但不能用于成员属性(field)@Valid
:可以用在方法、构造函数、方法参数和成员属性(field)上
如:
==================》》》》
如果@Validated
注解在成员属性上,则会报不适用于field错误
基于微服务的思想,构建在 B2C 电商场景下的项目实战。核心技术栈,是 Spring Boot + Dubbo 。未来,会重构成 Spring Cloud Alibaba 。
分组校验
@Validated
:提供分组功能,可以在参数验证时,根据不同的分组采用不同的验证机制@Valid
:没有分组功能
举例:
定义分组接口:
public interface IGroupA { } public interface IGroupB { }
定义需要检验的参数bean:
public class StudentBean implements Serializable{ @NotBlank(message = "用户名不能为空") private String name; //只在分组为IGroupB的情况下进行验证 @Min(value = 18, message = "年龄不能小于18岁", groups = {IGroupB.class}) private Integer age; @Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\\d{8}$", message = "手机号格式错误") private String phoneNum; @Email(message = "邮箱格式错误") private String email; @MyConstraint private String className;
测试代码:
检验分组为IGroupA的情况
@RestController public class CheckController { @PostMapping("stu") public String addStu(@Validated({IGroupA.class}) @RequestBody StudentBean studentBean){ return "add student success"; } }
测试:
这里对分组IGroupB的就没检验了
如果把测试代码改成下面这样,看看测试结果
@RestController public class CheckController { @PostMapping("stu") public String addStu(@Validated({IGroupA.class, IGroupB.class}) @RequestBody StudentBean studentBean){ return "add student success"; } }
说明:
1、不分 配groups,默认每次都要进行验证
2、对一个参数需要多种验证方式时,也可通过分配不同的组达到目的。
组序列
默认情况下 不同级别的约束验证是无序的,但是在一些情况下,顺序验证却是很重要。
一个组可以定义为其他组的序列,使用它进行验证的时候必须符合该序列规定的顺序。在使用组序列验证的时候,如果序列前边的组验证失败,则后面的组将不再给予验证。
举例:
定义组序列:
@GroupSequence({Default.class, IGroupA.class, IGroupB.class}) public interface IGroup { }
需要校验的Bean,分别定义IGroupA对age进行校验,IGroupB对className进行校验:
public class StudentBean implements Serializable{ @NotBlank(message = "用户名不能为空") private String name; @Min(value = 18, message = "年龄不能小于18岁", groups = IGroupA.class) private Integer age; @Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\\d{8}$", message = "手机号格式错误") private String phoneNum; @Email(message = "邮箱格式错误") private String email; @MyConstraint(groups = IGroupB.class) private String className;
测试代码:
@RestController public class CheckController { @PostMapping("stu") public String addStu(@Validated({IGroup.class}) @RequestBody StudentBean studentBean){ return "add student success"; } }
测试发现,如果age出错,那么对组序列在IGroupA后的IGroupB不进行校验,即例子中的className不进行校验,结果如下:
嵌套校验
一个待验证的pojo类,其中还包含了待验证的对象,需要在待验证对象上注解@Valid
,才能验证待验证对象中的成员属性,这里不能使用@Validated
。
举例:
需要约束校验的bean:
public class TeacherBean { @NotEmpty(message = "老师姓名不能为空") private String teacherName; @Min(value = 1, message = "学科类型从1开始计算") private int type; public class StudentBean implements Serializable{ @NotBlank(message = "用户名不能为空") private String name; @Min(value = 18, message = "年龄不能小于18岁") private Integer age; @Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\\d{8}$", message = "手机号格式错误") private String phoneNum; @Email(message = "邮箱格式错误") private String email; @MyConstraint private String className; @NotNull(message = "任课老师不能为空") @Size(min = 1, message = "至少有一个老师") private List<TeacherBean> teacherBeans;
注意:
这里对teacherBeans
只校验了NotNull
, 和 Size,并没有对teacher信息里面的字段进行校验,具体测试如下:
这里teacher中的type明显是不符合约束要求的,但是能检测通过,是因为在student中并没有做 嵌套校验
可以在teacherBeans
中加上 @Valid
,具体如下:
@Valid @NotNull(message = "任课老师不能为空") @Size(min = 1, message = "至少有一个老师") private List<TeacherBean> teacherBeans;
这里再来测试,会发现如下结果: