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

EnumUtils主要功能介紹

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

具體實現(xiàn)

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

ValueEnum接口定義
/**
 * 最簡單的枚舉類寿烟,即只含value的枚舉(實現(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/>
 * 使用該枚舉工具類需要指定的枚舉實現(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ù)枚舉值獲取其對應(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ù)枚舉名稱獲取對應(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注解對入?yún)⑦M行自動校驗

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

/**
 * 枚舉值校驗,即值只能是指定枚舉類中的值
 * @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 {
    /**
     * 錯誤提示
     */
    String message() default "枚舉值錯誤";

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

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

    /**
     * 枚舉類(必須實現(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)容合作請聯(lián)系作者
  • 序言:七十年代末筛武,一起剝皮案震驚了整個濱河市缝其,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌徘六,老刑警劉巖内边,帶你破解...
    沈念sama閱讀 217,826評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異待锈,居然都是意外死亡漠其,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,968評論 3 395
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來和屎,“玉大人拴驮,你說我怎么就攤上這事〔裥牛” “怎么了套啤?”我有些...
    開封第一講書人閱讀 164,234評論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長颠印。 經(jīng)常有香客問我纲岭,道長,這世上最難降的妖魔是什么线罕? 我笑而不...
    開封第一講書人閱讀 58,562評論 1 293
  • 正文 為了忘掉前任止潮,我火速辦了婚禮,結(jié)果婚禮上钞楼,老公的妹妹穿的比我還像新娘喇闸。我一直安慰自己,他們只是感情好询件,可當我...
    茶點故事閱讀 67,611評論 6 392
  • 文/花漫 我一把揭開白布燃乍。 她就那樣靜靜地躺著,像睡著了一般宛琅。 火紅的嫁衣襯著肌膚如雪刻蟹。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,482評論 1 302
  • 那天嘿辟,我揣著相機與錄音舆瘪,去河邊找鬼。 笑死红伦,一個胖子當著我的面吹牛英古,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播昙读,決...
    沈念sama閱讀 40,271評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼召调,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了蛮浑?” 一聲冷哼從身側(cè)響起唠叛,我...
    開封第一講書人閱讀 39,166評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎沮稚,沒想到半個月后玻墅,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,608評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡壮虫,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,814評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片囚似。...
    茶點故事閱讀 39,926評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡剩拢,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出饶唤,到底是詐尸還是另有隱情徐伐,我是刑警寧澤,帶...
    沈念sama閱讀 35,644評論 5 346
  • 正文 年R本政府宣布募狂,位于F島的核電站办素,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏祸穷。R本人自食惡果不足惜性穿,卻給世界環(huán)境...
    茶點故事閱讀 41,249評論 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望雷滚。 院中可真熱鬧需曾,春花似錦、人聲如沸祈远。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,866評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽车份。三九已至谋减,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間扫沼,已是汗流浹背出爹。 一陣腳步聲響...
    開封第一講書人閱讀 32,991評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留充甚,地道東北人以政。 一個月前我還...
    沈念sama閱讀 48,063評論 3 370
  • 正文 我出身青樓,卻偏偏與公主長得像伴找,于是被迫代替她去往敵國和親盈蛮。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 44,871評論 2 354