Gson将接口反序列化为其Class实现

时间:2016-06-28 08:56:48

标签: java android gson retrofit2

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

2 个答案:

答案 0 :(得分:12)

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

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 Serializer

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>());

答案 1 :(得分:4)

因为您愿意使用接口来隐藏模型的实现细节,所以我愿意努力几乎复制您的整个域图层,我想您会找到我的答案刷新;)

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

  

您编写了一个抽象类,AutoValue实现了它。就这些   有它;实际上没有任何配置。

采用这种方法,您不需要创建大量的样板。

还有一个名为auto-value-gson的AutoValue扩展,它可以添加Gson De / Serializer支持。

通过这些简单的步骤,我认为您的代码库将大大改善。