自定义校验注解

最新推荐文章于 2023-08-29 17:55:50 发布

祁坤宇

最新推荐文章于 2023-08-29 17:55:50 发布

阅读量199

点赞数

分类专栏：工具类

本文链接：https://blog.csdn.net/qq_33550151/article/details/119007241

版权

工具类专栏收录该内容

7 篇文章 0 订阅

订阅专栏

这篇博客介绍了如何创建一个自定义的注解`@EnumValid`，用于校验枚举类型的字段。注解使用了`javax.validation`接口，通过`ConstraintValidator`实现校验逻辑。在`EnumValidator`类中，检查指定枚举类是否存在给定的值，实现了对空值的处理。这个注解可以提高代码的可维护性和数据校验的准确性。

摘要由CSDN通过智能技术生成

注解：

import com.yuelvhui.utils.EnumValidator;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = {EnumValidator.class})
public @interface EnumValid {

    String message() default "";

    // 作用参考@Validated和@Valid的区别
    Class<?>[] groups() default {};

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

    /**
     * 目标枚举类
     */
    Class<?> target() default Class.class;

    /**
     * 是否忽略空值
     */
    boolean ignoreEmpty() default true;
}

校验拦截

import com.yuelvhui.interfaces.EnumValid;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class EnumValidator implements ConstraintValidator<EnumValid, Integer> {

    // 枚举校验注解
    private EnumValid annotation;

    @Override
    public void initialize(EnumValid constraintAnnotation) {
        annotation = constraintAnnotation;
    }

    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext constraintValidatorContext) {
        boolean result = false;

        Class<?> cls = annotation.target();
        boolean ignoreEmpty = annotation.ignoreEmpty();

        // target为枚举，并且value有值，或者不忽视空值，才进行校验
        if (cls.isEnum() && (value != null || !ignoreEmpty)) {

            Object[] objects = cls.getEnumConstants();
            for (Object obj : objects) {
                // 使用此注解的枚举类需要重写toString方法，改为需要验证的值
                if (obj.toString().equals(String.valueOf(value))) {
                    result = true;
                    break;
                }
            }
        } else {
            result = true;
        }
        return result;
    }
}