что такое json в java
Работа с JSON
Необходимые знания: | Базовая компьютерная грамотность, базовые знания HTML и CSS, знакомство с основами JavaScript (см. First steps и Building blocks) и основами OOJS (see Introduction to objects). |
---|---|
Цель: | Понять, как работать с данными, хранящимися в JSON, и создавать свои собственные объекты JSON. |
Нет, действительно, что такое JSON?
JSON существует как строка,что необходимо при передаче данных по сети. Он должен быть преобразован в собственный объект JavaScript, если вы хотите получить доступ к данным. Это не большая проблема. JavaScript предоставляет глобальный объект JSON, который имеет методы для преобразования между ними.
Структура JSON
Чтобы получить доступ к последующим данным по иерархии, вам просто нужно объединить требуемые имена свойств и индексы массивов. Например, чтобы получить доступ к третьей сверхспособности второго героя, указанного в списке участников, вы должны сделать следующее:
Примечание. Мы сделали JSON, видимый выше, доступным внутри переменной в нашем примере JSONTest.html (см. исходный код). Попробуйте загрузить это, а затем получить доступ к данным внутри переменной через консоль JavaScript вашего браузера.
Массивы как JSON
Другие примечания
Активное обучение: Работа с примером JSON
Итак, давайте рассмотрим пример, чтобы показать то, как мы можем использовать некоторые данные JSON на веб-сайте.
Урок 14. Знакомство с форматом JSON. Парсинг JsonObject на примере объекта User
JSON стал общепринятым форматом для обмена данными в клиент-серверных приложения. Он является универсальным форматом для обмена данными.
JSONObject, работа с JSON в java коде
Первое, что необходимо сделать – это создать JSON объект из строки:
Видим, что AndroidStudio подчёркивает эту строку, указывая что надо обработать исключение или добавить его к сигнатуре метода. Можем нажать alt + enter
и увидеть два этих варианта решения проблемы. Добавим исключение к сигнатуре, чтобы обработать исключения в клиентском коде. Для этого выберем вариант Add exception to method signature :
JSONObject представляет из себя структуру типа HashMap (ключ – значение).
Т.е. чтобы получить значения поля id нам необходимо выполнить вызов метода
userJson.getLong(«id») (получить значение типа long по ключу (названию поля) id ). Давайте сделаем тоже самое для каждого поля.
После этого метод будет выглядеть так:
Т.е. вот так по названию поля мы можем достать его значение. Нам попался самый простой случай, где наши значения являются примитивными типами. На практике мы
поработаем с массивами элементов и вложенными объектами.
Добавили JsonParser как final поле в классе HttpClient и инициализируем его в конструкторе.
После этого добавили строку User user = jsonParser.getUser(response); в конец метода getUserInfo и поменяли возвращаемый тип на User и добавили новое
исключение JSONException в сигнатуру метода. Отлично, теперь изменим код в UserInfoActivity и запустим приложение.
в UserInfoActivity нам нужно изменить метод loadUserInfo :
Давайте запустим наше приложение:
Запустим наше приложение и увидим, что теперь с форматом поля nick всё в порядке:
Чтение и запись JSON на Java
Что такое JSON?
Несмотря на то, что ДЖЕЙСОН был получен из JavaScript, это независимый от платформы формат. Вы можете работать с ним на нескольких языках программирования, включая Java, Python, Ruby и многие другие. Действительно, любой язык, который может анализировать строку, может обрабатывать JSON.
Одним из основных преимуществ JSON по сравнению с форматом данных XML является размер документа. Поскольку JSON не имеет схем, нет необходимости переносить огромные структурные накладные расходы, такие как пространства имен и оболочки.
JSON-это универсальный формат данных, который имеет шесть типов данных:
Давайте взглянем на простой документ JSON:
Эта структура определяет объект, представляющий человека по имени “Бенджамин Уотсон”. Здесь мы можем ознакомиться с его подробностями, такими как его возраст, семейное положение и хобби.
json-просто
Этот модуль полностью соответствует спецификации JSON RFC4627 и обеспечивает основные функциональные возможности, такие как кодирование и декодирование объектов JSON, и не имеет никаких зависимостей от внешних модулей.
Давайте создадим простой метод, который будет принимать имя файла в качестве параметра и записывать некоторые жестко закодированные данные JSON:
Чтобы запустить этот код, мы должны создать точку входа в наше приложение, которая могла бы выглядеть следующим образом:
В результате выполнения этого кода мы получим файл с именем example.json в корне нашего пакета. Содержимое файла будет документом JSON со всеми свойствами, которые мы ввели:
Отлично! У нас только что был наш первый опыт работы с форматом JSON, и мы успешно сериализовали в него объект Java и записали его в файл.
Теперь, с небольшим изменением нашего исходного кода, мы можем прочитать объект JSON из файла и распечатать его на консоли либо полностью, либо распечатать выбранные отдельные свойства:
Если у вас неправильный или поврежденный документ JSON, вы получите исключение, подобное этому:
Копать Глубже
Несмотря на то, что json-простой полезен, он не позволяет нам использовать пользовательские классы без написания дополнительного кода. Давайте предположим, что у нас есть класс, представляющий человека из нашего первоначального примера:
Давайте возьмем документ JSON, который мы использовали в качестве примера в начале, и поместим его в файл example.json :
Это выглядит не очень хорошо, у нас много странных типов, но, похоже, это делает свою работу, верно?
Git Essentials
Ознакомьтесь с этим практическим руководством по изучению Git, содержащим лучшие практики и принятые в отрасли стандарты. Прекратите гуглить команды Git и на самом деле изучите это!
Как мы видим, первый вывод консоли показывает, казалось бы, хороший результат:
но второй выдает Исключение :
Это большая проблема, которую, я уверен, вы сможете преодолеть, написав кучу очень умного кода, которым вы могли бы гордиться, но есть простой способ сделать это с самого начала.
Джексон
Давайте добавим его в качестве новой зависимости Maven:
ObjectMapper может быть настроен с несколькими различными параметрами, переданными в конструктор:
FAIL_ON_SELF_РЕФЕРЕНЦИИ | Функция, которая определяет, что происходит, когда прямая самоссылка обнаруживается POJO (и для нее не включена обработка идентификатора объекта): либо создается исключение JsonMappingException (если это правда), либо ссылка обычно обрабатывается (ложь). |
ОТСТУП_ВЫХОД | Функция, которая позволяет включать (или отключать) отступы для базового генератора, используя принтер pretty по умолчанию, настроенный для ObjectMapper (и авторов объектов, созданных из mapper). |
ORDER_MAP_ENTRIES_BY_KEYES | Функция, определяющая, будут ли записи карты сначала отсортированы по ключу перед сериализацией или нет: если включено, при необходимости выполняется дополнительный шаг сортировки (не требуется для отсортированных карт), если отключено, дополнительная сортировка не требуется. |
USE_EQUALITY_FOR_OBJECT_ID | Функция, определяющая, сравнивается ли идентичность объекта с использованием истинной идентичности объекта на уровне JVM (ложь); или метод equals (). |
Функция, определяющая, как сериализуется тип char []: при включении сериализуется как явный массив JSON (с односимвольными строками в качестве значений); при отключении по умолчанию сериализуется как строки (что более компактно). | |
МЕТКИ ВРЕМЕНИ WRITE_DATE_KEYS_AS_TIMESTAMPS | Функция, определяющая, будут ли даты (и подтипы), используемые в качестве ключей карты, сериализованы как метки времени или нет (если нет, будут сериализованы как текстовые значения). |
WRITE_DATE_TIMESTAMPS_АС_НАНОСЕКУНДЫ | Функция, которая определяет, следует ли записывать числовые значения временных меток с использованием наносекундных временных меток (включено) или нет (отключено); если и только если тип данных поддерживает такое разрешение. |
МЕТКИ ВРЕМЕНИ WRITE_DATES_AS_TIMESTAMPS | Функция, которая определяет, следует ли сериализовать значения даты (и даты/времени) (и такие вещи, основанные на данных, как календари), как числовые метки времени (true; по умолчанию) или как что-то другое (обычно текстовое представление). |
WRITE_DATES_С_ЗОНОМ_ИД | Функция, которая определяет, следует ли сериализовать значения даты/времени так, чтобы они включали идентификатор часового пояса, в тех случаях, когда сам тип содержит информацию о часовом поясе. |
К сожалению, после запуска этого фрагмента кода мы получим исключение:
Судя по всему, мы должны добавить конструктор по умолчанию в класс Person :
При повторном запуске кода мы увидим еще одно исключение:
Этот вопрос немного сложнее решить, так как сообщение об ошибке не говорит нам, что делать для достижения желаемого результата. Игнорирование свойства не является жизнеспособным вариантом, поскольку мы явно указываем его в документе JSON и хотим, чтобы он был переведен в результирующий объект Java.
Больше никаких исключений не появляется, и мы видим желаемый результат!
Хотя результат удовлетворяет, есть лучший способ обойти это, чем добавлять еще один is к каждому из ваших логических геттеров.
Мы можем достичь того же результата, добавив аннотацию к методу женат() :
Таким образом, мы явно сообщаем Джексону название поля, и ему не нужно угадывать. Это может быть особенно полезно в тех случаях, когда поле называется совершенно иначе, чем геттеры.
Вывод
JSON-это легкий текстовый формат, который позволяет нам представлять объекты и передавать их через Интернет или хранить в базе данных.
Работая с JSON, вы должны иметь в виду нюансы модулей, с которыми вы работаете, и тщательно отлаживать исключения, которые могут появляться.
Шпаргалка 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 парсеры
Существует три основных способа сериализации и десериализации среди указанных библиотек (от самого простого к самому сложному) и один дополнительный:
Давайте рассмотрим с чем их едят:
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. Зато никаких ограничений по памяти и в теории максимальная производительность.
Плюсы: производительность и минимальное потребление памяти,
Минусы: сложность использования,
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.
Как и чем парсить Json на Java?
Часто возникает потребность работы с Json, в частности его чтения и парсинга. В Java обычно ты знаешь с каким типом переменных работаешь, а при парсинге Json смущает то, что тип полей может быть любой.
Какие есть способы разбора Json? Как это делать?
Вот, допустим, как достать данные из Json, представленного ниже?
4 ответа 4
Достать данные можно разными способами и, конечно, зависит от задач. Попробую рассмотреть некоторые варианты разбора Json.
Заметка: для каждого из примеров для парсинга будет взят Json из вопроса, чтобы зря не копировать в ответ.
Simple Json
Где взять: здесь / репозиторий на github / или через Maven и пр.
Я бы использовал его для небольших Json строк, где не надо сильно заморачиваться или если не лень писать свой класс-обработчик на основе кода, который продемонстрирован ниже:
Остальная работа с вложенными массивами аналогична. Можно складывать в List, Map и пр.
Где взять: здесь / репозиторий на github / или через Maven и пр.
Позволяет парсить Json также, как и Json-simple, т.е. используя JSONObject и JSONArray (см. документацию), но имеет более мощный инструмент парсинга. Достаточно создать классы, которые повторяют структуру Json‘а. Для парсинга Json из вопроса создадим классы:
Теперь достаточно написать:
Пример парсинга в Map :
. Сам разбор выглядит так:
Jackson
Где взять: здесь / репозиторий на github / или через Maven и пр.
Как и GSON он также позволяет работать используя JSONObject и JSONArray если это требуется, и тоже умеет парсить на основе предоставленных классов (см. пример ниже).
JsonPath
Где взять: через Maven и другие сборщики / репозиторий на github
Относится к так называемым XPath библиотекам. Её суть аналогична xpath в xml, то есть легко получать часть информации из json‘а, по указанному пути. А также позволяет фильтровать по условию.
Пример с выборкой по условию:
Еще несколько вариантов
LoganSquare
Где взять: репозиторий на github / или через Maven / Gradle и пр.
Moshi
Moshi is a modern JSON library for Android and Java.
Хорош, как утверждают разработчики, для работы с Android.
Где взять: репозиторий на github / или через Maven / Gradle и пр.
Пример разбора Json строки в объект Person :
Пример парсинга в Map :
Genson
Где взять: здесь / репозиторий на github / или через Maven и пр.
Пример парсинга в Map :
FastJson
Где взять: через Maven и другие сборщики / репозиторий на github. Непосредственно описание работы с xpath. Осторожно, ̶н̶е̶н̶о̶р̶м̶а̶т̶и̶в̶н̶а̶я̶ ̶л̶е̶к̶с̶и̶к̶а̶ китайский язык.
Относится к XPath аналогам.
JSON-P
Поддерживает сериализацию и парсинг JSON без предварительного маппинга в классах:
Maven:
Пример разбора строки JSON:
Пример вывода объекта в строку JSON:
Здесь расположена общая информация о парсерах, которая может помочь при выборе и понять, что он умеет. Текст и таблица, представленные ниже, взяты из публикации на Habrahabr: Шпаргалка Java программиста 8. Библиотеки для работы с Json, автор статьи @ВеденинВячеслав
Существует следующие способы сериализации и десериализации среди указанных библиотек (от самого простого к самому сложному):
Data bind
Плюсы: наиболее простой из всех
Минусы: скорость и память. Большинство библиотек использует рефлексию и т.п. методы работы с Java классами (хотя не все), что очевидно не очень быстро. К тому же, весь json файл сразу превращается в Java объекты, что может просто исчерпать всю доступную память, если вы попытаетесь обработать очень большой json.
Вывод: если нет проблем с производительностью, памятью и вы не собираетесь обрабатывать многогигабайтные json’ы скорее всего самый лучший способ.
Tree Model
Данный парсер представляет json в виде Java классов таких как Node или `JsonElement c иерархической структурой, а уже сам программист их обходит и получает из них информацию.
Плюсы: обычно быстрее первого способа и проще третьего
Минусы: уступает Data bind по простоте, плюс ряд библиотек способен генерить классы при Data bind, а не использовать рефлексию, в этом случае то что Tree Model будет быстрее не очевидно, к тому же не решается проблема огромных файлов и ограничения памяти.
Streaming API
Самый низкоуровневый способ, по сути программист сам вручную разбирает токены json’a. Зато никаких ограничений по памяти и в теории максимальная производительность.
Плюсы: производительность и минимальное потребление памяти
Минусы: сложность использования
Аналоги XPath
Плюсы: позволяет быстро получить информацию из json‘а по сложным критериям
Минусы: не очень подходит, когда нужна все информация из json‘а, не работает в обратную сторону на формирования json‘ов
Таблица библиотек и способы парсинга, которые они поддерживают:
* — Генерация классов для Data bind позволяет сгенерировать классы на стадии компиляции, что в теории должно давать значительный прирост производительности библиотеки,
** — Работает со static inner class имеет смысл только для случая Data bind, возможно ли сериализация и десериализация для случая статических внутренних классов (не статические внутренние классы сериализовать не рекомендуется),
*** — тоже только для случая Data bind можно ли не использовать аннотации или их использование крайне рекомендуется,