JAVA枚举操作（获取值，转map集合）

Posted 2021-02-14 梦中的鱼

JAVA枚举相对来说比.NET的枚举功能强大，感觉就像是一种简化版的类对象，可以有构造方法，可以重载，可以继承接口等等，但不能继承类，JAVA枚举在实际开发中应用相当频繁，以下几个封装方法在实际开发中可能用到，希望对新手有些帮助。

首先，新建一个枚举接口，为保证所有继承此接口的枚举value及description一致，便于开发使用，枚举统一接口如下。

public interface EnumCommon {
public int getValue();
public String getDescription();
}

建立测试的枚举对象，此枚举继承上述接口，如下所示：

public enum TestEnum implements EnumCommon {
AAA(1, "描述AAA"), BBB(2, "描述BBB"), CCC(3, "描述CCC"), DDD(4, "描述DDD") /*,EEEE8*/;
private int value; //枚举value字段
private String description; //枚举描述字段
@Override
public int getValue() {
return value;
}
@Override
public String getDescription() {
return description;
}
//private TestEnum() {}
TestEnum(int value,String description){ //构造初始化赋值
this.description=description;
this.value=value;
}
}

建立枚举时，如果存在没有value和description的枚举属性，必须要有无参构造方法，不定参数的要存在相应不定参数的构造方法。
接下来就到真正的工具方法了，首先一个公用方法，通过方法名称获取返回值，如下所示：

/**
* 根据反射，通过方法名称获取方法值，忽略大小写的
* @param methodName
* @param obj
* @param args
* @return return value
*/
private static <T> Object getMethodValue(String methodName, T obj,
Object... args) {
Object resut = "";
// boolean isHas = false;
try {
/********************************* start *****************************************/
Method[] methods = obj.getClass().getMethods(); //获取方法数组，这里只要共有的方法
if (methods.length <= 0) {
return resut;
}
// String methodstr=Arrays.toString(obj.getClass().getMethods());
// if(methodstr.indexOf(methodName)<0){ //只能粗略判断如果同时存在 getValue和getValues可能判断错误
// return resut;
// }
// List<Method> methodNamelist=Arrays.asList(methods); //这样似乎还要循环取出名称
Method method = null;
for (int i = 0, len = methods.length; i < len; i++) {
if (methods[i].getName().equalsIgnoreCase(methodName)) { //忽略大小写取方法
// isHas = true;
methodName = methods[i].getName(); //如果存在，则取出正确的方法名称
method = methods[i];
break;
}
}
// if(!isHas){
// return resut;
// }
/*************************** end ***********************************************/
// Method method = obj.getClass().getDeclaredMethod(methodName); ///确定方法
if (method == null) {
return resut;
}
resut = method.invoke(obj, args); //方法执行
if (resut == null) {
resut = "";
}
return resut; //返回结果
} catch (Exception e) {
e.printStackTrace();
}
return resut;
}

  具体的用途注释已经写的很清楚了，这里的不定参数其实没有用到，从start到end部分的代码是在进行方法扫描判断，不想看到那个
NoSuchMethodException异常才这样弄，如果每次都保证写的方法名是存在的，可以直接用那个确定方法代替上面一堆代码，或者直接把异常关闭。

下面方法就是要通过value值获取description值的方法：

/**
* 通过value值获取对应的描述信息
* @param value
* @param enumT
* @param method
* @return enum description
*/
public static <T> Object getEnumDescriotionByValue(Object value,
Class<T> enumT, String... methodNames) {
if (!enumT.isEnum()) { //不是枚举则返回""
return "";
}
T[] enums = enumT.getEnumConstants(); //获取枚举的所有枚举属性，似乎这几句也没啥用，一般既然用枚举，就一定会添加枚举属性
if (enums == null || enums.length <= 0) {
return "";
}
int count = methodNames.length;
String valueMathod = "getValue"; //改成自己的获取value值的方法名
String desMathod = "getDescription"; //改成自己的获取des值得方法名
if (count >= 1 && !"".equals(methodNames[0])) {
valueMathod = methodNames[0];
}
if (count == 2 && !"".equals(methodNames[1])) {
desMathod = methodNames[1];
}
for (int i = 0, len = enums.length; i < len; i++) {
T t = enums[i];
try {
Object resultValue = getMethodValue(valueMathod, t);//获取枚举对象value
if (resultValue.toString().equals(value + "")) {
Object resultDes = getMethodValue(desMathod, t); //存在则返回对应描述
return resultDes;
}
} catch (Exception e) {
e.printStackTrace();
}
}
return "";
}

参数分别是要获取value
的值，枚举的字节码，是否扩展方法，如果不扩展或者不是自定义，默认的value和description方法为公共接口的两个方法，你也可以自定义获取其他方法，那个不定参数，第一个为value参数对应的方法，第二个为description对应的自定义方法。你也可以通过描述获取value或者获取其他。
下面方法为通过value获取枚举的属性值，大体和上面的方法一样，就不多说了，直接上代码。

