Использование Enums при разборе JSON с помощью GSON

Это связано с предыдущим вопросом, который я задал здесь ранее

Разбор JSON с использованием Gson

Я пытаюсь разобрать тот же JSON, но теперь я немного изменил свои классы.

{
    "lower": 20,
    "upper": 40,
    "delimiter": " ",
    "scope": ["${title}"]
}

Теперь мой класс выглядит следующим образом:

public class TruncateElement {

   private int lower;
   private int upper;
   private String delimiter;
   private List<AttributeScope> scope;

   // getters and setters
}


public enum AttributeScope {

    TITLE("${title}"),
    DESCRIPTION("${description}"),

    private String scope;

    AttributeScope(String scope) {
        this.scope = scope;
    }

    public String getScope() {
        return this.scope;
    }
}

Этот код генерирует исключение,

com.google.gson.JsonParseException: The JsonDeserializer EnumTypeAdapter failed to deserialized json object "${title}" given the type class com.amazon.seo.attribute.template.parse.data.AttributeScope
at 

Исключение понятно, потому что, согласно решению моего предыдущего вопроса, GSON ожидает, что объекты Enum будут фактически созданы как

${title}("${title}"),
${description}("${description}");

Но так как это синтаксически невозможно, какие рекомендуемые решения, обходные пути?

Ответ 1

Из документация для Gson:

Gson предоставляет сериализацию и десериализацию по умолчанию для Enums... Если вы предпочитаете изменять представление по умолчанию, вы можете сделать это, зарегистрировав адаптер типа через GsonBuilder.registerTypeAdapter(Тип, Объект).

Ниже приведен один такой подход.

import java.io.FileReader;
import java.lang.reflect.Type;
import java.util.List;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonDeserializationContext;
import com.google.gson.JsonDeserializer;
import com.google.gson.JsonElement;
import com.google.gson.JsonParseException;

public class GsonFoo
{
  public static void main(String[] args) throws Exception
  {
    GsonBuilder gsonBuilder = new GsonBuilder();
    gsonBuilder.registerTypeAdapter(AttributeScope.class, new AttributeScopeDeserializer());
    Gson gson = gsonBuilder.create();

    TruncateElement element = gson.fromJson(new FileReader("input.json"), TruncateElement.class);

    System.out.println(element.lower);
    System.out.println(element.upper);
    System.out.println(element.delimiter);
    System.out.println(element.scope.get(0));
  }
}

class AttributeScopeDeserializer implements JsonDeserializer<AttributeScope>
{
  @Override
  public AttributeScope deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context)
      throws JsonParseException
  {
    AttributeScope[] scopes = AttributeScope.values();
    for (AttributeScope scope : scopes)
    {
      if (scope.scope.equals(json.getAsString()))
        return scope;
    }
    return null;
  }
}

class TruncateElement
{
  int lower;
  int upper;
  String delimiter;
  List<AttributeScope> scope;
}

enum AttributeScope
{
  TITLE("${title}"), DESCRIPTION("${description}");

  String scope;

  AttributeScope(String scope)
  {
    this.scope = scope;
  }
}

Ответ 2

Я хочу немного раскрыть ответ NAZIK/user2724653 (для моего случая). Вот код Java:

public class Item {
    @SerializedName("status")
    private Status currentState = null;

    // other fields, getters, setters, constructor and other code...

    public enum Status {
        @SerializedName("0")
        BUY,
        @SerializedName("1")
        DOWNLOAD,
        @SerializedName("2")
        DOWNLOADING,
        @SerializedName("3")
        OPEN
     }
}

в json файле у вас есть только поле "status": "N",, где N = 0,1,2,3 - зависит от значений состояния. Итак, все, GSON отлично работает со значениями для вложенного класса enum. В моем случае я проанализировал список массива Items из json:

List<Item> items = new Gson().<List<Item>>fromJson(json,
                                          new TypeToken<List<Item>>(){}.getType());

Ответ 3

Использовать аннотацию @SerializedName:

@SerializedName("${title}")
TITLE,
@SerializedName("${description}")
DESCRIPTION

Ответ 4

С GSON версии 2.2.2 перечисление будет легко сортироваться и без проблем.

import com.google.gson.annotations.SerializedName;

enum AttributeScope
{
  @SerializedName("${title}")
  TITLE("${title}"),

  @SerializedName("${description}")
  DESCRIPTION("${description}");

  private String scope;

  AttributeScope(String scope)
  {
    this.scope = scope;
  }

  public String getScope() {
    return scope;
  }
}

Ответ 5

Следующий фрагмент устраняет необходимость в явном Gson.registerTypeAdapter(...), используя аннотацию @JsonAdapter(class), доступную с Gson 2.3 (см. комментарий pm_labs).

@JsonAdapter(Level.Serializer.class)
public enum Level {
    WTF(0),
    ERROR(1),
    WARNING(2),
    INFO(3),
    DEBUG(4),
    VERBOSE(5);

    int levelCode;

    Level(int levelCode) {
        this.levelCode = levelCode;
    }

    static Level getLevelByCode(int levelCode) {
        for (Level level : values())
            if (level.levelCode == levelCode) return level;
        return INFO;
    }

    static class Serializer implements JsonSerializer<Level>, JsonDeserializer<Level> {
        @Override
        public JsonElement serialize(Level src, Type typeOfSrc, JsonSerializationContext context) {
            return context.serialize(src.levelCode);
        }

        @Override
        public Level deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) {
            try {
                return getLevelByCode(json.getAsNumber().intValue());
            } catch (JsonParseException e) {
                return INFO;
            }
        }
    }
}

Ответ 6

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

  открытый класс EnumTypeAdapter < T extends Enum <T> > расширяет TypeAdapter <T> {   частная конечная Карта < Целое число, T > nameToConstant = new HashMap >();   частная конечная карта < T, Integer > constantToName = new HashMap <>();
   public EnumTypeAdapter (класс <T> classOfT) {       for (T constant: classOfT.getEnumConstants()) {           Integer name = constant.ordinal();           nameToConstant.put(имя, константа);           constantToName.put(константа, имя);       }   }   @Override public T read (JsonReader in) бросает IOException {       if (in.peek() == JsonToken.NULL) {           in.nextNull();           return null;       }       return nameToConstant.get(in.nextInt());   }
   @Override public void write (JsonWriter out, значение T) выдает IOException {       out.value(value == null? null: constantToName.get(значение));   }
   public static final TypeAdapterFactory ENUM_FACTORY = новый TypeAdapterFactory() {       @SuppressWarnings ({ "rawtypes", "unchecked" })       @Override public <T> TypeAdapter < Т > create (Gson gson, TypeToken <T> typeToken) {           Класс <? супер T > rawType = typeToken.getRawType();           if (! Enum.class.isAssignableFrom(rawType) || rawType == Enum.class) {               return null;           }           if (! rawType.isEnum()) {               rawType = rawType.getSuperclass();//обрабатывать анонимные подклассы           }           return (TypeAdapter <T>) новый EnumTypeAdapter (rawType);       }   };
}
Код>

Затем просто зарегистрируйте factory.

  Gson gson = new GsonBuilder()              .registerTypeAdapterFactory(EnumTypeAdapter.ENUM_FACTORY)              .Создайте();
Код>

Ответ 7

использовать этот метод

GsonBuilder.enableComplexMapKeySerialization();