为什么Gson fromJson抛出JsonSyntaxException：应该是BEGIN_对象，但却是BEGIN_数组？

Question

（这篇文章是一个典型的问题，下面提供了一个示例答案。）

我正试图用Gson#fromJson（String，Class）将一些JSON内容反序列化为自定义POJO类型。

这段代码

import com.google.gson.Gson;

public class Sample {
    public static void main(String[] args) {
        String json = "{\"nestedPojo\":[{\"name\":null, \"value\":42}]}";
        Gson gson = new Gson();
        gson.fromJson(json, Pojo.class);
    }
}

class Pojo {
    NestedPojo nestedPojo;
}

class NestedPojo {
    String name;
    int value;
}

抛出以下异常

Exception in thread "main" com.google.gson.JsonSyntaxException: java.lang.IllegalStateException: Expected BEGIN_OBJECT but was BEGIN_ARRAY at line 1 column 16 path $.nestedPojo
    at com.google.gson.internal.bind.ReflectiveTypeAdapterFactory$Adapter.read(ReflectiveTypeAdapterFactory.java:200)
    at com.google.gson.internal.bind.ReflectiveTypeAdapterFactory$1.read(ReflectiveTypeAdapterFactory.java:103)
    at com.google.gson.internal.bind.ReflectiveTypeAdapterFactory$Adapter.read(ReflectiveTypeAdapterFactory.java:196)
    at com.google.gson.Gson.fromJson(Gson.java:810)
    at com.google.gson.Gson.fromJson(Gson.java:775)
    at com.google.gson.Gson.fromJson(Gson.java:724)
    at com.google.gson.Gson.fromJson(Gson.java:696)
    at com.example.Sample.main(Sample.java:23)
Caused by: java.lang.IllegalStateException: Expected BEGIN_OBJECT but was BEGIN_ARRAY at line 1 column 16 path $.nestedPojo
    at com.google.gson.stream.JsonReader.beginObject(JsonReader.java:387)
    at com.google.gson.internal.bind.ReflectiveTypeAdapterFactory$Adapter.read(ReflectiveTypeAdapterFactory.java:189)
    ... 7 more

为什么Gson不能正确地将JSON文本转换为POJO类型？

Answer 1

class Pojo {
  NestedPojo nestedPojo;
}

在json中有一个nestedPojo数组，因此要么更改代码

  NestedPojo[] nestedPojo;

或者更改json字符串

String json = "{\"nestedPojo\":{\"name\":null, \"value\":42}}";

Answer 2

正如异常消息所述

Caused by: java.lang.IllegalStateException: Expected BEGIN_OBJECT but was BEGIN_ARRAY at line 1 column 16 path $.nestedPojo

在反序列化时，Gson需要一个JSON对象，但找到了一个JSON数组。因为它无法从一个转换到另一个，所以抛出了这个异常。

这里描述了JSON格式。简而言之，它定义了以下类型：对象、数组、字符串、数字、null，以及布尔值true和false。

在Gson（以及大多数JSON解析器）中，存在以下映射：一个JSON字符串映射到一个Java字符串；JSON编号映射到Java编号类型；JSON数组映射到集合类型或数组类型；JSON对象映射到JavaMap类型，或者通常映射到自定义POJO类型（前面没有提到）null映射到Java的null，布尔值映射到Java的true和false。

Gson遍历您提供的JSON内容，并尝试将其反序列化为您请求的相应类型。如果内容不匹配或无法转换为预期类型，它将抛出相应的异常。

在您的案例中，您提供了以下JSON

{
    "nestedPojo": [
        {
            "name": null,
            "value": 42
        }
    ]
}

从根本上说，这是一个JSON对象，它包含一个名为nestedPojo的成员，这是一个JSON数组。该JSON数组包含一个元素，另一个JSON对象有两个成员。考虑到前面定义的映射，您可能希望这个JSON映射到一个Java对象，该对象具有一个名为nestedPojo的字段，该字段的名称是集合或数组类型，其中该类型分别定义了两个字段，分别名为name和value。

但是，您已经将Pojo类型定义为具有字段

NestedPojo nestedPojo;

这既不是数组类型，也不是集合类型。Gson无法反序列化此字段对应的JSON。

相反，你有3个选择：

>

{
    "nestedPojo": {
        "name": null,
        "value": 42
    }
}

将您的Pojo类型更改为集合或数组类型

List<NestedPojo> nestedPojo; // consider changing the name and using @SerializedName
NestedPojo[] nestedPojo;

使用您自己的解析规则为NestedPojo编写并注册一个自定义反序列化器

class Custom implements JsonDeserializer<NestedPojo> {
    @Override
    public NestedPojo deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) throws JsonParseException {
        NestedPojo nestedPojo = new NestedPojo();
        JsonArray jsonArray = json.getAsJsonArray();
        if (jsonArray.size() != 1) {
            throw new IllegalStateException("unexpected json");
        }
        JsonObject jsonObject = jsonArray.get(0).getAsJsonObject(); // get only element
        JsonElement jsonElement = jsonObject.get("name");
        if (!jsonElement.isJsonNull()) {
            nestedPojo.name = jsonElement.getAsString();
        }
        nestedPojo.value = jsonObject.get("value").getAsInt();
        return nestedPojo;
    }
}

Gson gson = new GsonBuilder().registerTypeAdapter(NestedPojo.class, new Custom()).create();