Java 自定义校验注解

导入Maven 依赖

  <dependency>
       <groupId>javax.validation</groupId>
       <artifactId>validation-api</artifactId>
  </dependency>

编写一个自定义校验注解

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.RetentionPolicy.RUNTIME;

@Documented
// 指定校验器 不指定表示再初始化的时候指定
@Constraint(validatedBy = {ListValueConstraintValidator.class})
// Target 表示可以标注的位置
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
// 校验注解的时机 RUNTIME 表示可以在运行时
@Retention(RUNTIME)
public @interface ListValue {

    // 指定校验出错后 出错消息在哪里找
    String message() default "{com.my.common.valid.ListValue.message}";

    // 支持分组校验的功能
    Class<?>[] groups() default { };

    // 自定义校验注解的负载信息
    Class<? extends Payload>[] payload() default { };

    // 指定 自定义value 默认是没有值
    int[] value() default {};
}

添加message提示的配置文件

ValidationMessage.properties

com.my.common.valid.ListValue.message=必须提交指定的值

编写一个自定义的校验器

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.HashSet;
import java.util.Set;

/**
 * 自定义 校验器
 * 指定实现接口 ConstraintValidator
 * 添加泛型 第一个泛型 是校验注解
 *        第二个泛型 是注解标注的参数类型
 */
public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer>{

    private Set<Integer> set = new HashSet<>();

    // 初始化方法 会将注解种指定的值 以及详细信息获取
    @Override
    public void initialize(ListValue constraintAnnotation) {
        int[] values = constraintAnnotation.value();
        for (int value : values) {
           if(set.size() > 0) {
               set.add(value);
           }
        }
    }

    /**
     * 判断是否校验成功
     * @param value 校验注解提交的值
     * @param context 上下文环境信息
     * @return 返回当前set中是否包含value的值
     */
    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext context) {
        return set.contains(value);
    }
}

使用自定义注解

    /**
     * 显示状态[0-不显示；1-显示]
     */
    @ListValue(value={0,1},groups = {AddGroup.class})
    private Integer showStatus;