Json with gson in android

Разбор JSON для Android с помощью Gson

Помимо XML, JSON — очень распространенный формат, используемый в ответах API. Его простота помогла получить широкое распространение в пользу более многословного XML. Кроме того, JSON можно легко комбинировать с REST, создавая понятные и простые в использовании API. Android включает поддержку JSON в свой SDK, как кто-то может найти в сводке JSON-пакета . Однако, используя эти классы, разработчик должен иметь дело с низкоуровневым анализом JSON, который, на мой взгляд, утомителен и скучен. По этой причине в этом руководстве я собираюсь показать вам, как выполнять автоматический анализ JSON. Для этой цели мы будем использовать библиотеку Google Gson . С официального сайта:

Gson — это библиотека Java, которую можно использовать для преобразования объектов Java в их представление JSON. Его также можно использовать для преобразования строки JSON в эквивалентный объект Java. Gson может работать с произвольными объектами Java, включая уже существующие объекты, исходный код которых у вас отсутствует.
Есть несколько проектов с открытым исходным кодом, которые могут конвертировать объекты Java в JSON. Однако большинство из них требуют, чтобы вы размещали аннотации Java в своих классах, чего вы не можете сделать, если у вас нет доступа к исходному коду. Большинство также не полностью поддерживает использование Java Generics. Гсон считает, что оба они очень важные цели дизайна.

Отлично, именно то, что нам нужно. Прежде чем углубляться в код, вы можете взглянуть на Руководство пользователя Gson и добавить в закладки Javadocs API Gson . Давайте начнем с загрузки Gson , с текущей версией 1.6. Нам нужен gson-1.6.jar из дистрибутива.

Давайте приступим к созданию проекта Eclipse с именем «AndroidJsonProject» следующим образом:

Добавьте Gson JAR в classpath вашего проекта.

Чтобы проиллюстрировать, как использовать Gson для анализа JSON, мы собираемся проанализировать ответ JSON из API Twitter. Проверьте документацию по API Twitter для получения дополнительной информации. Мы собираемся использовать метод API поиска для выполнения специальных поисков.

Например, для поиска в Twitter о JavaCodeGeeks и получения результатов в формате JSON, вот соответствующий URL:

Источник

Android GSON Tutorial and Examples

Android Google Gson Examples and Tutorials.

Gson (also known as Google Gson) is a small Java-based library for parsing and creating JSON objects.

It’s a serialization/deserialization library to convert Java Objects into JSON and back.

Google developed Gson for its own projects, but later made Gson publicly available, starting with version 1.0.

Gson is very powerful and is capable of working with arbitrary Java objects including pre-existing objects that you do not have source-code of.

Uses of Gson

1. Conversion of Java Objects into JSON and back.
2. Conversion of a JSON string to an equivalent Java object.

Why Gson was Created

Here are reasons for creation of Gson:

1. To make working with JSON easy by providing simple toJson() and fromJson() methods. These methods allow us convert Java objects to JSON and vice-versa.
2. To allow pre-existing unmodifiable objects to be converted to and from JSON.
3. To provide Extensive support of Java Generics.
4. To allow custom representations for objects
5. To provide support for arbitrarily complex objects (with deep inheritance hierarchies and extensive use of generic types)

Installation of Gson

Gson targets Java based projects including android. That means we have at leats several ways of installing it depending on our build system.

(a) Gradle

For example if you are using android then most likely you are using android studio and gradle.

In that case you add the following in you app level build.gradle’s dependencies:

(b) Maven

If you are creating a general java project then most likely you will use Maven:

(c) Jar

The last option it to use jar directly. You download them from Maven Central and add to your project.

Important Classes

(a) Gson

Gson is a class found in com.google.gson package and is the main class we need to use Gson Library.

Normally we use it first by first constructing a Gson instance and then invoking toJson(Object) or fromJson(String, Class) methods on it.

(b). JsonElement

JsonElement is a class found in com.google.gson package that represents an element of Json.

Here are JsonElement Objects:

1. JsonObject
2. JsonArray
3. JsonPrimitive
4. JsonNull .

(c) JsonObject

JsonObject is a class found in com.google.gson package that represents an object type in Json.

This object can comprise name-value pairs where names are strings, and values are any other type of JsonElement .

With this then we can build a tree of JsonElements. Those elements are maintained in order they were added.

(d) JsonParser

JsonParser is a class found in com.google.gson package that is used to parse Json into a parse tree of JsonElements

Creating Gson

1. Gson()

The first way of creating or constructing Gson object is to use the defalu constructor: Gson() .

This will construct us a Gson object with default configuration.

That default configuration has the following settings:

