在某些特殊的业务中,现有的校验法则可能会满足不了需求,例如我期望有一个注解校验前端传过来的参数是1或者0的其中一个,若是传其他的则会校验失败,这时候就需要自己自定义校验规则,下面是JSR303的自定义校验规则
以下方法是根据自己来看,不知道是不是有其他更好的记忆方法
一、新建一个注解类
二、代码实现
选择类似的一个注解点进去,取出其中较为重要的部分复制进新创的注解类
结果如下
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
@Documented
@Constraint(validatedBy = {ValueConstraintValidator.class })//指定校验器
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
@Retention(RUNTIME)
public @interface ListValue {
String message() default "{javax.validation.constraints.NotBlank.message}";//获取校验信息
Class<?>[] groups() default { };//设置校验分组
Class<? extends Payload>[] payload() default { };//负载信息
//设置标志数值,例如要校验的数值只能是0或者1,这里就用于存储0和1,也就是我们注解的vals值
int[] vals ()default{};
}
创建校验器:
红框标志的.class文件时需要我们手动创建的,我们先通过点击上图红框中的Constraint方法进入源码查看怎么定义的
这时候时需要继承一个 ConstraintValidator,我们在进入其中看看如何定义
这里是有两个方法的,一个是初始化方法,一个是校验方法 ,这时候我们就依照这个,创建一个类作为校验器引入
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.HashSet;
import java.util.Set;
//第一个参数ListValue是我们创建的注解类,第二个参数Integer是我们接收到的参数的类型
public class ValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {
private Set<Integer> set = new HashSet<Integer>();
//初始化方法
public void initialize(ListValue constraintAnnotation) {
int[] vals = constraintAnnotation.vals();
for (int val : vals) {
set.add(val); //将所有的注解上设置的校验数组存储到set集合中
}
}
/**
@param value 需要校验的值(前端获取的值)
@param context 上下文环境信息
*/
//判断是否校验成功
public boolean isValid(Integer value, ConstraintValidatorContext context) {
//当接我们设置注解的校验整数数组中含有传递过来的参数,则校验通过,否则不通过
return set.contains(value);
}
}
实体类中注解使用
/**
* 显示状态[0-不显示;1-显示]
*/
@NotNull(groups = {AddGroup.class, UpdateStatusGroup.class})
@ListValue(vals = {0,1}, groups = {AddGroup.class, UpdateGroup.class, UpdateStatusGroup.class})
private Integer showStatus;