Hibernate Validator 框架可以很优雅的方式实现参数的校验,让业务代码 和 校验逻辑 分开,不再编写重复的校验逻辑;
Hibernate Validator 是 Bean Validation 的参考实现 . Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现;
作用:
验证逻辑与业务逻辑之间进行了分离,降低了程序耦合度;
统一且规范的验证方式,降低代码重复率;
依赖jar
<!-- hibernate validator-->
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.1.6.Final</version>
</dependency>
<!--jsr 303-->
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>2.0.1.Final</version>
</dependency>
hibernate-validator常用注解:
@AssertFalse 验证注解的元素值是 false
@AssertTrue 验证注解的元素值是 true
@DecimalMax(value=x) 验证注解的元素值小于等于指定的十进制value 值
@DecimalMin(value=x) 验证注解的元素值大于等于指定的十进制value 值
@Digits(integer=整数位数, fraction=小数位数)验证注解的元素值的整数位数和小数位数上限
@Future 验证注解的元素值(日期类型)比当前时间晚
@Max(value=x) 验证注解的元素值小于等于指定的 value值
@Min(value=x) 验证注解的元素值大于等于指定的 value值
@NotNull 验证注解的元素值不是 null
@Null 验证注解的元素值是 null
@Past 验证注解的元素值(日期类型)比当前时间早
@Pattern(regex=正则表达式) 验证注解的元素值不指定的正则表达式匹配
@Size(min=最小值, max=最大值) 验证注解的元素值的在 min 和 max (包含)指定区间之内,如字符长度、集合大小
@Valid 该注解主要用于字段为一个包含其他对象的集合或map或数组的字段,或该字段直接为一个其他对象的引用,这样在检查当前对象的同时也会检查该字段所引用的对象。
@NotEmpty 验证注解的元素值不为 null 且不为空(字符串长度不为 0、集合大小不为 0)
@Range(min=最小值, max=最大值)验证注解的元素值在最小值和最大值之间
@NotBlank 验证注解的元素值不为空(不为 null、去
除首位空格后长度为 0),不同于@NotEmpty, @NotBlank 只应用于字符串且在比较时会去除字符串的空格
@Length(min=下限, max=上限) 验证注解的元素值长度在 min 和 max 区间内
@Email 验证注解的元素值是 Email,也可以通过正则表达式和 flag 指定自定义的 email 格式
hibernate validate分组校验
自定义分组接口,用于区分不同业务操作时的参数校验
public class ValidatedGroup {
//新增组
public interface AddGroup{};
//更新组
public interface UpdateGroup{};
}
实体代码使用注解如下:
@Data
public class Person {
//在更新时校验id是否为空
@NotBlank(message = "不能为空", groups = {ValidatedGroup.UpdateGroup.class})
private String id;
//默认校验的分组为validator框架的Default分组接口 javax.validation.groups.Default
@NotBlank(message = "名字不能为空")
private String name;
//在新增或更新时进行校验
@NotBlank(message = "年龄不能为空",groups= {ValidatedGroup.AddGroup.class, ValidatedGroup.UpdateGroup.class})
private Integer age;
//在新增进行校验
@NotBlank(message = "性别不能为空", groups = {ValidatedGroup.AddGroup.class})
private String sex;
}
public class PersonController {
//注意声明Default.class ,不声明则实体类的name不进行校验
public void addPerson( @Validated({Default.class, ValidatedGroup.AddGroup.class} Person person){
}
public void updatePerson( @Validated({Default.class, ValidatedGroup.AddGroup.class}Person person){
}
}
统一异常处理:
@ExceptionHandler(MethodArgumentNotValidException.class)
public Result<?> methodArgumentNotValidException(MethodArgumentNotValidException e) {
log.error(e.getMessage(), e);
List<Map<String, Object>> list = new ArrayList<>();
List<FieldError> errorList = e.getBindingResult().getFieldErrors();
errorList.forEach(fieldError -> {
Map<String, Object> map = new HashMap<>();
map.put(fieldError.getField(), fieldError.getDefaultMessage());
list.add(map);
});
return Result.error(6001, "参数异常", list);
}
@ExceptionHandler(ValidationException.class)
public Result<?> validationException(ValidationException e) {
log.error(e.getMessage(), e);
return Result.error(6002, "参数异常");
}