使用改造使用 GSON 获取嵌套的 JSON 对象

2022-08-31 09:16:45

我正在使用来自我的Android应用程序的API,所有JSON响应都是这样的:

{
    'status': 'OK',
    'reason': 'Everything was fine',
    'content': {
         < some data here >
}

问题是我所有的POJO都有一个,字段,而字段内部是我想要的真正POJO。statusreasoncontent

有没有办法创建Gson的自定义转换器来始终提取字段,因此改造返回适当的POJO?content


答案 1

您将编写一个返回嵌入对象的自定义反序列化程序。

假设您的 JSON 是:

{
    "status":"OK",
    "reason":"some reason",
    "content" : 
    {
        "foo": 123,
        "bar": "some value"
    }
}

然后你会有一个POJO:Content

class Content
{
    public int foo;
    public String bar;
}

然后编写一个反序列化程序:

class MyDeserializer implements JsonDeserializer<Content>
{
    @Override
    public Content deserialize(JsonElement je, Type type, JsonDeserializationContext jdc)
        throws JsonParseException
    {
        // Get the "content" element from the parsed JSON
        JsonElement content = je.getAsJsonObject().get("content");

        // Deserialize it. You use a new instance of Gson to avoid infinite recursion
        // to this deserializer
        return new Gson().fromJson(content, Content.class);

    }
}

现在,如果您构造一个 with 并注册反序列化程序:GsonGsonBuilder

Gson gson = 
    new GsonBuilder()
        .registerTypeAdapter(Content.class, new MyDeserializer())
        .create();

您可以将 JSON 直接反序列化为 :Content

Content c = gson.fromJson(myJson, Content.class);

编辑以从评论中添加:

如果您有不同类型的消息,但它们都有“内容”字段,则可以通过执行以下操作使反序列化程序成为通用的:

class MyDeserializer<T> implements JsonDeserializer<T>
{
    @Override
    public T deserialize(JsonElement je, Type type, JsonDeserializationContext jdc)
        throws JsonParseException
    {
        // Get the "content" element from the parsed JSON
        JsonElement content = je.getAsJsonObject().get("content");

        // Deserialize it. You use a new instance of Gson to avoid infinite recursion
        // to this deserializer
        return new Gson().fromJson(content, type);

    }
}

您只需为每个类型注册一个实例:

Gson gson = 
    new GsonBuilder()
        .registerTypeAdapter(Content.class, new MyDeserializer<Content>())
        .registerTypeAdapter(DiffContent.class, new MyDeserializer<DiffContent>())
        .create();

调用时,该类型将传递到反序列化程序中,因此它应该适用于所有类型。.fromJson()

最后,在创建改造实例时:

Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(url)
                .addConverterFactory(GsonConverterFactory.create(gson))
                .build();

答案 2

@BrianRoach的解决方案是正确的解决方案。值得注意的是,在嵌套了自定义对象的特殊情况下,两者都需要自定义,则必须向GSON的新实例注册,否则永远不会调用第二个。这是因为我们正在自定义反序列化程序中创建新实例。TypeAdapterTypeAdapterTypeAdapterGson

例如,如果您有以下 json:

{
    "status": "OK",
    "reason": "some reason",
    "content": {
        "foo": 123,
        "bar": "some value",
        "subcontent": {
            "useless": "field",
            "data": {
                "baz": "values"
            }
        }
    }
}

您希望将此 JSON 映射到以下对象:

class MainContent
{
    public int foo;
    public String bar;
    public SubContent subcontent;
}

class SubContent
{
    public String baz;
}

您需要注册 的 .为了更加可靠,您可以执行以下操作:SubContentTypeAdapter

public class MyDeserializer<T> implements JsonDeserializer<T> {
    private final Class mNestedClazz;
    private final Object mNestedDeserializer;

    public MyDeserializer(Class nestedClazz, Object nestedDeserializer) {
        mNestedClazz = nestedClazz;
        mNestedDeserializer = nestedDeserializer;
    }

    @Override
    public T deserialize(JsonElement je, Type type, JsonDeserializationContext jdc) throws JsonParseException {
        // Get the "content" element from the parsed JSON
        JsonElement content = je.getAsJsonObject().get("content");

        // Deserialize it. You use a new instance of Gson to avoid infinite recursion
        // to this deserializer
        GsonBuilder builder = new GsonBuilder();
        if (mNestedClazz != null && mNestedDeserializer != null) {
            builder.registerTypeAdapter(mNestedClazz, mNestedDeserializer);
        }
        return builder.create().fromJson(content, type);

    }
}

然后像这样创建它:

MyDeserializer<Content> myDeserializer = new MyDeserializer<Content>(SubContent.class,
                    new SubContentDeserializer());
Gson gson = new GsonBuilder().registerTypeAdapter(Content.class, myDeserializer).create();

这也可以通过简单地传入具有 null 值的新实例,轻松地将其用于嵌套的“内容”情况。MyDeserializer