Google Gson-反序列化list <class>对象?(通用类型)


440

我想通过Google Gson传输列表对象,但是我不知道如何反序列化泛型类型。

在查看此内容后我尝试了什么(BalusC的答案):

MyClass mc = new Gson().fromJson(result, new List<MyClass>(){}.getClass());

但是然后我在日食中遇到了一个错误,说“新的List(){}类型必须实现继承的抽象方法...”,如果我使用快速修复方法,则会得到20个以上的方法存根的怪物。

我很确定有一个更简单的解决方案,但是我似乎找不到它!

编辑:

我现在有

Type listType = new TypeToken<List<MyClass>>()
                {
                }.getType();

MyClass mc = new Gson().fromJson(result, listType);

但是,在“ fromJson”行中确实得到以下异常:

java.lang.NullPointerException
at org.apache.harmony.luni.lang.reflect.ListOfTypes.length(ListOfTypes.java:47)
at org.apache.harmony.luni.lang.reflect.ImplForType.toString(ImplForType.java:83)
at java.lang.StringBuilder.append(StringBuilder.java:203)
at com.google.gson.JsonDeserializerExceptionWrapper.deserialize(JsonDeserializerExceptionWrapper.java:56)
at com.google.gson.JsonDeserializationVisitor.invokeCustomDeserializer(JsonDeserializationVisitor.java:88)
at com.google.gson.JsonDeserializationVisitor.visitUsingCustomHandler(JsonDeserializationVisitor.java:76)
at com.google.gson.ObjectNavigator.accept(ObjectNavigator.java:106)
at com.google.gson.JsonDeserializationContextDefault.fromJsonArray(JsonDeserializationContextDefault.java:64)
at com.google.gson.JsonDeserializationContextDefault.deserialize(JsonDeserializationContextDefault.java:49)
at com.google.gson.Gson.fromJson(Gson.java:568)
at com.google.gson.Gson.fromJson(Gson.java:515)
at com.google.gson.Gson.fromJson(Gson.java:484)
at com.google.gson.Gson.fromJson(Gson.java:434)

确实捕获到JsonParseExceptions并且“结果”不为null。

我用调试器检查了listType并得到了以下内容:

  • 清单类型
    • args = ListOfTypes
      • 列表=空
      • resolveTypes =类型[1]
    • 加载程序= PathClassLoader
    • ownerType0 =空
    • ownerTypeRes = null
    • rawType =类(java.util.ArrayList)
    • rawTypeName =“ java.util.ArrayList”

因此似乎“ getClass”调用无法正常工作。有什么建议么...?

Edit2:我检查了Gson用户指南。它提到了在将通用类型解析为Json期间应该发生的运行时异常。就像在示例中一样,我做到了“错误”(上面没有显示),但根本没有得到该异常。因此,我按照用户指南中的建议更改了序列化。不过没有帮助。

Edit3:解决了,请参阅下面的答案。


1
您指向的答案使用TokenType。你有尝试过吗?
Nishant

只是得到与答案相同的提示。下次,我将仔细研究该示例。;)
水母

您可以尝试在令牌类型中实现列表吗?由于您的原始类型是数组列表,因此应尝试使用数组列表。
uncaught_exceptions

Answers:


952

反序列化通用集合的方法:

import java.lang.reflect.Type;
import com.google.gson.reflect.TypeToken;

...

Type listType = new TypeToken<ArrayList<YourClass>>(){}.getType();
List<YourClass> yourClassList = new Gson().fromJson(jsonArray, listType);

由于评论中的几个人都提到了它,因此这里是对如何使用TypeToken该类的解释。该构造new TypeToken<...>() {}.getType()将编译时类型(在<和之间>)捕获到运行时java.lang.reflect.Type对象中。与Class只能表示原始(擦除)类型的Type对象不同,该对象可以表示Java语言中的任何类型,包括通用类型的参数化实例化。

TypeToken类本身不具有公共构造,因为你不应该直接构造它。相反,您总是构造一个匿名子类(因此{},,这是该表达式的必要部分)。