1. The JSON generated by toJson methods is in compact representation. This means that all the unneeded white-space is removed. You can change this behavior with GsonBuilder#setPrettyPrinting() .
2. The generated JSON omits all the fields that are null. Note that nulls in arrays are kept as is since an array is an ordered list. Moreover, if a field is not null, but its generated JSON is empty, the field is kept. You can configure Gson to serialize null values by setting GsonBuilder#serializeNulls().
3. Gson provides default serialization and deserialization for Enums, Map, java.net.URL, java.net.URI, java.util.Locale, java.util.Date, java.math.BigDecimal, and java.math.BigInteger classes.

2. GsonBuilder

GsonBuilder can be used to instantiate Gson with various configuration settings.

GsonBuilder follows the builder pattern, and it is typically used by first invoking various configuration methods to set desired options, and finally calling the create() method.

Important Gson methods

(a). toJson()

This method serializes the specified object, including those of generic types, into its equivalent Json representation.

It must be used if the specified object is a generic type. For non-generic objects, use toJson(Object,Appendable) instead.

(b). fromJson

This method deserializes the specified Json into an object of the specified type. This method is useful if the specified object is a generic type. For non-generic objects, use fromJson(String,Class) instead.

If you have the Json in a Reader instead of a String, use fromJson(Reader,Type) instead.

(c). toJsonTree

This method serializes the specified object, including those of generic types, into its equivalent representation as a tree of JsonElements. This method must be used if the specified object is a generic type. For non-generic objects, use toJsonTree(Object) instead.

(d). getAdapter

Returns the type adapter for type.

Full Gson Hello World Example

Let’s see a full Gson hello world example. You can copy paste this example into your IDE as long as you have Gson installed and run.

Quick GSON Examples and How To’s

In these examples we are using Google Gson.

1. How to Convert Map to JSON

Suppose I give you a map with a String key and a T value. And I tell you to map it or convert to a JSON string.

How would you do it?

Well you can simply use the toJson() method of Gson class. You first have to instantiate that Gson class then invoke that method.

2. How to Convert JSON to Map

What about if you have JSON String and we ask you to convert it to a Map data structure in java.

Well then you would use Gson ‘s fromJson() method.

However this time you must instantiate a TypeToken with that Map as a generic parameter. Then pass the json string as our first parameter in the fromJson() method. And the Type instance as our second parameter.

3. How to Convert JSON to Object

All right you have a JSON String and you are told to convert it to an Object of given type.

Well, again you pass the json string and the type to the fromJson() method.

4. How to Convert JSON to ArrayList

A common scenario in many projects is to convert a json string to an ArrayList, the most commonly used collection.

We start by using the TextUtils ‘ isEmpty() method to check for empty values.

Then we obtain our TypeToken instance with ArrayList of JSONObjects passed as our generic type.

Then use the fromJson() method to get our ArrayList of JSONObjects.

Then now we can loop through it and to fill the ArrayList that we want to populate.

5. How to Convert List to JSON

Another common thing is to convert a List to a json string. Maybe you want to serialize that list and send it over the where or a basic way of exposing it as an API.

Again, the toJson() method easily does that for us.

6. How to Convert Object to JSON

You have an object and you should convert it to JSON, well you simply invoke the toJson() method with the object passed as a parameter.

7. How to exclude specific fields from Serialization without annotations

Normally you control fields to include via annotations in Gson. However, can we do it without annotations.

8. How to Pretty Print with Gson

PrettyPrinting means adding white-space to make our JSON data more readable. You can use GsonBuilder#setPrettyPrinting() .

9. How to write JSON using TreeModel

Here’s the important method. We have two methods for reading and writing json data.

Here’s the full class:

10. How to Convert String to Object

11. Pretty Printing JSON String

12. Streaming API Read and Write using Gson

This is an example of JSON Streaming API reading and writing. We will use JsonReader, JsonToken and JsonWriter classes.

We have three methods, our main() method, a readJSON() method and writeJson() method.

13. Full Reusable Gson Utility class

Oclemy

Thanks for stopping by. My name is Oclemy(Clement Ochieng) and we have selected you as a recipient of a GIFT you may like ! Together with Skillshare we are offering you PROJECTS and 1000s of PREMIUM COURSES at Skillshare for FREE for 1 MONTH. To be eligible all you need is by sign up right now using my profile .

Источник

Android: парсим JSON правильно

Любой Android-разработчик рано или поздно сталкивается с форматом представления данных типа JSON. Наиболее часто он используется для передачи/получения данных с какого-либо сервера. Формат предельно прост, подробнее о нём можно почитать в Википедии:

