EnumUtil根据值获取枚举对象
2017-03-28 15:41
495 查看
项目中使用枚举类的好处这里不再赘述,在使用枚举值时,通常需要根据值来获取枚举对象,下面介绍两种实现方案:
1.在枚举类中定义方法实现
首先给出如下性别枚举类:
现在需要根据code的值获取枚举对象,简单直接的办法是在该枚举类中定义如下方法:
2.利用反射实现
首先介绍本方案的实现方式,再来介绍具体代码实现:
1).定义一个EnumMessage接口,然后每个枚举类实现此接口;
2).定义常量保存枚举类所在包名,以及接口全路径;
3).在程序启动时,读取枚举类所在包下的所有枚举类的File文件,在从file文件信息中获取每个枚举类的全路径类名集合A;
4).遍历A集合,利用反射获取每个类的class对象,再判断该类是否实现了EnumMessage接口;
5).对于实现了EnumMessage接口的枚举类,遍历该枚举类的所有对象,保存Map<Object, EnumMessage>的集合映射;
6).对枚举类保存Map<Class, Map<Object, EnumMessage>>的映射集合。
至此完成了启动的初始化工作。下面给出上述过程的代码实现:
定义接口EnumMessage:
Constant类定义了常量保存枚举类所在包名和接口全路径,以及Map的初始化工作:
PackageUtil工具类主要完成根据枚举类所在包名获取该package下所有class的全路径名称的工作:
定义EnumUtil,提供根据值获取枚举对象的入口方法:
最后编写测试语句:
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、调用类的静态变量的时候;
转自http://www.cnblogs.com/jian-xiao/p/6036925.html
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; }
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、调用类的静态变量的时候;
转自http://www.cnblogs.com/jian-xiao/p/6036925.html
相关文章推荐
- EnumUtil根据值获取枚举对象
- java Enum 枚举帮助类,根据值或者名称获取枚举类型对象(从ITEYE搬家过来的)
- 【C#枚举】根据EnumName获取Value
- 根据值获取Enum枚举
- Enum类型辅助类 利用反射根据int类型获取枚举
- jquery1.5.1中根据元素ID获取元素对象的代码
- C# 获取枚举 Enum 变量值的 Description 属性
- jQuery 练习[二]: 获取对象(3) - 根据属性、内容匹配, 还有表单元素匹配
- jQuery 获取对象 根据属性、内容匹配, 还有表单元素匹配
- 利用反射遍历Enum,并显示在ComboBox上,根据枚举的值,选中在comboBox中指定的项
- EASBOS根据id获取对象方法来进行过滤字段
- jquery1.5.1根据元素ID获取元素对象
- 根据属性名称 获取对象的属性值
- C#泛型、反射-根据对象名获取该类型以及其属性
- java 获取未知枚举的集合(get unknown enum list)
- 根据对象名获取对象
- C#根据控件名获取控件对象
- C# 根据枚举名(string)获得enum中的枚举值
- 使用dojo declare(继承v102版本) 时出现无法根据id获取到对象的问题
- 對.Net中枚举(Enum)的進一步探討--Enum添加属性,获取属性