Карта ключ-значение каждого значения перечисления в Java

Question

Задача

В фоновом проекте Java у меня есть несколько (более 100) внешних перечислений, которые я не могу редактировать, и мне нужно вывести их на наш интерфейс. Я хотел вывести их в виде JSON-объекта. Каждое перечисление имеет разные свойства name.

например. для следующего перечисления

public enum Colors {
  RED(1, "RED", "ff0000", Boolean.TRUE),
  GREEN(2, "GREEN", "00ff00", Boolean.FALSE),
  BLUE(3, "BLUE", "0000ff", Boolean.TRUE);

  private int code;
  private String label;
  private String hexCode;
  private boolean isAwesome;

  // ... getters and other methods
}

я хочу вывести

[
  {
    label: "RED"
    hexCode: "ff0000"
    isAwesome: true
  },
  {
    label: "GREEN"
    hexCode: "00ff00"
    isAwesome: false
  },
  ...
]

Моя попытка

Я новичок в Java, я впервые использую рефлексию, и я ничего не изучал, прежде чем углубляться в это. Вероятно, есть некоторые серьезные проблемы с этим кодом (например, производительность или другие странные вещи, которые я не знаю), но он компилируется и выполняет свою работу. Я не знаю, безопасно ли это, поэтому я спрашиваю, есть ли лучшие способы сделать это.

private <T> List<HashMap<String, Object>> enumInserter(Class<T> clazz, List<String> properties) {
    return valuesToMap(clazz.getEnumConstants(), parserFactory(clazz, properties));
}

/**
* 
* @param <T>    type of the enum class
* @param values enumConstants of the enum
* @param parser a function that take a single enumValue of type <T> and returns
*               an property-value map
* @return the array of the property-value maps of each value
*/
private <T> List<HashMap<String, Object>> valuesToMap(T[] values, Function<T, HashMap<String, Object>> parser) {
  List<HashMap<String, Object>> enumValues = new ArrayList<>();
  for (T enumValue : values) {
    HashMap<String, Object> processedValue = parser.apply(enumValue);
    enumValues.add(processedValue);
  }
  return enumValues;
}

/**
* 
* @param <T>        the type of the enum class
* @param clazz      the enum class
* @param properties the properties to be added in the map
* @return a parser function that take a single enumValue of type <T> as input and
*         returns a property-value map of the given enumValue
*/
private <T> Function<T, HashMap<String, Object>> parserFactory(Class<T> clazz, List<String> properties) {
  return ((T enumValue) -> {
    HashMap<String, Object> map = new HashMap<>();

    properties.stream().forEach(propertyName -> {
      String methodName = getterFromProperty(propertyName);
      try {
        Method method = clazz.getMethod(methodName);
        Object methodResult = method.invoke(enumValue);
        map.put(propertyName, methodResult);
      } catch (Exception e) {
        // ... error logging
      }
    });

    return map;
  });
}

/**
* Return the "standard" property getter of a property. e.g. "example" will
* return "getExample"
* 
* @param property
* @return property getter method name
*/
private String getterFromProperty(String property) {
  return "get" + property.substring(0, 1).toUpperCase() + property.substring(1);
}

Answer 1

Обычный подход к этому - либо использование аннотации @JsonFormat(shape = JsonFormat.Shape.OBJECT), либо использование настраиваемого сериализатора.

Допустим, вы ссылаетесь на перечисление из класса A

class A {

   @JsonFormat(shape = JsonFormat.Shape.OBJECT)
   private Colors color;

}

это сделает цвет сериализованным так, как вы хотите.

В качестве альтернативы можно зарегистрировать пользовательский сериализатор для вашего Enum, это можно сделать следующим образом:

public class ColorSerializer extends StdSerializer {

    public ColorSerializer() {
        super(Color.class);
    }

    public ColorSerializer(Class t) {
        super(t);
    }

    public void serialize(Color color, JsonGenerator generator,
      SerializerProvider provider) 
      throws IOException, JsonProcessingException {
        generator.writeStartObject();
        generator.writeFieldName("code");
        generator.writeString(color.getCode());
        generator.writeFieldName("hexCode");
        generator.writeString(color.getHexcode());
        generator.writeFieldName("isAwsome");
        generator.writeNumber(color.isAwsome());
        generator.writeEndObject();
    }
}

Поскольку ваши перечисления являются внешними, вы всегда можете поместить их в оболочки, которые являются внутренними для вашего проекта, и таким образом контролировать процесс их сериализации.

Если вы хотите сериализовать их, используя ту же стратегию, вы можете поместить свой код отражения в сериализатор. Таким образом, вы получите один универсальный сериализатор вместо записи для каждого перечисления.

Вот как вы можете зарегистрировать пользовательский сериализатор:

ObjectMapper mapper = new ObjectMapper();

SimpleModule module = new SimpleModule();
module.addSerializer(Color.class, new ColorSerializer ());
mapper.registerModule(module);