第三章 EnumUtil根據值獲取枚舉對象

　　

　　項目中使用枚舉類的好處這里不再贅述，在使用枚舉值時，通常需要根據值來獲取枚舉對象，下面介紹兩種實現方案：

1.在枚舉類中定義方法實現

　　首先給出如下性別枚舉類：　　

public enum SexEnum {
  MAN("M", "男"),
  WOMAN("F", "女");

  private String code;
  private String desc;

  SexEnum(String code, String desc) {
    this.code = code;
    this.desc = desc;
  }

  public String getCode() {
    return code;
  }

  public void setCode(String code) {
    this.code = code;
  }

  public String getDesc() {
    return desc;
  }

  public void setDesc(String desc) {
    this.desc = desc;
  }

}

　　現在需要根據code的值獲取枚舉對象，簡單直接的辦法是在該枚舉類中定義如下方法：

  public static SexEnum getSexEnumByCode(String code){
    for(SexEnum sexEnum : SexEnum.values()){
      if(StringUtils.equals(code, sexEnum.getCode())){
        return sexEnum;
      }
    }
    return null;
  }

　　以這種方案實現時，需要在每個枚舉類中都定義類似上述結構的方法。當項目中的枚舉類較多時，顯得代碼冗余。

 

2.利用反射實現

　　首先介紹本方案的實現方式，再來介紹具體代碼實現:

　　1).定義一個EnumMessage接口，然后每個枚舉類實現此接口;

　　2).定義常量保存枚舉類所在包名，以及接口全路徑;

　　3).在程序啟動時，讀取枚舉類所在包下的所有枚舉類的File文件，在從file文件信息中獲取每個枚舉類的全路徑類名集合A;

　　4).遍歷A集合，利用反射獲取每個類的class對象，再判斷該類是否實現了EnumMessage接口;

　　5).對於實現了EnumMessage接口的枚舉類，遍歷該枚舉類的所有對象，保存Map<Object, EnumMessage>的集合映射;

　　6).對枚舉類保存Map<Class, Map<Object, EnumMessage>>的映射集合。

　　至此完成了啟動的初始化工作。下面給出上述過程的代碼實現:

　　定義接口EnumMessage:

package com.example.myFirstProject.service;

public interface EnumMessage {
    Object getValue();
}

　　枚舉類SexEnum實現此接口:　

package com.example.myFirstProject.enums;

import com.example.myFirstProject.service.EnumMessage;
import org.apache.commons.lang3.StringUtils;

public enum SexEnum implements EnumMessage {
  MAN("M", "男"),
  WOMAN("F", "女");

  private String code;
  private String desc;

  SexEnum(String code, String desc) {
    this.code = code;
    this.desc = desc;
  }

  public String getCode() {
    return code;
  }

  public void setCode(String code) {
    this.code = code;
  }

  public String getDesc() {
    return desc;
  }

  public void setDesc(String desc) {
    this.desc = desc;
  }

  @Override
  public Object getValue() {
    //此處需要根據枚舉對象的哪個屬性返回枚舉對象，就return該屬性
    return code;
  }

}

　　Constant類定義了常量保存枚舉類所在包名和接口全路徑，以及Map的初始化工作:

package com.example.myFirstProject.common;

import com.example.myFirstProject.service.EnumMessage;
import com.example.myFirstProject.util.PackageUtil;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class Constant {

  /**
   * 枚舉類包名集合
   */
  public static List<String> pathList = initPackagePathList();
  /**
   * 枚舉接口類全路徑
   */
  public final static String ENUM_MESSAGE_PATH = "com.example.myFirstProject.service.EnumMessage";

  /**
   * 枚舉類對應的全路徑集合
   */
  public static final List<String> ENUM_OBJECT_PATH = PackageUtil.getPackageClasses(pathList, true);

  /**
   * 存放單個枚舉對象 map常量定義
   */
  private static Map<Object, EnumMessage> SINGLE_ENUM_MAP = null;

  /**
   * 所有枚舉對象的 map
   */
  public static final Map<Class, Map<Object, EnumMessage>> ENUM_MAP = initialEnumMap(true);

  private static List<String> initPackagePathList() {
    List<String> list = new ArrayList<>();
    list.add("com.example.myFirstProject.enums");
    return list;
  }

  static {
    System.out.println("類被加載時，先初始化各個靜態變量，再執行static塊。" +
            "所以不能在這里執行pathList的add操作(\"com.example.myFirstProject.enums\")。");
  }
  /**
   * 加載所有枚舉對象數據
   *
   * @param isFouceCheck 是否強制校驗枚舉是否實現了EnumMessage接口,若為false則沒有實現接口的枚舉類也會被加載
   */
  private static Map<Class, Map<Object, EnumMessage>> initialEnumMap(boolean isFouceCheck) {
    Map<Class, Map<Object, EnumMessage>> ENUM_MAP = new HashMap<>();
    try {
      for (String classname : ENUM_OBJECT_PATH) {
        Class<?> cls = null;
        cls = Class.forName(classname);
        Class<?>[] iter = cls.getInterfaces();
        boolean flag = false;
        if (isFouceCheck) {
          for (Class cz : iter) {
            if (cz.getName().equals(ENUM_MESSAGE_PATH)) {
              flag = true;
              break;
            }
          }
        }
        if (flag == isFouceCheck) {
          SINGLE_ENUM_MAP = new HashMap<>();
          initialSingleEnumMap(cls);
          ENUM_MAP.put(cls, SINGLE_ENUM_MAP);
        }

      }
    } catch (Exception e) {

    }
    return ENUM_MAP;
  }

  /**
   * 加載每個枚舉對象數據
   */
  private static void initialSingleEnumMap(Class<?> cls) throws Exception {
    Method method = cls.getMethod("values");
    EnumMessage inter[] = (EnumMessage[]) method.invoke(null, null);
    for (EnumMessage enumMessage : inter) {
      SINGLE_ENUM_MAP.put(enumMessage.getValue(), enumMessage);
    }
  }


}

