Gson反序列化接口到它的类实现

Question

我使用Retrofit 2.1.0与转换器gson:2.1.0和单独gson:2.6.2，以便自定义序列化/反序列化。问题是我的pojo应该隐藏在接口后面，我想告诉Gson哪个类应该是反序列化的接口。在反序列化/序列化之后，Retrofit应该能够返回接口。如果我能利用泛型并轻松创建一种方法来告诉Gson或Retrofit将FooInterface序列化/反序列化为FooClass，那将是很好的。

Answer 1

我假设您希望为所有接口及其各自的实现创建一个反序列化器。请按照以下步骤操作:

1。创建一个基接口，它将被你的其他应用接口扩展。需要为所有的接口和实现类创建一个反序列化器。

public interface Convertable {
     String getClassName();
}

2。创建特性接口和实现类。作为一个例子，我们将它们命名为FooInterface和FooClass。FooInterface应该扩展Convertable接口

FooInterface

public interface FooInterface extends Convertable {
}

FooClass

public class FooClass implements FooInterface {
    // DISCRIMINATOR FIELD
    private final String className;
    private String field1;
    private String field2;
    public FooClass() {
        this.className = getClass().getName();
    }
    public String getClassName() {
        return className;
    }
    public String getField1() {
        return field1;
    }
    public void setField1(String field1) {
        this.field1 = field1;
    }
    public String getField2() {
        return field2;
    }
    public void setField2(String field2) {
        this.field2 = field2;
    }
}

注意getClassName()返回的值被用作Gson反序列化器(下一步)中初始化可返回实例的标识符字段。我假设您的序列化器和反序列化器类将驻留在同一个包中，即使它们位于不同的客户机和服务器应用程序中。如果没有，那么您需要更改getClassInstance()实现，但这样做非常简单。

3。为您的所有应用程序实现自定义Gson序列化器

import com.google.gson.JsonDeserializationContext;
import com.google.gson.JsonDeserializer;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonParseException;
import com.google.gson.JsonPrimitive;
public class ConvertableDeserializer<T extends Convertable> implements JsonDeserializer<T> {
    private static final String CLASSNAME = "className";
    public T deserialize(final JsonElement jsonElement, final Type type,
                         final JsonDeserializationContext deserializationContext
                        ) throws JsonParseException {
        final JsonObject jsonObject = jsonElement.getAsJsonObject();
        final JsonPrimitive prim = (JsonPrimitive) jsonObject.get(CLASSNAME);
        final String className = prim.getAsString();
        final Class<T> clazz = getClassInstance(className);
        return deserializationContext.deserialize(jsonObject, clazz);
    }
    @SuppressWarnings("unchecked")
    public Class<T> getClassInstance(String className) {
        try {
            return (Class<T>) Class.forName(className);
        } catch (ClassNotFoundException cnfe) {
            throw new JsonParseException(cnfe.getMessage());
        }
    }
}

4。用Gson注册反序列化器并初始化改造

 private static GsonConverterFactory buildGsonConverter() {
        final GsonBuilder builder = new GsonBuilder();
        // Adding custom deserializers
        builder.registerTypeAdapter(FooInterface.class, 
                                    new ConvertableDeserializer<FooInterface>());
        final Gson gson = builder.create();
        return GsonConverterFactory.create(myGson);
    }

    public void initRetrofit() {
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("REST_ENDPOINT")
                .addConverterFactory(buildGsonConverter())
                .client(httpClient)
                .build();
    }

如果你愿意，你可以为你所有的实现注册适配器，使用:

builder.registerTypeAdapter(Convertable.class, new ConvertableDeserializer<Convertable>());

Answer 2

因为您愿意花费精力使用接口来几乎复制您的整个域层，以隐藏模型的实现细节，我认为您会发现我的答案令人耳目一新;)

你应该使用AutoValue来隐藏模型中的任何实现细节。它的工作方式非常简单:

你写一个抽象类，然后AutoValue实现它。就这些这是对的;没有配置。

采用这种方法，您将不需要创建如此多的样板文件。

还有这个自动值扩展名为auto-value-gson，它增加了对Gson De/Serializer的开箱即用支持。

通过这些简单的步骤，我认为你的代码库将大大提高。