Android json to map

Шпаргалка Java программиста 8. Библиотеки для работы с Json (Gson, Fastjson, LoganSquare, Jackson, JsonPath и другие)

В одной из моих прошлых статей я рассказывал о своем opensorce pet проекте useful-java-links, идея которого собрать как можно больше ссылок на полезные Java библиотеки и фреймворки. У него так же есть подпроект Hello World project идея которого для каждой библиотеки собрать несколько простых примеров её использования.

Проблема программистов в Java мире в том что кроме стандартной библиотеки JDK есть огромное других полезных библиотек, причем переход от одной библиотеки к другой может вызывать проблемы из-за неполной документации, отсутствия простых примеров или даже сложности понять какие зависимости нужно добавить в maven чтобы все запустилось. А на новой работе вполне могут использовать вместо твоей любимой библиотеки ту которую ты не знаешь. Идея моего проекта облегчить изучение и выбор разных библиотек.

Итак, давайте посмотрим какие известные библиотеки есть для работы с JSON в Java…

8. Работа с Json

JSON парсеры

Аналог XPath для JSON

Генерация Java классов из JSON или JSON схемы и JSON валидация

Итак, у нас восемь библиотек для сериализации и десериализации в json, две библиотеки для генерации Java классов по схеме или json файлу, одна библиотека для валидации схемы и два аналога XPath, но для json. Давайте рассмотрим каждую из них.

1. JSON парсеры

Существует три основных способа сериализации и десериализации среди указанных библиотек (от самого простого к самому сложному) и один дополнительный:

1. Data bind,
2. Tree Model,
3. Streaming API,
4. (И дополнительный способ) Аналоги XPath,

Давайте рассмотрим с чем их едят:

Data bind самый популярный и простой способ, вы просто указываете класс, который нужно преобразовать в json, может быть часть полей отмечаете аннотациями (а зачастую даже это необязательно), а библиотека сама превращает этот класс и всю его иерархию классов в json. Аналогом при работе с xml будет JAXB (Java Architecture for XML Binding)
Плюсы: наиболее простой из всех, по сути главное реализовать только Java классы, более того можно просто сгенерировать Java классы из json’a или json схемы.
Минусы: скорость и память. Большинство библиотек использует рефлексию и т.п. методы работы с Java классами (хотя не все), что очевидно не очень быстро. К тому же, весь json файл сразу превращается в Java объекты, что может просто исчерпать всю доступную память, если вы попытаетесь обработать очень большой json.
Вывод: если нет проблем с производительностью, памятью и вы не собираетесь обрабатывать многогигабайтные json’ы скорее всего самый лучший способ.

Tree Model — данный парсер представляет json в виде Java классов таких как Node или JsonElement c иерархической структурой, а уже сам программист их обходит и получает из них информацию. Данный способ похож на DOM парсеры в xml.
Плюсы: обычно быстрее первого способа и проще третьего,
Минусы: уступает Data bind по простоте, плюс ряд библиотек способен генерить классы при Data bind, а не использовать рефлексию, в этом случае то что Tree Model будет быстрее не очевидно, к тому же не решается проблема огромных файлов и ограничения памяти.

Streaming API — самый низкоуровневый способ, по сути программист сам вручную разбирает токены json’a. Зато никаких ограничений по памяти и в теории максимальная производительность.
Плюсы: производительность и минимальное потребление памяти,
Минусы: сложность использования,

Аналоги XPath — дополнительный способ, не очень подходит, если нужно получит всю информацию из json’a, зато позволяет написав выражение $.store.book[*].author и получить список всех авторов всех книг из json’a магазина. То есть легко получать часть информации из json’а.
Плюсы: позволяет быстро получить информацию из json’а по сложным критериям,
Минусы: не очень подходит, когда нужна все информация из json’а, не работает в обратную сторону на формирования json’ов,

1.1 Обзор библиотек

Способ	Fastjson	Gson	LoganSquare	JSON java	Moshi	Ig json parser	Jackson	Genson	JsonPath
1. Data bind	Да	Да	Да	—	Да	Да	Да	Да	—
2. Tree Model	—	Да	—	Да	—	—	Да	—	—
3. Streaming API	—	Да	—	—	—	—	Да	—	—
4. Аналоги XPath	Да	—	—	—	—	—	—	—	Да
5. Генерация классов для Data bind*	—	—	Да	—	—	Да	—	—	—
6. Github’s star	4851	4120	2188	1937	1732	921	881	108	849
7. Работает со static inner class**	Да	Да	Нет	—	Да	Нет	Да	Да	—
8. Обязательность аннотаций***	Нет	Нет	Да	—	Нет	Да	Нет	Нет	—

