Android java object to json object

How to convert Java object to / from JSON (Jackson)

By mkyong | Last updated: October 21, 2015

Viewed: 2,565,972 (+3,736 pv/w)

In this tutorial, we show you how to use Jackson 1.x data binding to convert Java object to / from JSON.

1. Quick Reference

1.1 Convert Java object to JSON, writeValue(. )

1.2 Convert JSON to Java object, readValue(. )

P.S All examples are tested with Jackson 1.9.13

2. Jackson Dependency

For Jackson 1.x, it contains 6 separate jars for different purpose, in most cases, you just need jackson-mapper-asl .

3. POJO (Plain Old Java Object)

An User object for testing.

4. Java Object to JSON

Convert an user object into a JSON formatted string.

5. JSON to Java Object

Read JSON string and convert it back to a Java object.

6. @JsonView

@JsonView has been supported in Jackson since version 1.4, it lets you control what fields to display.

6.1 A simple class.

6.2 Annotate on the fields you want to display.

6.3 Enable the @JsonView via writerWithView() .

References

mkyong

Founder of Mkyong.com, love Java and open source stuff. Follow him on Twitter. If you like my tutorials, consider make a donation to these charities.

Comments

Really helpful, Thanks.

In fortify scan am getting following error

writes unvalidated input into JSON. This call could allow an attacker to inject arbitrary elements or attributes into the JSON entity.

can any one know the solution for this problem please help me. Am stuck with this problem

// Convert JSON string to Object
String jsonInString = “<“age”:33,”messages”:[“msg 1″,”msg 2″],”name”:”mkyong”>”;
User user1 = mapper.readValue(jsonInString, User.class);
System.out.println(user1);
Thanks
chandu

Thanks, It helped!

Very nice tutorial

thanks!
your samples often help me to understand things at short time!

I covert convert json back to list error;

run:
<“firstName”:”Mike”,”lastName”:”harvey1″,”age”:34,”contact”:”001894536″>
org.codehaus.jackson.map.JsonMappingException: No suitable constructor found for type [simple type, class gson.Main$Person]: can not instantiate from JSON object (need to add/enable type information?)
at [Source: java.io.StringReader@146ba0ac; line: 1, column: 2]
at org.codehaus.jackson.map.JsonMappingException.from(JsonMappingException.java:163)
at org.codehaus.jackson.map.deser.BeanDeserializer.deserializeFromObjectUsingNonDefault(BeanDeserializer.java:740)
at org.codehaus.jackson.map.deser.BeanDeserializer.deserializeFromObject(BeanDeserializer.java:683)
at org.codehaus.jackson.map.deser.BeanDeserializer.deserialize(BeanDeserializer.java:580)
at org.codehaus.jackson.map.ObjectMapper._readMapAndClose(ObjectMapper.java:2723)
at org.codehaus.jackson.map.ObjectMapper.readValue(ObjectMapper.java:1854)
at gson.Main.main(Main.java:47)
BUILD SUCCESSFUL (total time: 0 seconds)

i am try the above code but i end up with this error all the time

org.codehaus.jackson.map.JsonMappingException: Can not instantiate value of type [simple type, class com.util.Docker_Sims] from JSON String; no single-String constructor/factory method
at org.codehaus.jackson.map.deser.std.StdValueInstantiator._createFromStringFallbacks(StdValueInstantiator.java:379)
at org.codehaus.jackson.map.deser.std.StdValueInstantiator.createFromString(StdValueInstantiator.java:268)
at org.codehaus.jackson.map.deser.BeanDeserializer.deserializeFromString(BeanDeserializer.java:765)
at org.codehaus.jackson.map.deser.BeanDeserializer.deserialize(BeanDeserializer.java:585)
at org.codehaus.jackson.map.ObjectMapper._readMapAndClose(ObjectMapper.java:2732)
at org.codehaus.jackson.map.ObjectMapper.readValue(ObjectMapper.java:1817)
at com.util.DBUtil.main(DBUtil.java:43)

Hello. Great, thanks,
But how to parse a JSon String that starts with a “prefix” like:

The ObjectMapper.readValue(string, User.class) will certainly fail.
Any idea ?

That is object in object , one way would be to create two class one for inner object(“name”…..), and another for “record”. and initializing those variables

I have written webservies in java after when i heat the url username and password then that he is return only two value or remaining value is null how can solve this problem plz anybody help me sir…

Please teach me to “heat” the url. BBQ?!

I have written webservies in java after that he is return only two value or remaining value is null how can solve this problem plz anybody help me sir…

Hi Mr. Mkyong, thanks for your tutorial. Can you give real scenarios in software where it is necessary serialization to convert Object to Json or Json to object ?

