EnumUtils重構(gòu)及自定義@EnumValue注解自動(dòng)校驗(yàn)枚舉值

EnumUtils主要功能介紹

該簡(jiǎn)單介紹可看筆者之前文章 java枚舉工具類(減少每個(gè)枚舉中重復(fù)的方法)
但以上該方式存在一些問題,例如枚舉值(value)可能為String也可能為Byte等等,不止只是Integer類型,而且有些枚舉可能不需要枚舉名稱(name)屬性,只需要個(gè)枚舉值value屬性即可,以上最簡(jiǎn)單的實(shí)現(xiàn)方式就不支持這些需求了,故通過拆分BaseEnum接口以及增加泛型來支持該要求。

具體實(shí)現(xiàn)

BaseEnum接口拆分為ValueEnum以及NameValueEnum接口

ValueEnum接口定義
/**
 * 最簡(jiǎn)單的枚舉類,即只含value的枚舉(實(shí)現(xiàn)此接口可使用{@link mayfly.core.util.EnumUtils}中的方法)
 * @author meilin.huang
 * @version 1.0
 * @date 2019-04-22 10:10
 */
public interface ValueEnum<T> {
    /**
     * 獲取枚舉值
     * @return  枚舉值
     */
    T getValue();
}
NameValueEnum接口定義
/**
 * 帶有枚舉值以及枚舉名稱的枚舉接口(可使用{@link mayfly.core.util.EnumUtils}中的方法)
 * @author meilin.huang
 * @version 1.0
 * @date 2019-03-22 11:04 AM
 */
public interface NameValueEnum<T> extends ValueEnum<T> {
    /**
     * 獲取枚舉名稱
     * @return 枚舉名
     */
    String getName();
}

EnumUtils重構(gòu)

/**
 * 枚舉常用工具類。<br/>
 * 使用該枚舉工具類需要指定的枚舉實(shí)現(xiàn){@link ValueEnum} OR {@link NameValueEnum}接口
 * @author meilin.huang
 * @version 1.0
 * @date 2019-03-22 11:12 AM
 */
public final class EnumUtils {

    /**
     * 判斷枚舉值是否存在于指定枚舉數(shù)組中
     * @param enums  枚舉數(shù)組
     * @param value  枚舉值
     * @return
     */
    public static <T> boolean isExist(ValueEnum<T>[] enums, T value) {
        if (value == null) {
            return false;
        }
        for (ValueEnum<T> e : enums) {
            if (value.equals(e.getValue())) {
                return true;
            }
        }
        return false;
    }

    /**
     * 根據(jù)枚舉值獲取其對(duì)應(yīng)的名字
     * @param enums  枚舉列表
     * @param value  枚舉值
     * @return       枚舉名稱
     */
    public static <T> String getNameByValue(NameValueEnum<T>[] enums, T value) {
        if (value == null) {
            return "";
        }
        for (NameValueEnum e : enums) {
            if (value.equals(e.getValue())) {
                return e.getName();
            }
        }
        return "";
    }

    /**
     * 根據(jù)枚舉名稱獲取對(duì)應(yīng)的枚舉值
     * @param enums  枚舉列表
     * @param name   枚舉名
     * @return       枚舉值
     */
    public static <T> T getValueByName(NameValueEnum<T>[] enums, String name) {
        if (StringUtils.isEmpty(name)) {
            return null;
        }
        for (NameValueEnum<T> e : enums) {
            if (name.equals(e.getName())) {
                return e.getValue();
            }
        }
        return  null;
    }
}

自定義@EnumValue注解對(duì)入?yún)⑦M(jìn)行自動(dòng)校驗(yàn)

通過hibernate validator自定義參數(shù)校驗(yàn)注解方式實(shí)現(xiàn)對(duì)入?yún)槊杜e類型的參數(shù)進(jìn)行校驗(yàn)

/**
 * 枚舉值校驗(yàn),即值只能是指定枚舉類中的值
 * @author meilin.huang
 * @version 1.0
 * @date 2019-06-19 10:32 AM
 */
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = EnumValue.EnumValueValidator.class)
public @interface EnumValue {
    /**
     * 錯(cuò)誤提示
     */
    String message() default "枚舉值錯(cuò)誤";

    /**
     * 必須的屬性
     * 用于分組校驗(yàn)
     */
    Class<?>[] groups() default {};

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

    /**
     * 枚舉類(必須實(shí)現(xiàn){@link EnumValue}接口的枚舉)
     */
    Class<? extends Enum<? extends EnumValue>> enumClass();



    class ValueEnumValidator implements ConstraintValidator<EnumValue, Object> {

        private Class<? extends Enum<? extends EnumValue>> enumClass;

        @Override
        public void initialize(EnumValue enumValue) {
            this.enumClass = enumValue.enumClass();
        }

        @Override
        public boolean isValid(Object value, ConstraintValidatorContext context) {
            if (value == null) {
                return true;
            }
            // 轉(zhuǎn)換為ValueEnum接口
            Enum<? extends EnumValue>[] enums = enumClass.getEnumConstants();
            EnumValue[] enumValues = new EnumValue[enums.length];
            for (int i = 0; i < enums.length; i++) {
                enumValues[i] = (EnumValue) enums[i];
            }
            return EnumUtils.isExist(enumValues, value)
        }
    }
}
使用:
  enum StringEnum implements ValueEnum<String> {
        S1("01"), S2("02");

        private String value;
        StringEnum(String value) {
            this.value = value;
        }

        @Override
        public String getValue() {
            return this.value;
        }
    }

    enum IntegerEnum implements ValueEnum<Integer> {
        I1(1), I2(2);

        private Integer value;

        IntegerEnum(Integer value) {
            this.value = value;
        }


        @Override
        public Integer getValue() {
            return this.value;
        }
    }


  public class User{
        @NotBlank
        private String username;

        @EnumValue(StringEnum.class)
        private String sEnum;

        @EnumValue(IntegerEnum.class)
        private Integer iEnum;
    } 
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

友情鏈接更多精彩內(nèi)容