　　PackageUtil工具類主要完成根據枚舉類所在包名獲取該package下所有class的全路徑名稱的工作：

package com.example.myFirstProject.util;

import java.io.File;
import java.util.ArrayList;
import java.util.List;

public class PackageUtil {

  /**
   * 返回包下所有的類
   *
   * @param packagePathList   包名全路徑集合
   * @param classWithPath 返回全路徑開關 true 自動帶上包名 false 只返回類名
   * @return List<String> 包下所有的類
   */
  public static List<String> getPackageClasses(List<String> packagePathList, boolean classWithPath) {
    List<String> result = new ArrayList<>();
    for(String packagePath : packagePathList) {
      List<String> classNames = getClassName(packagePath);
      String path = classWithPath ? packagePath + "." : "";
      for (String className : classNames) {
        //className:com.example.myFirstProject.enums.SexEnum
        result.add(path + className.substring(className.lastIndexOf(".") + 1));
      }
    }
    return result;
  }

  /**
   * 獲取該報名全路徑下的所有class全路徑集合
   * @param packageName 包名全路徑
   * @return
   */
  private static List<String> getClassName(String packageName) {
    //根據報名獲取該package的系統路徑
    String filePath = ClassLoader.getSystemResource("").getPath() + packageName.replace(".", "\\");
    // filePath: /D:/workspace-git/springbootlearning/target/classes/com\example\myFirstProject\enums
    List<String> fileNames = getClassName(filePath, null);
    return fileNames;
  }

  /**
   * 獲取filePath文件夾下的所有class的全路徑集合
   * @param filePath
   * @param className
   * @return
   */
  private static List<String> getClassName(String filePath, List<String> className) {
    List<String> myClassName = new ArrayList<>();
    File file = new File(filePath);
    File[] childFiles = file.listFiles();
    for (File childFile : childFiles) {
      if (childFile.isDirectory()) {
        //遞歸獲取該文件夾下的子文件夾里的所有文件
        myClassName.addAll(getClassName(childFile.getPath(), myClassName));
      } else {
        String childFilePath = childFile.getPath();
        //childFilePath:  D:\workspace-git\springbootlearning\target\classes\com\example\myFirstProject\enums\SexEnum.class
        childFilePath = childFilePath.substring(childFilePath.indexOf("\\classes") + 9, childFilePath.lastIndexOf("."));
        childFilePath = childFilePath.replace("\\", ".");
        myClassName.add(childFilePath);
      }
    }

    return myClassName;
  }

}

　　定義EnumUtil，提供根據值獲取枚舉對象的入口方法：　

package com.example.myFirstProject.util;

import com.example.myFirstProject.common.Constant;
import com.example.myFirstProject.service.EnumMessage;

public class EnumUtil {

    /**
     * 獲取value返回枚舉對象
     * @param value
     * @param clazz
     * */
    public static <T extends EnumMessage>  T getEnumObject(Object value, Class<T> clazz){
        return (T) Constant.ENUM_MAP.get(clazz).get(value);
    }
    
}

　　最后編寫測試語句:

　　System.out.println(EnumUtil.getEnumObject("M", SexEnum.class));　　//MAN

　　至此該方案實現了根據枚舉對象的值"M"獲取枚舉類對象"MAN"。

 

　　注意：關於static變量的加載時機:

　　當在EnumUtil中調用Constant的靜態變量ENUM_MAP時，Constant類被加載，Conatant類中的pathList,ENUM_OBJECT_PATH,ENUM_MAP被按順序加載，即先執行了Conatant的initPackagePathList()方法，再執行了PackageUtil的getPackageClasses(pathList, true)方法

最后在 public static final Map<Class, Map<Object, EnumMessage>> ENUM_MAP = initialEnumMap(true)被調用時，ENUM_OBJECT_PATH已經有值。

 

　　附：類被加載的時機：　　

　　1、用Class.forName()顯示加載的時候;

　　2、實例化一個類的時候;

　　3、調用類的靜態方法的時候;

　　4、調用類的靜態變量的時候;