瀏覽代碼

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

疯狂的狮子Li 4 月之前
父節點
當前提交
b1badca062

+ 48 - 0
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();
+    }
+
+}

+ 45 - 0
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);
+        }
+    }
+
+}