枚举转字典demo

• 思路：通过自定义注解，标记需要被转换的枚举，然后扫描到它们，再利用反射转为想要的数据格式。

---

自定义的注解类

/**
 * 枚举字典属性 标记
 * <p>标记到枚举类和枚举属性上，被此注解标记的枚举类将会被程序扫描到，并通过反射将所有枚举实例转换为字典Map<String,Object>
 * @author xiesq
 * @date 2022/5/16 17:13
 */
@Target({ElementType.FIELD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface DicProperties {

    /**
     * 字典属性 name
     */
    String NAME = "name";

    /**
     * 字典属性 value
     */
    String VALUE = "value";

    /**
     * 字典属性 title
     */
    String TITLE = "title";

    /**
     * 字典属性名，不指定则默认取字段名
     */
    String value() default "";

    /**
     * 排除
     */
    String[] excludes() default {};
}

转换逻辑

/**
 * 循环所有枚举,并转换为Map
 * <p>注解值作为key，字段值作为value
 * <p>如果没有标记name，则默认为enumConstant.toString()
 * @param targetEnumClass 目标枚举类
 * @return List
 * @author xiesq
 * @date 2022/5/18 11:18
 */
private List<Map<String, Object>> convertToMapList(Class<?> targetEnumClass) {
    // 循环所有枚举实例,并转换为Map对象
    return Arrays.stream(targetEnumClass.getEnumConstants())
            // 排除指定的枚举实例
            .filter(enumConstant -> {
                String enumName = enumConstant.toString();
                String[] excludeEnumNames = targetEnumClass.getAnnotation(DicProperties.class).excludes();
                return !Arrays.asList(excludeEnumNames).contains(enumName);
            })
            // 枚举对象 转换为 Map对象
            .map(enumConstant -> {
                Map<String, Object> map = new HashMap<>();
                // 获取所有注解标记的字段
                for (Field field : targetEnumClass.getDeclaredFields()) {
                    if (!field.isAnnotationPresent(DicProperties.class)) {
                        continue;
                    }
                    // 注解值作为key，字段值作为value
                    DicProperties dicProperties = field.getAnnotation(DicProperties.class);
                    String key = dicProperties.value();
                    try {
                        ReflectionUtils.makeAccessible(field);
                        // 如果key为空，则默认取字段名
                        key = !"".equals(key) ? key : field.getName();
                        Object value = field.get(enumConstant);
                        map.put(key, value);
                    } catch (IllegalAccessException e) {
                        log.error("枚举转换错误", e);
                    }
                }
                // name
                map.putIfAbsent(DicProperties.NAME, enumConstant.toString());
                return map;
            })
            .collect(Collectors.toList());
}

扫描所有被注解标记的枚举类，匹配对应的那个枚举类

public List<Map<String, Object>> getEnumDicByEnumName(enumClassName) {
	// 扫描，用的spring的工具类
    Set<Class<?>> classSet = new AnnotatedTypeScanner(DicProperties.class).findTypes("com.cdrundle.cdc.**.enums");
    // 匹配对应名称的枚举类
    Class<?> targetEnumClass = classSet.stream()
            .filter(enumClass -> enumClass.getSimpleName().equals(enumClassName))
            .limit(1)
            .findFirst()
            .orElse(null);
    if (targetEnumClass == null) {
        // 如果找不到对应的枚举类，则返回空数组
        return Collections.emptyList();
    }
    // 如果存在对应的枚举类，则转换为List<Map>后返回
    return convertToMapList(targetEnumClass);
}