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

最新推荐文章于 2024-07-28 22:05:48 发布

superJamison

最新推荐文章于 2024-07-28 22:05:48 发布

阅读量255

点赞数

分类专栏：笔记 idea 文章标签： java spring spring boot

本文链接：https://blog.youkuaiyun.com/superJamison/article/details/113083033

版权

笔记同时被 2 个专栏收录

19 篇文章

订阅专栏

idea

11 篇文章

订阅专栏

本文档详细介绍了如何创建一个自定义的Java校验注解@ListValue，以及对应的校验器ListValueConstraintValidator。通过@Constraint注解关联校验器，并在properties文件中设置错误信息。此外，还展示了如何在实际应用中使用此自定义注解进行值校验。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

如何编写自定义的校验注解并生效

1、编写一个自定义的校验注解@ListValue

@ListValue(vals = {0, 1}})

创建一个注解类
在这里插入图片描述

package com.jms.common.valid;

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.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * 自定义的校验注解
 * @author jamison
 * @version 1.0
 * @date 2021/1/24 12:06
 */
@Documented
@Constraint(validatedBy = { ListValueConstraintValidator.class }) //指定校验器
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {

	//com.jms.common.valid.ListValue.message 校验的错误信息(properties文件中定义)
    String message() default "{com.jms.common.valid.ListValue.message}";

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

    Class<? extends Payload>[] payload() default { };
	//定义一个整数类型的数组，默认为空
    int[] vals() default {};
}

创建一个错误信息的properties文件
在这里插入图片描述
在文件中编写错误信息

com.jms.common.valid.ListValue.message = The specified value must be submitted(必须提交指定的值！)

注意：中文的话可能会乱码，暂时还没解决，待解决。

2、编写一个自定义的校验器

在这里插入图片描述
观察Constraint注解类的源码，我们需要一个类继承ConstraintValidator接口

ConstraintValidator接口类，参数1：自定义注解类，参数2：改注解支持的类型在这里插入图片描述
那么接下来我们就编写仿照，编写一个我们自己的校验器

package com.jms.common.valid;

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

/**
 * @author jamison
 * @version 1.0
 * @date 2021/1/24 12:24
 */
 //public class ListValueConstraintValidator implements ConstraintValidator<注解类, 支持的类型>
public class ListValueConstraintValidator 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);
        }
    }

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

3、关联自定义的校验注解和自定义的校验器
最后一步就是要关联注解类和校验器了

//在注解类上加上注解
//@Constraint(validatedBy = { 校验器类名.class })	
@Constraint(validatedBy = { ListValueConstraintValidator.class })

在这里插入图片描述
现在我们的自定义注解就生效了