自定义数据校验的注解

自定义数据校验注解的步骤

编写一个自定义的校验注解

校验注解必须拥有以下3个属性：

    // 校验出错时，默认信息从哪里取
	String message() default "{javax.validation.constraints.NotBlank.message}";
	
	// 校验分组
	Class<?>[] groups() default { };
	
	// 自定义校验负载信息
	Class<? extends Payload>[] payload() default { };

校验注解必须标识一些元数据信息的注解：

@Documented 
@Constraint(validatedBy = { }) // 此处来指定自定义注解用哪个校验器处理
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE }) // 表示自定义的注解可以标注在哪里（比如：方法属性等等，根据具体情况来指定）
@Retention(RUNTIME) // 表示自定义注解在何时可以获取到（比如：RUNTIME表示运行时获取）

校验注解的message默认查找的配置文件：

此步可以省略，直接在自定义注解的message中指定具体提示信息即可，如果不指定可以使用如下的默认提示信息，
在classpath/resources创建文件ValidationMessages.properties

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

其中com.atguigu.common.valid.ListValue.message来自于如下{}中的值(可自定义)。

public @interface ListValue {
	String message() default "{com.atguigu.common.valid.ListValue.message}";
....
}

自定义校验注解案例，如下：

/**
 * @Auther: lijinzhong
 * @Date: 2022/12/9
 * @Description:  自定义校验注解
 * @version: 1.0
 *  需要引入以下依赖
 *  <dependency>
        <groupId>javax.validation</groupId>
        <artifactId>validation-api</artifactId>
        <version>2.0.1.Final</version>
    </dependency>
 */

@Documented
@Constraint(validatedBy = { })
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {
    String message() default "{com.atguigu.common.valid.ListValue.message}";

    Class<?>[] groups() default { };

    Class<? extends Payload>[] payload() default { };

    int [] vals() default { };
}

编写一个自定义的校验器

/**
 * @Auther: lijinzhong
 * @Date: 2022/12/9
 * @Description:   自定义注解校验器 ，必须实现接口,该接口两个泛型分别表示：自定义注解类型、标注在Integer类型的字段上进行校验
 * @version: 1.0
 */
public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {

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

    //初始化方法
    @Override
    public void initialize(ListValue constraintAnnotation) {
        int[] vals = constraintAnnotation.vals();//获取自定义注解@ListValue上标注的值，如：@ListValue(vals={0,1})
        for (int val:vals){
            set.add(val);
        }
    }

    /**
     * 判断校验是否成功
     * @param value  需要校验的值
     * @param context
     * @return
     */
    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext context) {
        return set.contains(value);
    }
}

关联自定义的校验器和自定义的校验注解

@Documented
@Constraint(validatedBy = { ListValueConstraintValidator.class}) // 关联自定义注解校验器
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {
    String message() default "{com.atguigu.common.valid.ListValue.message}";

    Class<?>[] groups() default { };

    Class<? extends Payload>[] payload() default { };

    int [] vals() default { };
}

在需要校验的字段上标注自定义注解

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

完毕！