«JSON (JavaScript Object Notation, обычно произносится как /ˈdʒeɪsən/ JAY-sən) — текстовый формат обмена данными, основанный на JavaScript. Как и многие другие текстовые форматы, JSON легко читается людьми. Несмотря на происхождение от JavaScript, формат считается независимым от языка и может использоваться практически с любым языком программирования. Для многих языков существует готовый код для создания и обработки данных в формате JSON».

Любой класс в Java или Kotlin можно представить в виде структуры JSON, где есть поля, атрибуты, фигурные скобки обозначают объект, квадратные скобки — массив.

Следующий пример показывает JSON-представление данных об объекте, описывающем человека. В данных присутствуют строковые поля имени и фамилии, информация об адресе и массив, содержащий список телефонов. Как видно из примера, значение может представлять собой вложенную структуру:

Наиболее популярный среди разработчиков способ трансформировать данные в JSON и обратно — это библиотека GSON от самих разработчиков Google. Она очень проста в использовании, мало весит и интегрирована во многие библиотеки.

На данный момент все, за редким исключением, Android-разработчики используют Kotlin, а GSON (как и другие подобные библиотеки типа Jackson или Moshi) написана на Java. Это не страшно, потому что Kotlin и Java полностью взаимозаменяемы, но есть небольшие нюансы, которые могут привести к совершенно неожиданным результатам.

Давайте создадим класс User и посмотрим на эти нюансы на практике. В этом классе у нас будут обычные поля и поля со значениями по умолчанию. Как вы знаете, в Java нельзя присваивать переменным значения по умолчанию, а в Kotlin можно:

И теперь представим, что с какого-то сервера пришли данные о пользователе в формате JSON:

Теперь нам нужно распарсить этот JSON и превратить его в обычный класс Kotlin с помощью библиотеки GSON. Добавим зависимость GSON в наш проект в файл Gradle

и сразу напишем тест:

Тест прекрасно выполняется без единой ошибки, то есть код работает. Но обратите внимание, что возраст пользователя у нас == 0, а его роль не определена, хотя в самом классе у нас прописаны значения по умолчанию для этих переменных. Если эти параметры не определены в JSON, должны подставляться значения по умолчанию: возраст == 13, а роль == Viewer, но они не подставляются, а код всё равно работает. Вот так неожиданность! Не такого поведения мы ожидали!

Давайте разбираться. Дело в том, что, как мы писали выше, библиотека GSON написана на Java, а это значит, что значения по умолчанию для несуществующих полей такие: для примитива int — это 0, для отсутствующего объекта — это null. Простая трансформация JSON в класс на Kotlin может легко сломать null-safety, на который так рассчитывают все разработчики, и может привести к падению приложения там, где оно падать не должно.

И тут нам на помощь приходит котлиновская библиотека по сериализации объектов.

Сериализация от Kotlin

Это небольшая вспомогательная библиотечка от разработчиков языка, которая работает с помощью аннотации @Serializable. С ней у вас не будет проблем при использовании полей по умолчанию. Чтобы подключить библиотеку к своему проекту, нужно прописать в файле Gradle плагин и несколько зависимостей. В файле проекта build.gradle(Project):

В файле проекта build.gradle(Module:app):

Теперь трансформация JSON (сериализация) будет проходить корректно. Напишем наш класс и добавим аннотацию:

Тест пройден успешно! Теперь класс сериализуется у нас со значениями по умолчанию, если таковые прописаны в классе.

Сериализация от Kotlin + Retrofit

Если вы хоть раз отправляли запрос на сервер или получали с сервера какой-то ответ, то наверняка вы знакомы с библиотекой Retrofit. В этой библиотеке нет поддержки сериализации от Kotlin, но у вас есть возможность добавить вспомогательную библиотеку от Джека Вортона в качестве зависимости Gradle:

Теперь при использовании Retrofit сериализация будет происходить автоматически:

Дополнительно, но не обязательно вы можете использовать JsonConfiguration для выключения StrictMode. StrictMode включен по умолчанию и запрещает использование неизвестных ключей в JSON и нечисловые значения в числах с плавающей точкой. Хорошая практика — включать StrictMode в «дебажной» версии приложения и выключать его в «релизной».

Читайте больше полезных статей для начинающих Android-разработчиков:

А если затянет — приходите на факультет Android-разработки. В время учебы вы разработаете Android-приложение и выложите его в Google Play, даже если никогда не программировали. А также своите языки Java и Kotlin, командную разработку, Material Design и принципы тестирования.

Любой Android-разработчик рано или поздно сталкивается с форматом представления данных типа JSON. Наиболее часто он используется для передачи/получения данных с какого-либо сервера. Формат предельно прост, подробнее о нём можно почитать в Википедии:

«JSON (JavaScript Object Notation, обычно произносится как /ˈdʒeɪsən/ JAY-sən) — текстовый формат обмена данными, основанный на JavaScript. Как и многие другие текстовые форматы, JSON легко читается людьми. Несмотря на происхождение от JavaScript, формат считается независимым от языка и может использоваться практически с любым языком программирования. Для многих языков существует готовый код для создания и обработки данных в формате JSON».

Любой класс в Java или Kotlin можно представить в виде структуры JSON, где есть поля, атрибуты, фигурные скобки обозначают объект, квадратные скобки — массив.

Следующий пример показывает JSON-представление данных об объекте, описывающем человека. В данных присутствуют строковые поля имени и фамилии, информация об адресе и массив, содержащий список телефонов. Как видно из примера, значение может представлять собой вложенную структуру:

Наиболее популярный среди разработчиков способ трансформировать данные в JSON и обратно — это библиотека GSON от самих разработчиков Google. Она очень проста в использовании, мало весит и интегрирована во многие библиотеки.

На данный момент все, за редким исключением, Android-разработчики используют Kotlin, а GSON (как и другие подобные библиотеки типа Jackson или Moshi) написана на Java. Это не страшно, потому что Kotlin и Java полностью взаимозаменяемы, но есть небольшие нюансы, которые могут привести к совершенно неожиданным результатам.

Давайте создадим класс User и посмотрим на эти нюансы на практике. В этом классе у нас будут обычные поля и поля со значениями по умолчанию. Как вы знаете, в Java нельзя присваивать переменным значения по умолчанию, а в Kotlin можно:

И теперь представим, что с какого-то сервера пришли данные о пользователе в формате JSON:

Теперь нам нужно распарсить этот JSON и превратить его в обычный класс Kotlin с помощью библиотеки GSON. Добавим зависимость GSON в наш проект в файл Gradle

и сразу напишем тест:

Тест прекрасно выполняется без единой ошибки, то есть код работает. Но обратите внимание, что возраст пользователя у нас == 0, а его роль не определена, хотя в самом классе у нас прописаны значения по умолчанию для этих переменных. Если эти параметры не определены в JSON, должны подставляться значения по умолчанию: возраст == 13, а роль == Viewer, но они не подставляются, а код всё равно работает. Вот так неожиданность! Не такого поведения мы ожидали!

Давайте разбираться. Дело в том, что, как мы писали выше, библиотека GSON написана на Java, а это значит, что значения по умолчанию для несуществующих полей такие: для примитива int — это 0, для отсутствующего объекта — это null. Простая трансформация JSON в класс на Kotlin может легко сломать null-safety, на который так рассчитывают все разработчики, и может привести к падению приложения там, где оно падать не должно.

И тут нам на помощь приходит котлиновская библиотека по сериализации объектов.

Сериализация от Kotlin

Это небольшая вспомогательная библиотечка от разработчиков языка, которая работает с помощью аннотации @Serializable. С ней у вас не будет проблем при использовании полей по умолчанию. Чтобы подключить библиотеку к своему проекту, нужно прописать в файле Gradle плагин и несколько зависимостей. В файле проекта build.gradle(Project):

В файле проекта build.gradle(Module:app):

Теперь трансформация JSON (сериализация) будет проходить корректно. Напишем наш класс и добавим аннотацию:

Тест пройден успешно! Теперь класс сериализуется у нас со значениями по умолчанию, если таковые прописаны в классе.

Сериализация от Kotlin + Retrofit

Если вы хоть раз отправляли запрос на сервер или получали с сервера какой-то ответ, то наверняка вы знакомы с библиотекой Retrofit. В этой библиотеке нет поддержки сериализации от Kotlin, но у вас есть возможность добавить вспомогательную библиотеку от Джека Вортона в качестве зависимости Gradle:

Теперь при использовании Retrofit сериализация будет происходить автоматически:

Дополнительно, но не обязательно вы можете использовать JsonConfiguration для выключения StrictMode. StrictMode включен по умолчанию и запрещает использование неизвестных ключей в JSON и нечисловые значения в числах с плавающей точкой. Хорошая практика — включать StrictMode в «дебажной» версии приложения и выключать его в «релизной».

Читайте больше полезных статей для начинающих Android-разработчиков:

А если затянет — приходите на факультет Android-разработки. В время учебы вы разработаете Android-приложение и выложите его в Google Play, даже если никогда не программировали. А также своите языки Java и Kotlin, командную разработку, Material Design и принципы тестирования.

Источник