由于类型擦除,TypeToken该类只能捕获在编译时完全已知的类型。(也就是说,您不能new TypeToken<List<T>>() {}.getType()对类型参数进行操作T。)

有关更多信息,请参见文档TypeToken


31
在新版本的GSON中,TypeToken构造函数不是公共的,因此在这里您会看到构造函数不可见的错误。在这种情况下,您必须做什么?
Pablo

8
使用GSON的实际版本(2.2.4),它可以再次工作。您可以在此处访问构造函数。

我的json对象从一个对象开始,然后包含我想要的对象的数组 { "myObjectArray":[ {....} , {....} , {....} ] },我已经为其创建了模型文件{....},如何获取该通用集合代码以不假设我的根元素是一个数组而无需创建新的嵌套对象文件
CQM 2014年

7
遵循必需的导入--- import java.lang.reflect.Type; import com.google.gson.reflect.TypeToken
Umair Saleem 2015年

4
如果YourClass是固定在代码中的,这很好。如果该类在运行时出现怎么办?
jasxir 2015年

273

另一种方法是将数组用作类型,例如:

MyClass[] mcArray = gson.fromJson(jsonString, MyClass[].class);

这样可以避免使用Type对象带来的麻烦,并且如果您确实需要列表,可以始终通过以下方式将数组转换为列表:

List<MyClass> mcList = Arrays.asList(mcArray);

恕我直言,这更具可读性。

并使其成为实际列表(可以修改,请参阅的限制Arrays.asList()),然后执行以下操作:

List<MyClass> mcList = new ArrayList<>(Arrays.asList(mcArray));

4
这很棒!如何反射使用?我不知道该MyClass值,它将动态定义!
Amin Sh 2013年

1
注意:请注意,mcList不是完整列表。许多事情是行不通的。
njzk2 2014年

4
如何与泛型一起使用?T[] yourClassList = gson.fromJson(message, T[].class);//无法从类型变量中选择
Pawel Cioch 2015年

2
@MateusViccari发表评论时,mcList此答案仅是调用的结果Arrays.asList。此方法返回一个列表,在该列表上,大多数(如果不是全部)可选方法都未实现,并引发异常。例如,您不能将任何元素添加到该列表。正如后面的编辑所建议的那样,它Arrays.asList有局限性,将其包装到实际中ArrayList可以使您获得在许多情况下更有用的列表。
njzk2'3

2
如果您需要在运行时为任意元素类型构造一个数组类型,则可以Array.newInstance(clazz, 0).getClass()按照David Wood的answer中的描述使用。
Daniel Pryden

31

请参阅这篇文章。 Java类型泛型作为GSON的参数

我对此有更好的解决方案。这是列表的包装器类,因此包装器可以存储列表的确切类型。

public class ListOfJson<T> implements ParameterizedType
{
  private Class<?> wrapped;

  public ListOfJson(Class<T> wrapper)
  {
    this.wrapped = wrapper;
  }

  @Override
  public Type[] getActualTypeArguments()
  {
      return new Type[] { wrapped };
  }

  @Override
  public Type getRawType()
  {
    return List.class;
  }

  @Override
  public Type getOwnerType()
  {
    return null;
  }
}

然后,代码可以很简单:

public static <T> List<T> toList(String json, Class<T> typeClass)
{
    return sGson.fromJson(json, new ListOfJson<T>(typeClass));
}

什么mEntity.rulePattern
Al Lelopath 2015年

它只是一个测试示例对象。您不需要关心它。使用toList方法,一切顺利。
2015年

@Happier我正在尝试实现此Gson 2.8.2,它似乎不起作用。任何机会 stackoverflow.com/questions/50743932/…您可以看一下,让我知道我所缺少的东西
Praveen

1
@Praveen我在2.8.2中已经尝试过这种方式,它可以像原来一样工作。
更快乐的

30

由于Gson 2.8,我们可以创建util函数,例如

