Java反射获取枚举类型值列表对外提供服务

一、前言

在工作中原本一些枚举值都是在Apollo配置的，但是有一些配置没有必要从配置中心获取，比如简单的类型下拉框的选择和页面回显。
实现的原理很简单，就是通过自定义注解，加在需要对外提供的枚举类上。我这里是定义了三个注解（类标记，key标志，value标记）

二、关键代码实现

/**
 * @description 枚举类标记，标记了会对外提供列表，默认取类名称
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(value = ElementType.TYPE)
@Documented
public @interface EnumValue {
    /**
     * 枚举接口匹配key，默认类名
     *
     * @return
     */
    String name() default "";
}

/**
 * @description 枚举标记，标记了会对外提供列表
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(value = ElementType.FIELD)
@Documented
public @interface EnumLabelField {
}

/**
 * @description 枚举value标记
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(value = ElementType.FIELD)
@Documented
public @interface EnumValueField {
}

我这里反射使用的是扫描工具，依赖：

implementation group: 'org.reflections', name: 'reflections', version: '0.10.2'

/**
 * @description 枚举服务类，获取枚举类的枚举值列表
 */
@Slf4j
@Service("enumAppService")
public class EnumAppServiceImpl implements EnumAppService {
    /**
     * 枚举类扫描包路径
     */
    private static final String PACKAGE_PATH = "com.yingzi.idp.edge.app.v2.dto.enums";
    /**
     * 枚举类Map
     */
    private static final Map<String, List<EnumValueResDto>> enumMap = new HashMap();

    @PostConstruct
    public void init() {
        Reflections reflections = new Reflections(new ConfigurationBuilder().forPackages(PACKAGE_PATH));
        // 扫描特定包下带有 EnumValue 注解的枚举类
        Set<Class<?>> classSet = reflections.getTypesAnnotatedWith(EnumValue.class);
        if (CollUtil.isEmpty(classSet)) {
            return;
        }
        try {
            for (Class<?> clazz : classSet) {
                Field[] fields = clazz.getDeclaredFields();
                Field valueField = null;
                Field labelField = null;
                for (Field field : fields) {
                    EnumLabelField enumLabelField = field.getDeclaredAnnotation(EnumLabelField.class);
                    if (Objects.nonNull(enumLabelField)) {
                        field.setAccessible(true);
                        labelField = field;
                        continue;
                    }
                    EnumValueField enumValueField = field.getDeclaredAnnotation(EnumValueField.class);
                    if (Objects.nonNull(enumValueField)) {
                        field.setAccessible(true);
                        valueField = field;
                    }
                }
                if (Objects.isNull(valueField) || Objects.isNull(labelField)) {
                    log.error("枚举值标记没有找到对应的value和label字段标记");
                    continue;
                }
                // 反射 values 方法，获取枚举值数组
                Method method = clazz.getMethod("values");
                Object[] enums = (Object[]) method.invoke(null);
                List<EnumValueResDto> resDtoList = new ArrayList<>(enums.length);
                for (Object e : enums) {
                    Object value = valueField.get(e);
                    Object label = labelField.get(e);
                    EnumValueResDto resDto = new EnumValueResDto(String.valueOf(label), String.valueOf(value));
                    resDtoList.add(resDto);
                }
                // 默认取类名作为key
                EnumValue enumValue = clazz.getAnnotation(EnumValue.class);
                String name = StringUtils.isBlank(enumValue.name()) ? clazz.getSimpleName() : enumValue.name();
                enumMap.put(name, resDtoList);
            }
        } catch (InvocationTargetException | NoSuchMethodException | IllegalAccessException e) {
            e.printStackTrace();
        }
    }

    @Override
    public List<EnumValueResDto> getEnumValueList(String key) {
        return enumMap.get(key);
    }
}

最后前端只需要传参 key，就可以获取到对应key的枚举列表啦，这种方法挺简单的，希望对你有帮助。