По ссылкам на Да можно найти примеры использования.
* — Генерация классов для Data bind позволяет сгенерировать классы на стадии компиляции, что в теории должно давать значительный прирост производительности библиотеки,
** — Работает со static inner class имеет смысл только для случая Data bind, возможно ли сериализация и десериализация для случая статических внутренних классов (не статические внутренние классы сериализовать не рекомендуется),
*** — тоже только для случая Data bind можно ли не использовать аннотации или их использование крайне рекомендуется,

1.2 Простейшие примеры использование Data bind

Для демонстрации работы библиотек будем использовать следующий json:

И следующие Java классы (в разных примерах могут слегка отличаться наличием аннотаций, если они обязательны):

Как можно увидеть, Java классы всего лишь состоять из двух классов Human и Place, в которых храниться сообщение Hi World. Json тоже содержит эти два вложенных объекта.

Примеры использования (Data bind): Способ	Fastjson	Gson	LoganSquare	Moshi	Ig json parser	Jackson	Genson
Инициализация	—	Gson gson = new Gson()	—	Moshi moshi = new Moshi. Builder().build(); JsonAdapter jsonAdapter = moshi.adapter(Human.class)	—	ObjectMapper mapper = new ObjectMapper()	Genson genson = new Genson()
Из Java в json	JSON.toJSONString(human)	gson.toJson(human)	LoganSquare.serialize(human)	jsonAdapter.toJson(human)	Human__JsonHelper.serializeToJson(human)	mapper.writeValueAsString(human)	genson.serialize(human)
Из json в Java	JSON.parseObject(jsonString, Human.class)	gson.fromJson(jsonString, Human.class)	LoganSquare.parse(jsonString, Human.class)	jsonAdapter.fromJson(jsonString)	Human__JsonHelper.parseFromJson(jsonString)	mapper.readValue(jsonString, Human.class)	genson.deserialize(jsonString, Human.class)

Human__JsonHelper — это класс который Ig json parser сгенерировал на этапе компиляции, у LoganSquare так же есть генерации на этапе компиляции, но там классы подключаются «под капотом» внутри LoganSquare.

Источник

Moshi — JSON library for Android

In this blog, we are going to talk about the JSON library by Square called Moshi. Moshi helps us to serialize and deserialize the JSON in a better and simpler way.

So, before starting let us divide the blog into the following sections,

• Why we need a library for serializing and deserializing in android?
• How do we use Moshi?
• Features of Moshi
• Using Moshi with List.
• Using Moshi with Retrofit

Why we need a library for serializing and deserializing in android?

In Android, when we do an API call we get JSON as a response majority of times. We can call that JSON and parse it manually and work with it or we can just use a library like Moshi to serialize and deserialize. Using Moshi can help us reduce the number of lines we write and reduce the possibility of getting errors.

How do we use Moshi?

In this section, we are going to understand how we would work with Moshi.

Let say we have a data class, User like

and consider we have a variable called user and is defined as,

Now, with the help of Moshi, we will convert this as a JSON structure. To work with Moshi we have JsonAdapter class and builder pattern.

So, we build Moshi using,

and we will also create a variable of type JsonAdapter, which will help us work to and fro in converting JSON to Object class and vice-a-versa.

Here, we have passed the User data class as a structure on which we want to perform the actions. Now, to convert the object of the User class to JSON we use,

Here, we are using toJson to get JSON from the object of the User and if we print this, we get

Similarly, we can map a JSON to a class using Moshi. Let’s say we want to convert the above JSON to User class, we will use,

If you see, we are using fromJson here which helps us to convert the JSON which we have passed as a string. Now, if we print this we will see,

This is how we convert JSON to object and object to JSON using Moshi.

Features of Moshi

Moshi supports almost all the data type by default like,

• Integer, Float, etc
• Arrays and Collections
• Strings
• Enums

In Moshi, we can create our own type apart from the mentioned ones above. Let us understand this by an example,

Let’s update the User class like,

Here, we have added a new data class called Name, which will look like,

Here, in Name class, we take two parameters called firstName and lastName.

Now, when getting a JSON from this class, I want the full name of the user like firstName + lastName. Either we can do it manually every time we parse the JSON or we can add our own adapter using Moshi to do it for us.

So, we will create a class called NameAdapter,

And inside this class, we are going to do our conversion. We will add two functions named as fun fullName() and fun getIndividualNames().

The class now looks like,

Here, you can see we have annotated fullName with ToJson and getIndividualNames with FromJson.

It means, that when using this adapter with Moshi, Moshi will look for the annotations.

Let’s say we want to concatenate both first and last names to return the full name and return it in JSON, we will do it inside the fullName function which is annotated with ToJson . Now, the fullName function will look like,

