JSR303自定义校验注解

自定义校验注解

场景说明：
使用@Pattern无法满足校验规则，这就需要我们自定义校验注解了

---

---

快速入口

springboot后端数据校验JSR303规范详解-入口
JSR303数据校验之分组校验-入口

---

提示：以下是本篇文章正文内容，下面案例可供参考

一、demo说明

小编的案例是走一个完整流程
@ListValue：自己创建的校验注解(规则：必须是0或者1)

@ListValue(vals={0,1})//自己创建的校验注解(规则：必须是0或者1)
private Integer showStatus;

二、引入依赖

<dependency>
   	 <groupId>javax.validation</groupId>
     <artifactId>validation-api</artifactId>
     <version>2.0.1.Final</version>
</dependency>

三、创建注解

package com.atguigu.common.valid;
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

/**
 * @author suqinyi
 * @Date 2021/4/8
 */
@Documented
@Constraint(validatedBy = {ListValueConstraintValidator.class})//指定自己的校验器（注解-校验器关联起来）
//使用的位置
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)//运行时机
public @interface ListValue {
    //========JSR规范指定必须有这3个===============
    String message() default "{sqy.valid.ListValue.message}";//在配置文件中定义
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
    //=======================

    //自己写规则
    int[] vals() default {};
}

四、创建配置文件，存放mes

ValidationMessages.properties

sqy.valid.ListValue.message=必须提交指定的值

五、自定义校验器

package com.atguigu.common.valid;

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

/**
 * @author suqinyi
 * @Date 2021/4/9
 */
//自定义校验器==》 校验的字段private Integer showStatus;
// ConstraintValidator<ListValue,Integer>  一个是注解，一个是指定泛型
//只能校验Integer类型，如果需要其他类型就继续创建校验器
public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer>{

	//创建Set
    private Set<Integer> set =new HashSet<>();
    //初始化方法
    @Override
    public void initialize(ListValue constraintAnnotation) {
        //详细信息
        int[] vals = constraintAnnotation.vals();
        for (int val : vals) {
            //非空判断没写
            set.add(val);//将0，1存进set中
        }
    }
    //判断是否校验成功
    /**
     * @param integer  需要校验的值
     * @param constraintValidatorContext
     * @return
     */
    @Override
    public boolean isValid(Integer integer, ConstraintValidatorContext constraintValidatorContext) {
        return set.contains(integer);//校验的值在set中返回true
    }
}

六、自定义校验注解完成

七、可以来这边查看校验器的实现，模仿写

---

总结

步骤：

自定义校验
   1）、编写一个自定义的校验注解 ListValue
   2）、编写一个自定义的校验器  ListValueConstraintValidator
   3）、关联自定义的校验器和自定义的校验注解
   @Documented
   @Constraint(validatedBy = {ListValueConstraintValidator.class,【可以使用多个不同的校验器进行校验】)//指定校验器
     //使用的位置
   @Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
   @Retention(RetentionPolicy.RUNTIME)//运行时机
   在ConstraintValidator使用ctrl+h 查看校验器的 实现