Gson反序列化泛型类型适配器的基类
Posted
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Gson反序列化泛型类型适配器的基类相关的知识，希望对你有一定的参考价值。
我有以下课程：
public class Kit {
private String name;
private int num;
}
我有一个类，它扩展了Kit以及其他功能：
public class ExtendedKit extends Kit {
private String extraProperty;
}
使用Gson，我希望能够对这两个类以及更多不同类型进行反序列化，而无需为它们创建一堆类型适配器，因为它们都具有相同的Json结构：
{
"type": "com.driima.test.ExtendedKit",
"properties": {
"name": "An Extended Kit",
"num": 124,
"extra_property": "An extra property"
}
}
哪个传递给注册到我的GsonBuilder的以下类型适配器：
public class GenericAdapter<T> implements JsonDeserializer<T> {
@Override
public T deserialize(JsonElement json, Type type, JsonDeserializationContext context) throws JsonParseException {
final JsonObject object = json.getAsJsonObject();
String classType = object.get("type").getAsString();
JsonElement element = object.get("properties");
try {
return context.deserialize(element, Class.forName(classType));
} catch (ClassNotFoundException e) {
throw new JsonParseException("Unknown element type: " + type, e);
}
}
}
事情是，这适用于ExtendedKit，但是如果我想反序列化Kit而没有extraProperty，它就不起作用，因为当它试图在属性对象上调用context.deserialize（）时它调用会导致NullPointerException。有什么方法可以解决这个问题吗？
这是我正在使用的GsonBuilder的代码：
private static final GsonBuilder GSON_BUILDER = new GsonBuilder()
.setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES)
.registerTypeAdapterFactory(new PostProcessExecutor())
.registerTypeAdapter(Kit.class, new GenericAdapter<Kit>());
注意：添加了PostProcessExecutor，以便我可以对我可以进行后处理的反序列化的任何对象应用后处理。有一篇文章here帮助我实现了这个功能。
答案
我不认为JsonDeserializer在这里是个不错的选择：
- 你需要将每种类型绑定到
Gson中的GsonBuilder实例，这是一种容易出错的问题，或者使用registerTypeHierarchyAdapter。 - 对于后者，你会遇到无限递归（如果我没错：因为上下文只提供了反序列化相同类型实例的机制）。
以下类型的适配器工厂可以克服上述限制：
final class PolymorphicTypeAdapterFactory
implements TypeAdapterFactory {
// Let's not hard-code `Kit.class` here and let a user pick up types at a call-site
private final Predicate<? super Class<?>> predicate;
private PolymorphicTypeAdapterFactory(final Predicate<? super Class<?>> predicate) {
this.predicate = predicate;
}
static TypeAdapterFactory get(final Predicate<? super Class<?>> predicate) {
return new PolymorphicTypeAdapterFactory(predicate);
}
@Override
public <T> TypeAdapter<T> create(final Gson gson, final TypeToken<T> typeToken) {
final Class<? super T> rawClass = typeToken.getRawType();
if ( !predicate.test(rawClass) ) {
// Something we cannot handle? Try pick the next best type adapter factory
return null;
}
// This is what JsonDeserializer fails at:
final TypeAdapter<T> writeTypeAdapter = gson.getDelegateAdapter(this, typeToken);
// Despite it's possible to use the above type adapter for both read and write, what if the `type` property points to another class?
final Function<? super Class<T>, ? extends TypeAdapter<T>> readTypeAdapterResolver = actualRawClass -> {
if ( !rawClass.isAssignableFrom(actualRawClass) ) {
throw new IllegalStateException("Cannot parse as " + actualRawClass);
}
return gson.getDelegateAdapter(this, TypeToken.get(actualRawClass));
};
return PolymorphicTypeAdapter.get(rawClass, writeTypeAdapter, readTypeAdapterResolver);
}
private static final class PolymorphicTypeAdapter<T>
extends TypeAdapter<T> {
private final Class<? super T> rawClass;
private final TypeAdapter<T> writeTypeAdapter;
private final Function<? super Class<T>, ? extends TypeAdapter<T>> readTypeAdapterResolver;
private PolymorphicTypeAdapter(final Class<? super T> rawClass, final TypeAdapter<T> writeTypeAdapter,
final Function<? super Class<T>, ? extends TypeAdapter<T>> readTypeAdapterResolver) {
this.rawClass = rawClass;
this.writeTypeAdapter = writeTypeAdapter;
this.readTypeAdapterResolver = readTypeAdapterResolver;
}
// Since constructors are meant only to assign parameters to fields, encapsulate the null-safety handling in the factory method
private static <T> TypeAdapter<T> get(final Class<? super T> rawClass, final TypeAdapter<T> writeTypeAdapter,
final Function<? super Class<T>, ? extends TypeAdapter<T>> readTypeAdapterResolver) {
return new PolymorphicTypeAdapter<>(rawClass, writeTypeAdapter, readTypeAdapterResolver)
.nullSafe();
}
@Override
@SuppressWarnings("resource")
public void write(final JsonWriter jsonWriter, final T value)
throws IOException {
jsonWriter.beginObject();
jsonWriter.name("type");
jsonWriter.value(rawClass.getName());
jsonWriter.name("properties");
writeTypeAdapter.write(jsonWriter, value);
jsonWriter.endObject();
}
@Override
public T read(final JsonReader jsonReader)
throws IOException {
jsonReader.beginObject();
// For simplicity's sake, let's assume that the class property `type` always precedes the `properties` property
final Class<? super T> actualRawClass = readActualRawClass(jsonReader);
final T value = readValue(jsonReader, actualRawClass);
jsonReader.endObject();
return value;
}
private Class<? super T> readActualRawClass(final JsonReader jsonReader)
throws IOException {
try {
requireProperty(jsonReader, "type");
final String value = jsonReader.nextString();
@SuppressWarnings("unchecked")
final Class<? super T> actualRawClass = (Class<? super T>) Class.forName(value);
return actualRawClass;
} catch ( final ClassNotFoundException ex ) {
throw new AssertionError(ex);
}
}
private T readValue(final JsonReader jsonReader, final Class<? super T> rawClass)
throws IOException {
requireProperty(jsonReader, "properties");
@SuppressWarnings("unchecked")
final Class<T> castRawClass = (Class<T>) rawClass;
final TypeAdapter<T> readTypeAdapter = readTypeAdapterResolver.apply(castRawClass);
return readTypeAdapter.read(jsonReader);
}
private static void requireProperty(final JsonReader jsonReader, final String propertyName)
throws IOException {
final String name = jsonReader.nextName();
if ( !name.equals(propertyName) ) {
throw new JsonParseException("Unexpected property: " + name);
}
}
}
}
仅用于Kit类的使用示例（下面的方法参考仅检查Kit是否是给定实际原始类的超类，或者后者是Kit本身）：
private static final Gson gson = new GsonBuilder()
.setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES)
.registerTypeAdapterFactory(PolymorphicTypeAdapterFactory.get(Kit.class::isAssignableFrom))
.create();
请注意，你的问题不是唯一的，你的情况几乎用RuntimeTypeAdapterFactory覆盖，但RuntimeTypeAdapterFactory不会像你的例子那样隔离type和properties。
附：请注意，这种类型的适配器工厂远不是真正的通用：它不适用于类型（类是类型的特殊情况），泛型类型等。如果感兴趣，但当然不是过度工程，你可能会喜欢使用Type实例object serialization mechanism（太神秘且紧密绑定到特定平台）或使用类型和泛型类型符号parsing using JParsec（两个链接指俄语StackExchange站点）引用我的参数化编码类型的解决方案。
另一答案
我认为你的适配器中的一个问题是它实际上从来没有为ExtendedKit调用Kit。所以这就是为什么它与ExtendedKit合作，我想。由于类型擦除，Gson无论如何都无法默认处理泛型。
尽管如此：正如Json所呈现的那样，声明要反序列化的对象是一种良好而明确的做法，因为它通常会减少适配器逻辑的编码等...
我建议您为Kit声明一个包装类，如：
@Getter
@AllArgsConstructor
public class KitWrapper {
private String type;
@SerializedName("properties") //
private Kit kit;
}
使用TypeAdapter更容易反序列化：
@Slf4j
public class KitWrapperAdapter implements JsonDeserializer<KitWrapper> {
@Override
public KitWrapper deserialize(JsonElement json, Type typeOfT,
JsonDeserializationContext context)
throws JsonParseException {
try {
@SuppressWarnings("unchecked")
Class<? extends Kit> classKit =
(Class<? extends Kit>)Class.forName(json.getAsJsonObject()
.get("type").getAsString() );
JsonElement jeProperties = json.getAsJsonObject().get("properties");
Kit kit = context.deserialize(jeProperties, classKit);
// Not needed to par以上是关于Gson反序列化泛型类型适配器的基类的主要内容，如果未能解决你的问题，请参考以下文章
Android:Gson通过借助TypeToken获取泛型参数的类型的方法
解决GSON转Long型变为科学计数法或整形变double的问题(自动转换成Double类型