依赖引入
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
基本使用
public class UserVO {
@NotNull(message = "age 不能为空")//增加属性表单限制
private Integer age;
}
在controller中使用
//使用@Validated使表单的约束生效
public String add1(@Validated UserVO userVO) {
****
return "OK";
}
分组校验
如果同一个参数,需要在不同场景下应用不同的校验规则,就需要用到分组校验了。列如:新注册用户还没起名字,我们允许name字段为空,但是不允许将名字更新为空字符。
分组校验有三个步骤:
(1)定义一个分组类(或接口)
public interface Update extends Default{
}
(2)在校验注解上添加groups属性指定分组
public class UserVO {
@NotBlank(message = "name 不能为空",groups = Update.class)//指定分组的有效类
private String name;
// 省略其他代码...
}
(3)Controller方法的@Validated注解添加分组类
@PostMapping("update")
public ResultInfo update(@Validated({Update.class}) UserVO userVO) {//加上有效验证的class
return new ResultInfo().success(userVO);
}
[说明] 指@Validated注解指定Update.class时,在name属性上的 @NotBlank注解生效,由于groups指定的是Update.class
自定义的Update分组接口继承了Default接口。校验注解(如:@NotBlank)和@validated默认都属于Default.class分组,这一点在
javax.validation.groups.Default注释中有说明
注意:
[注意点] 在编写Update分组接口时,如果继承了Default,下面两个写法就是等效的:
@Validated({Update.class})
@Validated({Update.class,Default.class})
请求一下/update接口可以看到,不仅校验了name字段,也校验了其他默认属于Default.class分组的字段
注解
空参校验
|
空校验 |
针对类型 |
说明 |
|
@Nullr |
任何类型 |
校验对象必须为空 |
|
@NotNull |
校验对象不为空 |
校验对象不为空,不能校验字符串长度为0的对象 |
|
@NotBlank |
字符串 |
只对字符串有效,校验字符串去掉前后空格后长度不为0 |
|
@NotEmpty |
字符串、集合、数组 |
校验对象不能为空 (字符串长度不为0、集合大小不为0) |
boolean校验
|
boolean校验 |
针对类型 |
说明 |
|
@AssertTrue |
布尔 |
校验boolean类型必须为true |
|
@AssertFalse |
布尔 |
校验boolean类型必须为false |
日期校验
|
日期校验 |
针对类型 |
说明 |
|
@Past |
日期类型 |
校验必须是一个过去的日期 |
|
@Future |
日期类型 |
校验必须是一个将来的日期 |
数值校验
|
数值校验 |
针对类型 |
说明 |
|
@Min |
数字类型 |
校验必须是一个数字,其值必须大于或等于指定的最小值 |
|
@Max |
数字类型 |
校验必须是一个数字,其值必须小于或等于指定的最大值 |
|
@DecimalMin |
数字类型 |
校验必须是一个数字,其值必须大于或等于指定的最小值 |
|
@DecimalMax |
数字类型 |
校验必须是一个数字,其值必须小于或等于指定的最大值 |
|
@Digits(integer=,fraction=) |
数字类型 |
校验必须是一个数字,interger指定整数精度,fraction指定小数精度 |
|
@Range(min =,max = ) |
数字类型、字符串 |
校验对象的值在min和max区间内 |
|
@Length(min =,max = ) |
数字类型 |
校验对象的值的长度在min和max区间内 |
|
@Size(min =,max = ) |
数字类型 |
校验对象的值在min和max区间内,如字符长度、集合大小 |
其他校验
|
其他校验 |
针对类型 |
说明 |
|
|
字符串 |
校验对象的值必须是Email类型,也可以通过regexp和flag指定自定义的email格式 |
|
@Pattern |
字符串 |
校验对象的值必须符合指定的正则表达式 |
|
@CreditCardNumber |
数字类型、字符串 |
校验对象的值必须是信用卡类型 |
|
@URL |
字符串 |
校验对象的值必须是URL地址 |
[注意] @NotNull、@NotEmpty和@NotBlank的区别:正则表达式
@NotNull://CharSequence, Collection, Map 和 Array 对象不能是 null, 但能够是空集(size = 0)。
@NotEmpty://CharSequence, Collection, Map 和 Array 对象不能是 null 而且相关对象的 size 大于 0。
@NotBlank://String 不是 null 且去除两端空白字符后的长度(trimmed length)大于 0。
空检查
@Null 验证对象是否为null
@NotNull 验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty 检查约束元素是否为NULL或者是EMPTY.
Booelan检查
@AssertTrue 验证 Boolean 对象是否为 true
@AssertFalse 验证 Boolean 对象是否为 false
长度检查
@Size(min=, max=) 验证对象(Array,Collection,Map,String)长度是否在给定的范围之内
@Length(min=, max=) Validates that the annotated string is between min and max included.
日期检查
@Past 验证 Date 和 Calendar 对象是否在当前时间之前
@Future 验证 Date 和 Calendar 对象是否在当前时间之后
@Pattern 验证 String 对象是否符合正则表达式的规则
数值检查,提议使用在Stirng,Integer类型,不提议使用在int类型上,由于表单值为“”时无法转换为int,但可以转换为Stirng为"",Integer为null
@Min 验证 Number 和 String 对象是否大等于指定的值
@Max 验证 Number 和 String 对象是否小等于指定的值
@DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表明.小数存在精度
@DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表明.小数存在精度
@Digits 验证 Number 和 String 的构成是否合法
@Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字,interger指定整数精度,fraction指定小数精度。
@Range(min=, max=) Checks whether the annotated value lies between (inclusive) the specified minimum and maximum.
@Range(min=10000,max=50000,message="range.bean.wage")
private BigDecimal wage;
@Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
@CreditCardNumber信用卡验证
@Email 验证是否是邮件地址,如果为null,不进行验证,算通过验证。
@ScriptAssert(lang= ,script=, alias=)
@URL(protocol=,host=, port=,regexp=, flags=)