public <T> List<T> getList(String jsonArray, Class<T> clazz) {
    Type typeOfT = TypeToken.getParameterized(List.class, clazz).getType();
    return new Gson().fromJson(jsonArray, typeOfT);
}

使用示例

String jsonArray = ...
List<User> user = getList(jsonArray, User.class);

2
TypeToken#getParameterized看起来更好的方式,然后用一个匿名子类的黑客
尼古拉Kulachenko

这应该是公认的答案;至少对于较新版本
ccpizza

2
这是完美的答案。解决我的问题。
donmj '19

我按原样复制了您的方法,但它不起作用:编译器说:“对于TypeToken类型,未定义方法getParameterized(Class <List>,Class <T>)”。我检查了我的两个版本GSON(2.8.0)和文件,一切都在这一侧细...最后我用@Happier解决方案,它工作正常
leguminator

@leguminator您正确导入了TypeToken吗?并且您正在使用Java或Kotlin。我将尝试再次测试
Phan Van Linh

26

哭泣,另一种达到相同结果的方法。我们使用它的可读性。

而不是写这个难以理解的句子:

Type listType = new TypeToken<ArrayList<YourClass>>(){}.getType();
List<YourClass> list = new Gson().fromJson(jsonArray, listType);

创建一个扩展您的对象列表的空类:

public class YourClassList extends ArrayList<YourClass> {}

并在解析JSON时使用它:

List<YourClass> list = new Gson().fromJson(jsonArray, YourClassList.class);

9

对于Kotlin而言:

import java.lang.reflect.Type
import com.google.gson.reflect.TypeToken
...
val type = object : TypeToken<List<T>>() {}.type

或者,这是一个有用的功能:

fun <T> typeOfList(): Type {
    return object : TypeToken<List<T>>() {}.type
}

然后,使用:

val type = typeOfList<YourMagicObject>()

我已使用您的代码使用经过修饰的类型创建此函数:inline fun <reified T> buildType() = object : TypeToken<T>() {}.type!!并使用列表类型进行调用:buildType<List<YourMagicObject>>()
coffeemakr

@coffeemakr您不需要在这里使用已类型化的类型。
乍得宾厄姆

哦。但是,为什么要在其中创建ArrayList的类型标记buildType并同时使用泛型类型调用函数呢?这是错字吗?-这将创建的ArrayList <ArrayList的<YourMagicObject >>
coffeemakr

@coffeemakr啊,是的。错别字
乍得·宾厄姆

7
public static final <T> List<T> getList(final Class<T[]> clazz, final String json)
{
    final T[] jsonToObject = new Gson().fromJson(json, clazz);

    return Arrays.asList(jsonToObject);
}

例:

getList(MyClass[].class, "[{...}]");

好一个 但这重复了DevNG2年前写的s上面的答案:stackoverflow.com/a/17300003/1339923(并阅读该答案以警告这种方法)
Lambart

6

当它回答我的原始问题时,我已经接受了doc_180的回答,但是如果有人再次遇到此问题,我也将回答问题的第二部分:

我描述的NullPointerError与List本身无关,但与内容有关!

“ MyClass”类没有“ no args”构造函数,也没有其超类。将简单的“ MyClass()”构造函数添加到MyClass及其超类后,一切工作正常,包括doc_180建议的List序列化和反序列化。


1
如果您有抽象类的列表,则会得到相同的错误。我猜这是GSON的“无法实例化类”的一般错误消息。
德鲁

有关添加构造函数的技巧使我意识到了为什么我拥有所有空值。我的JSON字符串中有字段名称,例如“ To”和“ From”,但是对象中的对应字段是小写的“ to”和“ from”,因此被跳过了
Rune

4

这是使用动态定义类型的解决方案。诀窍是使用Array.newInstance()创建适当类型的数组。

    public static <T> List<T> fromJsonList(String json, Class<T> clazz) {
    Object [] array = (Object[])java.lang.reflect.Array.newInstance(clazz, 0);
    array = gson.fromJson(json, array.getClass());
    List<T> list = new ArrayList<T>();
    for (int i=0 ; i<array.length ; i++)
        list.add(clazz.cast(array[i]));
    return list; 
}

