一、背景
在基于SpringBoot编写RESTful接口时,常常需要对接口的入参格式或数据范围进行参数校验,通过常规的if/else检查会使代码变得非常臃肿,那么可以使用@Valid+BindingResult进行controller层接口参数校验。
二、实体属性上的校验规则
1、空检查
@NotEmpty:用在集合类上面;不能为null,而且长度必须大于0
@NotBlank: 用在String上面;只能作用在String上,不能为null,而且调用trim()后,长度必须大于0
@NotNull:用在基本类型上;不能为null,但可以为empty。
@Null: 只能是null
2、长度检查
@Size(min=,max=):验证对象(Array,Collection,Map,String)长度是否在给定的范围之内
注意:不要错用了异常类型,比如在int上不可用@size
@Length(min=, max=) : 只适用于String 类型
3、Booelan检查
@AssertTrue: 验证 Boolean 对象是否为 true
@AssertFalse: 验证 Boolean 对象是否为 false
4、字符串检查
@Pattern(regexp="reg") : 验证字符串满足正则
@Size(max, min): 验证字符串、数组、集合长度范围
@NotEmpty: 验证字符串不为空或者null
@NotBlank: 验证字符串不为null或者trim()后不为空
4、日期检查
@Past: 验证 Date 和 Calendar 对象是否在当前时间之前
@Future: 验证 Date 和 Calendar 对象是否在当前时间之后
@Pattern: 验证 String 对象是否符合正则表达式的规则
5、数值检查
建议使用在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=long1,max=long2): 检查数字是否在范围之间
6、其他检查
@Email: 用于验证一个字符串是否是一个合法的右键地址,空字符串或null算验证通过
@URL(protocol=,host=,port=,regexp=,flags=) : 用于校验一个字符串是否是合法UR
三、@Valid+BindingResult进行controller参数校验
@Valid 和 BindingResult 是一一对应的,如果有多个@Valid,那么每个@Valid后面跟着的BindingResult就是这个@Valid的验证结果,顺序不能乱。
1、创建一个参数对象
@Data
public class Parameter {
@NotEmpty(message="姓名不能为空")
private String name;
@Min(value = 18, message = "年龄必须大于18岁")
private int age;
@NotEmpty(message="hobbies不能为空")
private List<String> hobbies;
@NotBlank(message="账号不能为空")
private String account;
@Size(min=5,max=10,message="密码的长度应该在5和10之间")
private String password;
@Email(message="邮箱格式错误")
private String email;
}
2、controller控制层的参数校验
controller控制层写参数接收的入口,需要注意的是@Valid 和 BindingResult 是一 一对应的,如果有多个@Valid,那么每个@Valid后面都需要添加BindingResult用于接收bean中的校验信息。
@RequestMapping(value = "/test", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_VALUE)
public Result<Boolean> test( @Validated @RequestBody Parameter param , BindingResult bindingResult ){
if ( bindingResult.hasErrors() ){
return Result.failed( bindingResult.getFieldError().getDefaultMessage() );
} else{
return Result.success("Ok,Success!");
}
}