Similarly, since we added the ToJson conversion for the JSON parsing, we would also need to update the getIndividualNames function which is annotated with FromJson which will convert the JSON values to individual elements in Name data class when mapping the JSON to class.

So, the getIndividaulNames will look like,

Here, we have splitter the string fullName from the first empty space and got the two strings that are first name and last name in a list of string.

And finally, to use this Adapter we add it in Moshi object while building it like,

Note: Moshi’s adapters are ordered by precedence, so you always want to add the Kotlin adapter after your own custom adapters. Otherwise the KotlinJsonAdapterFactory will take precedence and your custom adapters will not be called.

The JsonAdapter would be the same as above like,

and now when we print the toJson and FromJson in logcat like,

We get the following output,

This is how you can create your own conversion adapter.

Now, let’s say we want to put some condition check on only one field in the class or different fields of the same type. We can perform that as well where we create an adapter and that will only affect the only field mentioned. We would do it using annotation.

First, we will create an annotation like,

Here, the Email check is annotated with JsonQualifier which would work with specific fields.

Now, we will update the User class like,

Here, you can see we have annotated the email with EmailCheck, which means that the check with all the EmailCheck annotations will work with only the email field. The Name class remains the same.

Now, we will create an adapter which would have two functions, namely toJson and fromJson and will look like,

Here, in the EmailAdapter we have annotated the fromJson function to EmailCheck and here we will check if the JSON we are parsing to map it to the class is not a valid email then, we will return No Email Found in the email field else we return the email itself.

Similarly, we also annotated the email parameter in toJson with EmailCheck, which would mean only keys with EmailCheck annotation are allowed.

Finally, we will also update the Moshi builder with a new adapter factory called KotlinJsonAdapterFactory like,

And now, let’s create a user object-like,

and the jsonAdapter remains the same as how we have used it above. Now, if we log the jsonAdapter.toJson(user), we get the following as response,

Here, you can see we are not passing a valid email and is just an integer value.

Finally, when we parse this JSON using fromJson() then we get the output,

You can see in the email field we get No Email Found because the email was not a valid email. This is how we can create adapters for individual fields and put some condition-specific to it.

Using Moshi with List

In this section, we will learn how to convert a List to String and then String to a list.

Consider an example, where we get a list of objects from our server and we need to store it in shared preference of our app. We would like to convert the list of objects to string as it only saves a primitive data type to save it and when we need to use it we will convert it back to a list.

Now, let’s say we have a List of String like,

and now we need to set type to map the raw data like,

Here, We have list of String data, so it takes the String::class as class to identify what are the type of elements and List is the type of data which has to be converted.

Then to use this type, we will use it with Moshi adapter like,

where moshi looks like,

Now, to convert the list of data to string we will use the toJson like,

This would map the list data to string and now if we want we can store in sharedpreference.

Now, if we want to reverse the mapping from string to list again, we will use the same adapter which we created and by using fromJson of moshi we will convert it like,

Here we need to pass the string which we need to convert back to a List.

Using Moshi with Retrofit

In this section, we are going to talk about how we can do an API call using Moshi as the converter in Android. We are going to call,

To get a single post using Retrofit. So, first, let’s break it down in steps.

Steps 01.

We will first setup the dependency on the build.gradle like,

Step 02.

We will not create a data class called PostsResponse for the JSON response we will get from the API. The JSON looks like,

So, the data class mapping to this JSON would look like,

Here, you can see we have used @Json to all the fields in the data class.

@Json takes the key name in the original JSON response, and just because we are using @Json we can give any name to the data class constructor variables and the JSON would still be mapped to the data class because the mapping here is happening because of the @Json annotation.

Step 03.

Now, we will create the interface to hold the API call. We will call it as APIService and will look like,

It will have only one function called getSinglePost and will return the only post from the URL.

Step 04.

Now, to setup Retrofit, we will first create an instance of Moshi like,

and then we setup Retrofit like,

Here, we have passed the based URL and the converter factory for Moshi. We also passed the Moshi as a parameter which we created earlier.

And, to support KotlinJsonAdapterFactory additionally, needs the following dependency,

Note: MoshiConverterFactory.create(moshi) is the converter factory.

Step 05.

We will do the API Call now like,

And before running the app, do not forget to add the Internet permission in the Manifest file.

Now, if we run the app, we get,

So, the API call was successful.

Extra

Let’s say if we want to ignore title in the API response, we have updated the model like,

Here, you can see we have added Transient annotation which will ignore the field title and print the output as,

Here, the title field is coming empty.

Miscellaneous

• Moshi is very light weighted.
• It uses the same mechanisms of GSON.
• We can add custom field names using @Json annotation.

This is how we can use Moshi in our Android project.

Источник