Color color=Color.RED;switch(color){case RED: System.out.println("it's red");break;case BLUE: System.out.println("it's blue");break;case BLACK: System.out.println("it's blue");break;
}
5、EnumUtil根据值获取枚举对象
项目中使用枚举类的好处这里不再赘述,在使用枚举值时,通常需要根据值来获取枚举对象,下面介绍两种实现方案:
1.在枚举类中定义方法实现
首先给出如下性别枚举类:
public enumSexEnum {
MAN("M", "男"),
WOMAN("F", "女");privateString code;privateString desc;
SexEnum(String code, String desc) {this.code =code;this.desc =desc;
}publicString getCode() {returncode;
}public voidsetCode(String code) {this.code =code;
}publicString getDesc() {returndesc;
}public voidsetDesc(String desc) {this.desc =desc;
}
}
现在需要根据code的值获取枚举对象,简单直接的办法是在该枚举类中定义如下方法:
public staticSexEnum getSexEnumByCode(String code){for(SexEnum sexEnum : SexEnum.values()){if(StringUtils.equals(code, sexEnum.getCode())){returnsexEnum;
}
}return null;
}
以这种方案实现时,需要在每个枚举类中都定义类似上述结构的方法。当项目中的枚举类较多时,显得代码冗余。
2.利用反射实现
首先介绍本方案的实现方式,再来介绍具体代码实现:
1).定义一个EnumMessage接口,然后每个枚举类实现此接口;
2).定义常量保存枚举类所在包名,以及接口全路径;
3).在程序启动时,读取枚举类所在包下的所有枚举类的File文件,在从file文件信息中获取每个枚举类的全路径类名集合A;
4).遍历A集合,利用反射获取每个类的class对象,再判断该类是否实现了EnumMessage接口;
5).对于实现了EnumMessage接口的枚举类,遍历该枚举类的所有对象,保存Map的集合映射;
6).对枚举类保存Map>的映射集合。
至此完成了启动的初始化工作。下面给出上述过程的代码实现:
定义接口EnumMessage:
packagecom.example.myFirstProject.service;public interfaceEnumMessage {
Object getValue();
}
枚举类SexEnum实现此接口:
packagecom.example.myFirstProject.enums;importcom.example.myFirstProject.service.EnumMessage;importorg.apache.commons.lang3.StringUtils;public enum SexEnum implementsEnumMessage {
MAN("M", "男"),
WOMAN("F", "女");privateString code;privateString desc;
SexEnum(String code, String desc) {this.code =code;this.desc =desc;
}publicString getCode() {returncode;
}public voidsetCode(String code) {this.code =code;
}publicString getDesc() {returndesc;
}public voidsetDesc(String desc) {this.desc =desc;
}
@OverridepublicObject getValue() {//此处需要根据枚举对象的哪个属性返回枚举对象,就return该属性
returncode;
}
}
Constant类定义了常量保存枚举类所在包名和接口全路径,以及Map的初始化工作:
packagecom.example.myFirstProject.common;importcom.example.myFirstProject.service.EnumMessage;importcom.example.myFirstProject.util.PackageUtil;importjava.lang.reflect.Method;importjava.util.ArrayList;importjava.util.HashMap;importjava.util.List;importjava.util.Map;public classConstant {/*** 枚举类包名集合*/
public static List pathList =initPackagePathList();/*** 枚举接口类全路径*/
public final static String ENUM_MESSAGE_PATH = "com.example.myFirstProject.service.EnumMessage";/*** 枚举类对应的全路径集合*/
public static final List ENUM_OBJECT_PATH = PackageUtil.getPackageClasses(pathList, true);/*** 存放单个枚举对象 map常量定义*/
private static Map SINGLE_ENUM_MAP = null;/*** 所有枚举对象的 map*/
public static final Map> ENUM_MAP = initialEnumMap(true);private static ListinitPackagePathList() {
List list = new ArrayList<>();
list.add("com.example.myFirstProject.enums");returnlist;
}static{
System.out.println("类被加载时,先初始化各个静态变量,再执行static块。" +
"所以不能在这里执行pathList的add操作(\"com.example.myFirstProject.enums\")。");
}/*** 加载所有枚举对象数据
*
*@paramisFouceCheck 是否强制校验枚举是否实现了EnumMessage接口,若为false则没有实现接口的枚举类也会被加载*/
private static Map> initialEnumMap(booleanisFouceCheck) {
Map> 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) {
}returnENUM_MAP;
}/*** 加载每个枚举对象数据*/
private static void initialSingleEnumMap(Class> cls) throwsException {
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的全路径名称的工作:
packagecom.example.myFirstProject.util;importjava.io.File;importjava.util.ArrayList;importjava.util.List;public classPackageUtil {/*** 返回包下所有的类
*
*@parampackagePathList 包名全路径集合
*@paramclassWithPath 返回全路径开关 true 自动带上包名 false 只返回类名
*@returnList 包下所有的类*/
public static List getPackageClasses(List packagePathList, booleanclassWithPath) {
List result = new ArrayList<>();for(String packagePath : packagePathList) {
List 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));
}
}returnresult;
}/*** 获取该报名全路径下的所有class全路径集合
*@parampackageName 包名全路径
*@return
*/
private static ListgetClassName(String packageName) {//根据报名获取该package的系统路径
String filePath = ClassLoader.getSystemResource("").getPath() + packageName.replace(".", "\\");//filePath: /D:/workspace-git/springbootlearning/target/classes/com\example\myFirstProject\enums
List fileNames = getClassName(filePath, null);returnfileNames;
}/*** 获取filePath文件夹下的所有class的全路径集合
*@paramfilePath
*@paramclassName
*@return
*/
private static List getClassName(String filePath, ListclassName) {
List myClassName = new ArrayList<>();
File file= newFile(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);
}
}returnmyClassName;
}
}
定义EnumUtil,提供根据值获取枚举对象的入口方法:
packagecom.example.myFirstProject.util;importcom.example.myFirstProject.common.Constant;importcom.example.myFirstProject.service.EnumMessage;public classEnumUtil {/*** 获取value返回枚举对象
*@paramvalue
*@paramclazz
**/
public static T getEnumObject(Object value, Classclazz){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> ENUM_MAP = initialEnumMap(true)被调用时,ENUM_OBJECT_PATH已经有值。
附:类被加载的时机:
1、用Class.forName()显示加载的时候;
2、实例化一个类的时候;
3、调用类的静态方法的时候;
4、调用类的静态变量的时候;