Java枚举类工具类

  • Post author:
  • Post category:java




场景

通过工具类返回枚举值提供给前端



Util

package com.common.utils;

import org.apache.commons.lang3.ObjectUtils;
import org.apache.commons.lang3.StringUtils;

import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.*;

public class EnumListUtil {

    private static String ENUM_CLASSPATH = "java.lang.Enum";

    public static List<Map<String, Object>> enumToListMap(Class<?> enumClass) {
        List<Map<String, Object>> resultList = new ArrayList<>();
        if (!ENUM_CLASSPATH.equals(enumClass.getSuperclass().getCanonicalName())) {
            return resultList;
        }
        // 获取所有public方法
        Method[] methods = enumClass.getMethods();
        List<Field> fieldList = new ArrayList<>();
        //1.通过get方法提取字段,避免get作为自定义方法的开头,建议枚举类中使用 ‘find’或其余命名
        Arrays.stream(methods)
                .map(Method::getName)
                .filter(
                        methodName -> methodName.startsWith("get") && !"getDeclaringClass".equals(methodName) && !"getClass".equals(methodName)
                ).forEachOrdered(methodName -> {
            try {
                Field field = enumClass.getDeclaredField(StringUtils.uncapitalize(methodName.substring(3)));
                if (null != field) {
                    fieldList.add(field);
                }
            } catch (NoSuchFieldException | SecurityException e) {
                e.printStackTrace();
            }
        });

        //2.将字段作为key,逐一把枚举值作为value 存入list
        if (ObjectUtils.isEmpty(fieldList)) {
            return resultList;
        }

        Enum<?>[] enums = (Enum[]) enumClass.getEnumConstants();
        for (Enum<?> anEnum : enums) {
            Map<String, Object> map = new HashMap<>(fieldList.size());
            for (Field field : fieldList) {
                field.setAccessible(true);
                try {
                    // 向map集合添加字段名称 和 字段值
                    map.put(field.getName(), field.get(anEnum));
                } catch (IllegalArgumentException | IllegalAccessException e) {
                    e.printStackTrace();
                }
            }
            // 将Map添加到集合中
            resultList.add(map);
        }
        return resultList;
    }
}



Controller

@GetMapping("/getIphoneTypeEnum")
ResponseResult<?> getIphoneTypeEnum() {
    return ResponseResult.newSuccessResponse(EnumListUtil.enumToListMap(IphoneTypeEnum.class));
}



返回结果


{
    "code": 0,
    "msg": "success",
    "success": true,
    "data": [
        {
            "name": "小米",
            "type": 1
        },
        {
            "name": "苹果",
            "type": 2
        },
        {
            "name": "华为",
            "type": 3
        }
    ]
}