一、JSR303规范中提供了@Valid校验注解
1).给bean添加校验注解javax.validation.constraints
, 并定义自己的message提示
2)开启校验功能:@Valid
效果: 校验错误以后会有默认的响应;
3)给校验的bean后紧跟一个BindingResult
,就可以获取到校验的结果
public R save(@Valid @RequestBody BrandEntity brand, BindingResult bindingResult){
if(bindingResult.hasErrors()){
Map<String,String> map = new HashMap<>();
bindingResult.getFieldErrors().forEach((item)->{
//fieldError获取到错误提示
String message = item.getDefaultMessage();
String field = item.getField();
map.put(field,message);
});
return R.error(400,"提交的数据不合法").put("data",map);
}else{
brandService.save(brand);
}
return R.ok();
}
注:如果校验没有生效,可以引入以下依赖:
<!-- 好多人说只引入第二个就可以,我两个都引入了,没有报错,而且必须加version -->
<!-- validation -->
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>2.0.1.Final</version>
</dependency>
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.1.0.Final</version>
</dependency>
注解 说明
@NotNull 限制必须不为null
@NotEmpty 验证注解的元素值不为 null 且不为空(字符串长度不为0、集合大小不为0)
@NotBlank 验证注解的元素值不为空(不为null、去除首位空格后长度为0),不同于@NotEmpty,@NotBlank只应用于字符串且在比较时会去除字符串的空格
@Pattern(value) 限制必须符合指定的正则表达式
@Size(max,min) 限制字符长度必须在 min 到 max 之间(也可以用在集合上)
@Email 验证注解的元素值是Email,也可以通过正则表达式和flag指定自定义的email格式
@Max(value) 限制必须为一个不大于指定值的数字
@Min(value) 限制必须为一个不小于指定值的数字
@DecimalMax(value) 限制必须为一个不大于指定值的数字
@DecimalMin(value) 限制必须为一个不小于指定值的数字
@Null 限制只能为null(很少用)
@AssertFalse 限制必须为false (很少用)
@AssertTrue 限制必须为true (很少用)
@Past 限制必须是一个过去的日期
@Future 限制必须是一个将来的日期
@Digits(integer,fraction) 限制必须为一个小数,且整数部分的位数不能超过 integer,小数部分的位数不能超过 fraction (很少用)
二、springboot提供了@Validated分组校验注解
分组校验:可以完成多场景的复杂校验。
1)通过groups属性给校验注解上标注什么情况下需要校验
2)在controller中添加@Validated
注解
注: 没有标注分组校验的注解默认是不起作用的,想要下面的@URL
校验起作用,就必须要指定分组
校验注解在没有指定分组的情况下,只有在·@Validated`注解没有指定分组的情况下才生效(此时那些指定了分组的校验注解不会生效)。
三、自定义校验注解
自定义校验注解分三步:
step1:编写一个自定义的校验注解
step2:编写一个自定义的校验器
step3:关联自定义的校验器和校验注解
举例:想定义一个注解,校验字段的值只能是0或1,如下:
第一步:创建一个ListValue
注解
注解内容该如何编写,可以参考api规范中提供的注解;
①在JSR303规范中,注解里必须有3个属性
②自定义注解还必须包含源信息数据
③指定自定义注解中vals
属性
前三步做完,校验注解就有了,怎么校验呢?校验注解上有个Constraint
注解,它的ValidatedBy
属性可以指定用什么方式校验;
点击查看ValidatedBy
属性得知,它的值需要是一个数组格式,类型是【Class】ConstraintValidator
【需要继承ConstraintValidator】,
④创建一个校验器
⑤编写校验逻辑
⑥给校验注解指定校验器