Gson反序列化多态成员List变量为null答案

【问题标题】：Gson deserialize polymorphic member List variable is nullGson反序列化多态成员List变量为null
【发布时间】：2016-08-19 13:43:31
【问题描述】：

以下是问题域的类图。我们有不同语义的 JSON 解码消息，这些消息会触发代码中针对不同视图的不同方法（初始化、更新）。

Message 被反序列化为InitMessage 或DataMessage，使用建议的解决方案here 使用RuntimeTypeAdapterFactory 并注册所有可能的子类型。但是，DataMessage.value 列表为空（未反序列化）。问题在于DataMessage 中的嵌套多态成员。

适配器工厂：

RuntimeTypeAdapterFactory<Message> messageAdapterFactory = RuntimeTypeAdapterFactory
     .of(Message.class, "MESSAGE_TYPE")
     .registerSubtype(InitializationMessage.class, "INIT")
     .registerSubtype(DataMessage.class, "DATA");

RuntimeTypeAdapterFactory<DataValue> dataAdapterFactory = RuntimeTypeAdapterFactory
    .of(DataValue.class, "NAME")
    .registerSubtype(DataValueA.class, "A")
    .registerSubtype(DataValueB.class, "B")
    .registerSubtype(DataValueC.class, "C");

消息的创建：

TypeToken<Message> typeToken = new TypeToken<Message>() {};
Message msg = gson.fromJson(json, typeToken.getType());

DataMessage 类：

public class DataMessage extends Message {

  private List<DataValue> value;

  public List<DataValue> getValue() {
    return value;
  }

  public void setValue(List<DataValue> value) {
    this.value= value;
  }
}

DataValueA 类：

public class DataValueA extends DataValue {

  private Map<String, Float> value;

  public float getValue(String location) {
    return value.get(location);
  }
}

对应的JSON：

{
    "MESSAGE_TYPE" : "DATA",
    "VALUE" : [
    {
        "NAME"  : "C",
        "VALUE" : 1.3
    },
    {
        "NAME" : "A",
        "VALUE" : {
            "FL" : 18.4,
            "FR" : 18.4,
            "RL" : 18.4,
            "RR" : 18.4
        }
    }]
}

我希望将 DataValue 反序列化为它们各自的子类 (DataValueA ...)。

【问题讨论】：

为Message 编写一个JsonDeserializer，它创建了正确的子类并通过context.<DataValue>deserialize(dataObject, DataValue.class) 委托进一步反序列化，这使我能够使用多态数据反序列化多态消息。但是，我完全失去了RuntimeTypeAdapterFactory 提供的数据绑定代码的可读性和可维护性的优势。

标签： java json polymorphism gson deserialization

【解决方案1】：

一种解决方案是使用GsonBuilder.registerTypeAdapter 方法注册自定义JsonDeserializer。方法是使用消息中的字段来定义将创建哪个子类（就像RuntimeTypeAdapterFactory 默认情况下不提供并存在于gson-extra 中一样）。

将为每个抽象超类注册反序列化器。

gson = new GsonBuilder()
  .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES)
  .registerTypeAdapter(Message.class, new MessageAdapter())
  .registerTypeAdapter(DataValue.class, new DataValueAdapter())
  .create();

给定区分子类型的字段名为NAME，您可以定义反序列化函数如下。存在从字段内容到相应子类的映射。

public class DataValueAdapter implements JsonDeserializer<DataValue> {
  private final static Map<String, Class<?>> FieldToClass;

  static {
    FieldToClass = new HashMap<>();
    FieldToClass.put("PERFORMANCE", PerformanceDataValue.class);
    FieldToClass.put("TIRE_SLIP", TireSlipDataValue.class);
  }

  @Override
  public DataValue deserialize(JsonElement json, Type typeOfT,
                               JsonDeserializationContext context) throws JsonParseException {
    JsonObject jsonObject = json.getAsJsonObject();
    String dataType = jsonObject.get("NAME").getAsString();
    return context.deserialize(json, FieldToClass.get(dataType));
  }
}

为了使反射反序列化器（只要您对标准反序列化器没问题，它将用于子类）工作，子类需要在属性中声明@SerializedName。没有它对我不起作用。

【讨论】：