文章目录
@Valid和@Validated的使用,消灭if,else
1.先把可以帮我们做判断的功能列出来
// 注解的姿势非常多,可供大家的大多数需求
空检查
@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=) 验证注解的元素值长度在min和max区间内
日期检查
@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=) 验证注解的元素值在最小值和最大值之间
@Range(min=10000,max=50000,message="range.bean.wage")
private BigDecimal wage;
@Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
@Validated 主要用于分支校验时引入分组的接口类
@CreditCardNumber信用卡验证
@Email 验证是否是邮件地址,如果为null,不进行验证,算通过验证。
@URL 被约束的元素必须是一个URL
当这些注解都不能满足你的需求的时候,可以考虑 @ScriptAssert 自定义校验方法,后续再补充这部分
2.下面举个栗子(先来个普通嵌套验证)
// 测试接口
@GetMapping(value = "/test")
public void test(@RequestBody @Valid NoodlesDot noodlesDot, BindingResult bindingResult) {
// 我没有自己拦截异常,所以用BindingResult来收集不符合注解要求的异常信息,大家自己有框架已经拦截了也可以不用
if (bindingResult.hasErrors()) {
throw new LyException(400, bindingResult.getFieldError().getDefaultMessage());
}
}
// 接口入参
@Data
public class NoodlesDot{
@NotEmpty(message = "noodlesList can not be null")
@Valid // 这里要加上@Valid才能套娃验证下一层的参数属性
private List<Noodles> noodlesList;
private String name;
}
// noodlesList嵌套的对象
@Data
public class Noodles {
@NotNull(message = "price can not be null") // 这里做个简单的不为空校验
// 价格
private BigDecimal price;
// 加蒜
private String garlic;
// 加聪
private String scallion;
}
先测一个noodlesList为空
再测一个noodlesList不为空,price为空
3.假如一个吃面喜欢加蒜不加葱,一个吃面喜欢加葱不加蒜,那一套方案就不够用了,这时候需要用到@Validated
先定义两个接口
// 吃葱的Jack
public interface Jack {
}
// 吃蒜的Rose
public interface Rose {
}
最后加上自己喜欢的入参校验
@Data
public class Noodles {
@NotNull(message = "price can not be null")
// 价格
private BigDecimal price;
@NotBlank(message = "Rose吃蒜",groups = {Rose.class})
// 加蒜
private String garlic;
@NotBlank(message = "Jack吃聪",groups = Jack.class)
// 加葱
private String scallion;
}
再把测试接口的入参注解修改一哈
// 测试接口,先引入Jack
@GetMapping(value = "/test")
public void test(@RequestBody @Validated(value = {Jack.class})/*修改这里*/ NoodlesDot noodlesDot, BindingResult bindingResult) {
if (bindingResult.hasErrors()) {
throw new LyException(400, bindingResult.getFieldError().getDefaultMessage());
}
}
测试结果
// 再测试Rose
@GetMapping(value = "/test")
public void test(@RequestBody @Validated(value = {Rose.class})/*修改这里*/ NoodlesDot noodlesDot, BindingResult bindingResult) {
if (bindingResult.hasErrors()) {
throw new LyException(400, bindingResult.getFieldError().getDefaultMessage());
}
}
结果:
4.如果遇到只能通过java代码进行参数校验的时候,也有一些简化的方法
// 明天补充