EnumUtils主要功能介紹
該簡單介紹可看筆者之前文章 java枚舉工具類（減少每個枚舉中重複的方法） 但以上該方式存在一些問題，例如枚舉值（value）可能爲 String也可能爲 Byte等等，不止只是 Integer類型，而且有些枚舉可能不需要枚舉名稱（name）屬性，只需要個枚舉值value屬性即可，以上最簡單的實現方式就不支持這些需求了，故通過拆分BaseEnum接口以及增加泛型來支持該要求。
具體實現
BaseEnum接口拆分爲ValueEnum以及NameValueEnum接口
ValueEnum接口定義
/**
* 最簡單的枚舉類，即只含value的枚舉（實現此接口可使用{@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重構
/**
* 枚舉常用工具類。<br/>
* 使用該枚舉工具類需要指定的枚舉實現{@link ValueEnum} OR {@link NameValueEnum}接口
* @author meilin.huang
* @version 1.0
* @date 2019-03-22 11:12 AM
*/
public final class EnumUtils {
/**
* 判斷枚舉值是否存在於指定枚舉數組中
* @param enums 枚舉數組
* @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;
}
/**
* 根據枚舉值獲取其對應的名字
* @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 "";
}
/**
* 根據枚舉名稱獲取對應的枚舉值
* @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註解對入參進行自動校驗
通過hibernate validator自定義參數校驗註解方式實現對入參爲枚舉類型的參數進行校驗
/**
* 枚舉值校驗，即值只能是指定枚舉類中的值
* @author meilin.huang
* @version 1.0
* @date 2019-06-19 10:32 AM
*/
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = ValueEnum.ValueEnumValidator.class)
public @interface ValueEnum {
/**
* 錯誤提示
*/
String message() default "枚舉值錯誤";
/**
* 必須的屬性
* 用於分組校驗
*/
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
/**
* 枚舉類(必須實現{@link EnumValue}接口的枚舉)
*/
Class<? extends Enum<? extends EnumValue>> enumClass();
class ValueEnumValidator implements ConstraintValidator<ValueEnum, Object> {
private Class<? extends Enum<? extends EnumValue>> enumClass;
@Override
public void initialize(ValueEnum valueEnum) {
this.enumClass = valueEnum.enumClass();
}
@Override
public boolean isValid(Object value, ConstraintValidatorContext context) {
if (value == null) {
return true;
}
// 轉換爲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;
}
本文分享自微信公衆號 - Code基地（_mayfly_）。
如有侵權，請聯繫 [email protected] 刪除。
本文參與“OSC源創計劃”，歡迎正在閱讀的你也加入，一起分享。