如果您过去class.cast()避免使用强制转换为导致未经检查的警告,则此答案会更好(T)。或者,更好的是,不要烦恼转换,而是使用类似的Arrays.asList()方法将数组从数组转换为List<T>。同样,不需要传递长度Array.newInstance()-大小为零的数组将足以调用getClass()
Daniel Pryden

感谢您的建议,我对您进行了建议的更改并更新了上面的帖子。
David Wood,

2

我想补充一种可能性。如果您不想使用TypeToken并想将json对象数组转换为ArrayList,则可以这样进行:

如果您的json结构如下:

{

"results": [
    {
        "a": 100,
        "b": "value1",
        "c": true
    },
    {
        "a": 200,
        "b": "value2",
        "c": false
    },
    {
        "a": 300,
        "b": "value3",
        "c": true
    }
]

}

您的类结构如下:

public class ClassName implements Parcelable {

    public ArrayList<InnerClassName> results = new ArrayList<InnerClassName>();
    public static class InnerClassName {
        int a;
        String b;
        boolean c;      
    }
}

那么您可以将其解析为:

Gson gson = new Gson();
final ClassName className = gson.fromJson(data, ClassName.class);
int currentTotal = className.results.size();

现在,您可以访问className对象的每个元素。


1

请参阅示例2,以了解Gson的“类型”类。

示例1:在此deserilizeResturant中,我们使用Employee []数组并获取详细信息

public static void deserializeResturant(){

       String empList ="[{\"name\":\"Ram\",\"empId\":1},{\"name\":\"Surya\",\"empId\":2},{\"name\":\"Prasants\",\"empId\":3}]";
       Gson gson = new Gson();
       Employee[] emp = gson.fromJson(empList, Employee[].class);
       int numberOfElementInJson = emp.length();
       System.out.println("Total JSON Elements" + numberOfElementInJson);
       for(Employee e: emp){
           System.out.println(e.getName());
           System.out.println(e.getEmpId());
       }
   }

范例2:

//Above deserilizeResturant used Employee[] array but what if we need to use List<Employee>
public static void deserializeResturantUsingList(){

    String empList ="[{\"name\":\"Ram\",\"empId\":1},{\"name\":\"Surya\",\"empId\":2},{\"name\":\"Prasants\",\"empId\":3}]";
    Gson gson = new Gson();

    // Additionally we need to se the Type then only it accepts List<Employee> which we sent here empTypeList
    Type empTypeList = new TypeToken<ArrayList<Employee>>(){}.getType();


    List<Employee> emp = gson.fromJson(empList, empTypeList);
    int numberOfElementInJson = emp.size();
    System.out.println("Total JSON Elements" + numberOfElementInJson);
    for(Employee e: emp){
        System.out.println(e.getName());
        System.out.println(e.getEmpId());
    }
}

0

我喜欢kays1的回答,但无法实现。因此,我使用他的概念构建了自己的版本。

public class JsonListHelper{
    public static final <T> List<T> getList(String json) throws Exception {
        Gson gson = new GsonBuilder().setDateFormat("yyyy-MM-dd HH:mm:ss").create();
        Type typeOfList = new TypeToken<List<T>>(){}.getType();
        return gson.fromJson(json, typeOfList);
    }
}

用法:

List<MyClass> MyList= JsonListHelper.getList(jsonArrayString);

当然这是行不通的,因为您试图在编译时使用T。这将有效地反序列化为StringMap的列表,不是吗?
JHH

0

在我的情况下,@uncaught_exceptions的答案不起作用,我不得不使用List.class代替java.lang.reflect.Type

String jsonDuplicatedItems = request.getSession().getAttribute("jsonDuplicatedItems").toString();
List<Map.Entry<Product, Integer>> entries = gson.fromJson(jsonDuplicatedItems, List.class);
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.