[…] Jackson 1.x – Object to JSON […]

As always – saved my day. Thanks

Hi can anyone tell me how to convert java object to xml using jackson?

add jackson mappeer jar to it and try again

hi mkyong i am fan of u i am reading ur tutorials it is very helpful to me

as always. thanks рџ™‚

I need to convert a jason file similar to [<“age”:29,”,”name”:”mkyong”>,<“age”:35,”,”name”:”Tom”>]. Assume I have a User class. I’m referring to above 4th example (Jason to Java Object). Can I create ArrayList of User objects? Pls give me a code sample.

Hi,
Thank you for the examples. I wanted to know how do you verify the fields in the deserialized object i.e. the Java object obtained from JSON is valid. i.e I want to verify that all the fields in the Java obejct are the same from the JSON response. Do I have to do some kind of depth first search on the object since it can be nested too. Any pointers would be helpful

The above is a great example of serializing and deserializing one user object in json format. But how can I deserialize a list of user objects? I want to deserialize a list of pojos.

Thank you for any help you can provide quickly.

Источник

Урок 14. Знакомство с форматом JSON. Парсинг JsonObject на примере объекта User

В этом уроке мы с вами более подробно познакомимся с форматом JSON . А потом из этого формата получим наш User объект.

JSON стал общепринятым форматом для обмена данными в клиент-серверных приложения. Он является универсальным форматом для обмена данными.

Представьте, что вам нужно создать систему приложений, в которую входит, сервер, web -клиент, ios -клиент, android -клиент. У всех технологий разные языки,
разные особенности. Поэтому сервер отвечает в формате JSON , а клиенты на своей стороне приводят к нужному формату ответы. Подробнее про JSON формат можно
почитать здесь, но на данном этапе ваших знаний уже вполне хватит.

JSONObject, работа с JSON в java коде

Давайте создадим новый класс в пакете network и назовём его JsonParser для преобразования Json -строк в необходимые нам объекты. Добавим в него один
метод, который назовём getUser(String response) :

Мы будем использовать этот метод внутри класса HttpClient , передавая в него ответ от сервера в формате String , возвращая объект User . Давайте
разберём преобразование, рассмотрим структура хранения JSON . В прошлом уроке мы в конце вывели ответ от сервера в log и увидели очень большой объект JSON .
На данном этапе нам необходимы только те поля, которые мы отображаем на экране. Поэтому опустим остальные поля и оставим только те, которые нам нужны:

Видим, что наш JSON полностью повторяет структуру нашего объекта User . Теперь можно приступить к парсингу (преобразованию) данных.

Первое, что необходимо сделать – это создать JSON объект из строки:

Видим, что AndroidStudio подчёркивает эту строку, указывая что надо обработать исключение или добавить его к сигнатуре метода. Можем нажать alt + enter
и увидеть два этих варианта решения проблемы. Добавим исключение к сигнатуре, чтобы обработать исключения в клиентском коде. Для этого выберем вариант Add exception to method signature :

JSONObject представляет из себя структуру типа HashMap (ключ – значение).
Т.е. чтобы получить значения поля id нам необходимо выполнить вызов метода
userJson.getLong(«id») (получить значение типа long по ключу (названию поля) id ). Давайте сделаем тоже самое для каждого поля.
После этого метод будет выглядеть так:

Т.е. вот так по названию поля мы можем достать его значение. Нам попался самый простой случай, где наши значения являются примитивными типами. На практике мы
поработаем с массивами элементов и вложенными объектами.

Давайте создадим объект User , передав ему в конструктор все поля, которые мы только что достали из userJson :

Вот и всё! Теперь давайте добавим использование нашего класса внутри класса HttpClient .

Добавили JsonParser как final поле в классе HttpClient и инициализируем его в конструкторе.

После этого добавили строку User user = jsonParser.getUser(response); в конец метода getUserInfo и поменяли возвращаемый тип на User и добавили новое
исключение JSONException в сигнатуру метода. Отлично, теперь изменим код в UserInfoActivity и запустим приложение.

в UserInfoActivity нам нужно изменить метод loadUserInfo :

Возвращаемый тип Asynctask со String на User .

Добавили в catch блок перехват исключения типа IOException | JSONException .

В onPostExecute мы заменили вызов Log.d() на вызов реального метода отображения displayUserInfo(user) .

Давайте запустим наше приложение:

Всё работает! Только видим, что наш ник выводится без символа @ . Давайте изменим метод getNick() в классе User . Будем добавлять в него символ @ самостоятельно, т.к. сервер этого не сделал.

Запустим наше приложение и увидим, что теперь с форматом поля nick всё в порядке:

Источник

Шпаргалка 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.

Источник