/**
* 通过枚举value或者自定义值及方法获取枚举属性值
* @param value
* @param enumT
* @param method
* @return enum key
*/
public static <T> String getEnumKeyByValue(Object value, Class<T> enumT,
String... methodNames) {
if (!enumT.isEnum()) {
return "";
}
T[] enums = enumT.getEnumConstants();
if (enums == null || enums.length <= 0) {
return "";
}
int count = methodNames.length;
String valueMathod = "getValue"; //默认方法
if (count >= 1 && !"".equals(methodNames[0])) { //独立方法
valueMathod = methodNames[0];
}
for (int i = 0, len = enums.length; i < len; i++) {
T tobj = enums[i];
try {
Object resultValue = getMethodValue(valueMathod, tobj);
if (resultValue != null
&& resultValue.toString().equals(value + "")) { //存在则返回对应值
return tobj + "";
}
} catch (Exception e) {
e.printStackTrace();
}
}
return "";
}

最后一个方式是枚举转Map集合，这个在spring MVC web开发自动生成下拉框,,单选框，多选框的时候应用比较方便，代码如下：

/**
* 枚举转map结合value作为map的key,description作为map的value
* @param enumT
* @param method
* @return enum mapcolloction
*/
public static <T> Map<Object, String> EnumToMap(Class<T> enumT,
String... methodNames) {
Map<Object, String> enummap = new HashMap<Object, String>();
if (!enumT.isEnum()) {
return enummap;
}
T[] enums = enumT.getEnumConstants();
if (enums == null || enums.length <= 0) {
return enummap;
}
int count = methodNames.length;
String valueMathod = "getValue"; //默认接口value方法
String desMathod = "getDescription";//默认接口description方法
if (count >= 1 && !"".equals(methodNames[0])) { //扩展方法
valueMathod = methodNames[0];
}
if (count == 2 && !"".equals(methodNames[1])) {
desMathod = methodNames[1];
}
for (int i = 0, len = enums.length; i < len; i++) {
T tobj = enums[i];
try {
Object resultValue = getMethodValue(valueMathod, tobj); //获取value值
if ("".equals(resultValue)) {
continue;
}
Object resultDes = getMethodValue(desMathod, tobj); //获取description描述值
if ("".equals(resultDes)) { //如果描述不存在获取属性值
resultDes = tobj;
}
enummap.put(resultValue, resultDes + "");
} catch (Exception e) {
e.printStackTrace();
}
}
return enummap;
}
代码的使用方式如下，应该涵盖了我们常用的枚举操作：

Class<TestEnum> clasz=TestEnum.class;
Map<Object, String> map=EnumUtil.EnumToMap(clasz);
System.out.println("获取枚举的map集合----------："+map);
String des=(String) EnumUtil.getEnumDescriotionByValue(2, clasz);
System.out.println("获取值为2的描述------------："+des);

Object valueget=EnumUtil.getEnumDescriotionByValue("描述CCC", clasz,"getDescription","getValue");
System.out.println("获取 描述CCC 的value值-----："+valueget);

String field=(String) EnumUtil.getEnumKeyByValue(4, clasz);
System.out.println("获取值为4的属性字段--------："+field);

String fielda=(String) EnumUtil.getEnumKeyByValue("描述AAA", clasz,"getDescription");
System.out.println("获取 描述AAA 的属性字段----："+fielda);

TestEnum str= Enum.valueOf(TestEnum.class,"AAA");
System.out.println("根据字段名称取值---------："+ str.getValue());
System.out.println("获取枚举所有字段---------："+ Arrays.toString(TestEnum.values()));

上述运行结果如下图所示：

 

 

springMVC调用绑定方式如下，控制器代码：

Class<TestEnum> clasz=TestEnum.class;
Map<Object, String> map=EnumUtil.EnumToMap(clasz);
request.setAttribute("restEnum", map);
String returnString="hhhhhh修改了编码";
return new ModelAndView("test","str",returnString);

通过读取枚举返回map集合，前台页面代码如下：

这是map======》》》${restEnum}<br>
<form:form commandName="str">
map下拉框：：》》: <form:select path="" items="${restEnum}"/><br><br/><br/><br/><br/>

map单选框：：》》： <form:radiobuttons path="" name="enumlistrd" items="${restEnum}" delimiter=" " /><br/>

map多选框：：》》： <form:checkboxes items="${restEnum}" path="" name="enumlistck" />
</form:form>

springMVC form表单自动装载，<form:form commandName="">可以后台传对象，传入对应与对象字段自动绑定，path属性可以是commandName的属性字段，当存在时，会默认选中。items为绑定的map集合，效果如下图所示：