JSR303常用的验证注解
hibernate扩展的验证注解
导入依赖
<!--hibernate的校验注解-->
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.19.Final</version>
</dependency>
JSR303基本验证效应
1、给实体类字段标注,JSR303规范注解,并自定义错误信息
2、在controller方法的参数列表中,添加@Valid注解,开启JSR303验证
3、捕获验证失败异常,并自定义返回的错误信息
分组效应
1、给实体类字段标注,JSR303规范注解,并自定义错误信息
2、在controller方法的参数列表中,添加@Validated注解,开启JSR303验证,并指定按照什么分组进行验证
注意:
自定义效应
1、编写一个自定义的校验注解
@Documented
@Constraint(validatedBy = { ListValueConstraintValidator.class }) // 使用ListValueConstraintValidator效应器
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE }) // 表示此注解可以,作用的对象
@Retention(RUNTIME)
// 自定义效应注解
public @interface ListValue {
// 定义效应失败的默认消息,从ValidationMessages.properties文件中
// 读取com.atguigu.common.valid.ListValue.message属性值,作为默认的效应消息
String message() default "{com.atguigu.common.valid.ListValue.message}";
// 分组效应
Class<?>[] groups() default { };
Class<? extends Payload>[] payload() default { };
// 表示正确的值是一个数组,可以指定多个正确的值
int[] vals() default { };
}
2、编写一个自定义的校验器ConstraintValidator
/**
* 自定义JSR303效应器
需要继承ConstraintValidator<自定义的注解,效应值的类型>
*/
public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {
private Set<Integer> set = new HashSet<>();
/**
* 初始化方法
* @param constraintAnnotation 效应注解,代表用户规定的值(正确的值)
*/
@Override
public void initialize(ListValue constraintAnnotation) {
int[] vals = constraintAnnotation.vals();
for (int val : vals) {
set.add(val);
}
}
/**
*判断是否校验成功
* @param value 需要校验的值
* @return 效应成功返回true
*/
@Override
public boolean isValid(Integer value, ConstraintValidatorContext context) {
// 判断set集合中是否包含了,效应的值,包含则返回true,否则返回false
return set.contains(value);
}
}
3、创建ValidationMessages.properties文件
com.atguigu.common.valid.ListValue.message=必须为指定的值
4、使用自定义JSR303注解,并指定正确的值,当验证失败时,返回的错误信息则是“必须为指定的值”