Google Gson - десериализовать список <class> объект? (универсальный тип)

441

Я хочу передать объект списка через Google Gson, но не знаю, как десериализовать универсальные типы.

Что я попробовал, посмотрев на это (ответ BalusC):

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

но затем я получаю ошибку в eclipse, говорящую «Тип new 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 и «результат» не является нулевым.

Я проверил listType с помощью отладчика и получил следующее:

  • Тип списка
    • args = ListOfTypes
      • list = null
      • resolvedTypes = Type [1]
    • loader = PathClassLoader
    • ownerType0 = null
    • ownerTypeRes = null
    • rawType = Class (java.util.ArrayList)
    • rawTypeName = "java.util.ArrayList"

поэтому кажется, что вызов getClass не работает должным образом. Какие-либо предложения...?

Edit2: я проверил в руководстве пользователя Gson . В нем упоминается исключение времени выполнения, которое должно произойти во время синтаксического анализа универсального типа в Json. Я сделал это «неправильно» (не показано выше), как в примере, но не получил это исключение вообще. Таким образом, я изменил сериализацию, как предложено в руководстве пользователя. Не помогло, хотя.

Edit3: решено, см. Мой ответ ниже.

медуза
источник
1
Ответ, на который вы указали, использует TokenType. Вы пробовали таким образом?
Nishant
просто получил ту же подсказку, что и ответ. в следующий раз я приведу пример поближе. ;)
медуза
Можете ли вы попробовать реализацию списка в токене типа? Поскольку ваш необработанный тип является списком массивов, вы должны попробовать список массивов.
uncaught_exceptions

Ответы:

954

Метод десериализации общей коллекции:

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класса .

uncaught_exceptions
источник
31
В новых версиях GSON конструктор TypeToken не является общедоступным, поэтому здесь вы получаете конструктор не видимой ошибки. Что вы должны сделать в этом случае?
Пабло
8
Используя актуальную версию GSON (2.2.4), он снова работает. Вы можете получить доступ к конструктору здесь.
мой объект json начинается с объекта, затем содержит массив объекта, который я хочу. { "myObjectArray":[ {....} , {....} , {....} ] }Я создал файл модели {....}, как получить этот универсальный код коллекции, чтобы не предполагать, что мой корневой элемент является массивом без создания нового вложенного объектного файла
CQM
7
Требуется следующее импортирование --- import java.lang.reflect.Type; import com.google.gson.reflect.TypeToken
Умаир Салим,
4
Это хорошо, если YourClass зафиксирован в коде. Что делать, если класс приходит во время выполнения?
Jasxir
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));
DevNG
источник
4
это замечательно! Как я могу использовать это с отражением? Я не знаю MyClassзначение, и оно будет определено динамически!
Амин Ш
1
примечание: с этим, будьте осторожны, что mcList не является полноценным списком. многие вещи не будут работать.
njzk2
4
Как использовать это с дженериками? T[] yourClassList = gson.fromJson(message, T[].class);// невозможно выбрать из переменной типа
Pawel Cioch
2
@MateusViccari на момент этого комментария, mcListв этом ответе был только результат обращения к Arrays.asList. Этот метод возвращает список, в котором большинство, если не все необязательные методы, остаются нереализованными и генерируют исключения. Например, вы не можете добавить какой-либо элемент в этот список. Как предполагает более позднее редактирование, Arrays.asListимеет ограничения, и включение его в реальный ArrayListпозволяет получить список, который во многих случаях более полезен.
njzk2
2
Если вам нужно создать тип массива во время выполнения для произвольного типа элемента, вы можете использовать его, Array.newInstance(clazz, 0).getClass()как описано в ответе Дэвида Вуда .
Даниэль Приден
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?
Аль Лелопат
Это просто образец объекта для тестирования. Вам не нужно заботиться об этом. Используйте метод toList, и все будет хорошо.
Счастливее
@Happier Я пытаюсь реализовать этот Gson 2.8.2, и кажется, что он не работает. Любой шанс stackoverflow.com/questions/50743932/… вы можете взглянуть и сообщить мне, что мне не хватает
Правин
1
@Praveen Я пробовал этот путь в 2.8.2, он работает как оригинал.
Счастливее
31

Так как Gson 2.8мы можем создать функцию утилит, как

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выглядит намного лучше, чем взломать с анонимным подклассом
Николай Кулаченко
это должен быть принятый ответ; по крайней мере, для более новых версий
ccpizza
2
Это идеальный ответ. Решает мою проблему.
Donmj
Я скопировал ваш метод «как есть», и он не работает: компилятор говорит: «Метод getParameterized (Class <List>, Class <T>) не определен для типа TypeToken». Я проверил и мою версию Gson (2.8.0) и документацию , и все прекрасно на этой стороне ... Я закончил с использованием @Happier решение , которое работает отлично
leguminator
@leguminator Вы правильно импортировали TypeToken? и вы используете Java или Kotlin. Я попытаюсь проверить снова
Фан Ван Линь
26

Wep, еще один способ добиться того же результата. Мы используем его для удобства чтения.

Вместо этого трудно читаемого предложения:

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

Для Котлина просто:

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, "[{...}]");
kayz1
источник
Неплохо. Но это дублирует DevNGответ выше, написанный 2 годами ранее: stackoverflow.com/a/17300003/1339923 (и прочитайте этот ответ для предостережений при таком подходе)
Ламбарт,
6

Поскольку он отвечает на мой первоначальный вопрос, я принял ответ doc_180, но если кто-то снова столкнется с этой проблемой, я также отвечу на 2-ю половину моего вопроса:

Описанная мною ошибка NullPointerError не имеет ничего общего с самим списком, а с его содержимым!

Класс «MyClass» не имел конструктора «no args», и ни один не имел своего суперкласса. После того, как я добавил простой конструктор MyClass () в MyClass и его суперкласс, все работало нормально, включая сериализацию и десериализацию List, как было предложено doc_180.

медуза
источник
1
Если у вас есть список абстрактных классов, вы получите ту же ошибку. Я предполагаю, что это общее сообщение об ошибке GSON для "Невозможно создать экземпляр класса".
Дрю
Совет по добавлению конструктора помог мне понять, почему у меня были все нулевые значения. У меня были имена полей, такие как «Кому» и «От» в моей JSON-строке, но соответствующие поля в моем объекте были «в» и «от» в нижнем регистре, поэтому они были пропущены
Руна
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()преобразования массива в a List<T>. Кроме того, нет необходимости передавать длину Array.newInstance()- массив нулевого размера будет достаточно хорош для вызова getClass().
Даниэль Приден
Спасибо за предложение, я внес предложенные вами изменения и обновил пост выше.
Дэвид Вуд
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);
mike83_dev
источник
Конечно, это не может работать, так как вы пытаетесь использовать 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);
Андрей
источник