!607 add 新增 validation支持枚举校验 Merge pull request !607 from 秋辞未寒/dev

疯狂的狮子Li

2024-12-10 b1badca062e9f3d22398299247cca8ff191414da

!607 add 新增 validation支持枚举校验
Merge pull request !607 from 秋辞未寒/dev

 ruoyi-common/ruoyi-common-core/src/main/java/org/dromara/common/core/validate/enumd/EnumPattern.java

¶Ô±ÈÐÂÎļþ
@@ -0,0 +1,48 @@
package org.dromara.common.core.validate.enumd;



import jakarta.validation.Constraint;

import jakarta.validation.Payload;



import java.lang.annotation.*;



import static java.lang.annotation.ElementType.*;

import static java.lang.annotation.RetentionPolicy.RUNTIME;



/**

 * è‡ªå®šä¹‰æžšä¸¾æ ¡éªŒ

 *

 * @author ç§‹è¾žæœªå¯’

 * @date 2024-12-09

 */

@Documented

@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})

@Retention(RUNTIME)

@Repeatable(EnumPattern.List.class) // å…è®¸åœ¨åŒä¸€å…ƒç´ ä¸Šå¤šæ¬¡ä½¿ç”¨è¯¥æ³¨è§£

@Constraint(validatedBy = {EnumPatternValidator.class})

public @interface EnumPattern {



    /**

     * éœ€è¦æ ¡éªŒçš„枚举类型

     */

    Class<? extends Enum> type() default Enum.class;



    /**

     * æžšä¸¾ç±»åž‹æ ¡éªŒå€¼å­—段名称

     * TODO éœ€ç¡®ä¿è¯¥å­—段实现了 getter æ–¹æ³•

     */

    String fieldName() default "code";



    String message() default "输入值不在枚举范围内";



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



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



    @Documented

    @Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})

    @Retention(RUNTIME)

    @interface List {

        EnumPattern[] value();

    }



}


 ruoyi-common/ruoyi-common-core/src/main/java/org/dromara/common/core/validate/enumd/EnumPatternValidator.java

¶Ô±ÈÐÂÎļþ
@@ -0,0 +1,45 @@
package org.dromara.common.core.validate.enumd;



import org.dromara.common.core.utils.StringUtils;

import org.dromara.common.core.utils.reflect.ReflectUtils;

import jakarta.validation.ConstraintValidator;

import jakarta.validation.ConstraintValidatorContext;

import jakarta.validation.ValidationException;

import lombok.extern.slf4j.Slf4j;



/**

 * è‡ªå®šä¹‰æžšä¸¾æ ¡éªŒæ³¨è§£å®žçŽ°

 *

 * @author ç§‹è¾žæœªå¯’

 * @date 2024-12-09

 */

public class EnumPatternValidator implements ConstraintValidator<EnumPattern, String> {



    private EnumPattern annotation;;



    @Override

    public void initialize(EnumPattern annotation) {

        ConstraintValidator.super.initialize(annotation);

        this.annotation = annotation;

    }



    @Override

    public boolean isValid(String value, ConstraintValidatorContext constraintValidatorContext) {

        try {

            if (StringUtils.isNotBlank(value)) {

                Class<?> type = annotation.type();

                String fieldName = annotation.fieldName();

                Object[] enumConstants = type.getEnumConstants();

                for (Object e : enumConstants) {

                    if (value.equals(ReflectUtils.invokeGetter(e, fieldName))) {

                        return true;

                    }

                }

            }

            return false;

        } catch (Exception e) {

            throw new ValidationException(e);

        }

    }



}