Привет, странник. Сегодня я хочу поведать тебе о небольшой магии. Ты наверно уже слышал про json. Это такой универсальный язык: его понимает машина и легко читает человек.
Вот типичный пример json сообщения:
Удобно ведь так общаться, правда? Если до этого ты не знал, что такое json, теперь знаешь.
Как это использовать в java коде?
Json стал универсальным форматом. Расшифровывается он как JavaScript Object Notation, но уже давно вышел за пределы javascript и используется почти везде. В java есть несколько библиотек, упрощающих работу с json. Вот самые известные:
Я буду использовать вторую. Там их 2 версии codehaus и fasterxml, отличий в них не замечал, так что тут можете использовать любую.
Вот такой кусок кода:
ObjectMapper mapper = new ObjectMapper();
return mapper.readValue("сюда json", "сюда класс");
поможет перевести json в объект. И мы приближаемся к самому главному. Написанию класса для этого json. Можно это делать руками, создать структуру примерно такую:
-----------------------------------com.fairytale.Base.java-----------------------------------
package com.fairytale;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
"type",
"quantity"
})
public class Base {
@JsonProperty("type")
public String type = "";
@JsonProperty("quantity")
public int quantity = 0;
}
-----------------------------------com.fairytale.Hut.java-----------------------------------
package com.fairytale;
import java.util.ArrayList;
import java.util.List;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
"room",
"base",
"residents",
"location"
})
public class Hut {
@JsonProperty("room")
public Room room;
@JsonProperty("base")
public Base base;
@JsonProperty("residents")
public List<Resident> residents = new ArrayList<Resident>();
@JsonProperty("location")
public Location location;
}
-----------------------------------com.fairytale.Location.java-----------------------------------
package com.fairytale;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
"address"
})
public class Location {
@JsonProperty("address")
public String address = "";
}
-----------------------------------com.fairytale.Resident.java-----------------------------------
package com.fairytale;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
"name",
"profile"
})
public class Resident {
@JsonProperty("name")
public String name = "";
@JsonProperty("profile")
public String profile = "";
}
-----------------------------------com.fairytale.Room.java-----------------------------------
package com.fairytale;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
"name",
"reasonable"
})
public class Room {
@JsonProperty("name")
public String name = "";
@JsonProperty("reasonable")
public boolean reasonable = false;
}
Я специально опустил геттеры, сеттеры, конструкторы и прочие атрибуты pojo, иначе ты устал бы проматывать =)
А теперь посмотри сюда:
Это json схема структуры выше. Теперь пора объяснить, зачем она тебе.
Она избавит от необходимости писать классы и поддерживать их. Есть такой хороший проект jsonschema2pojo. Он предлагает плагины для сборщиков проекта (мавен, грейдл), которые напишут эти классы для тебя во время сборки.
Приведу пример из моего проекта:
Это указание, как писать класс:
useCommonsLang3 – использовать библиотеку CommonsLang3
includeConstructors – напишет конструктор
generateBuilders – встроит паттерн билдер
includeToString – добавит toString
usePrimitives – указание использовать примитивы
Чем это лучше самописного кода?
Вы можете кастомизировать классы одной строчкой. Например, надо добавить суффикс Pojo к каждому классу. Достаточно добавить <classNameSuffix>Pojo</classNameSuffix> собирать проект — и готово. Иначе пришлось бы менять имена каждому класс руками.
Этих параметров очень много, обо всех стоит почитать в доках
Если у твоего проекта есть потребитель, намного проще будет отдать ему json схемы, а не java классы. Как я уже говорил, схемы универсальны и потребитель просто сгенерит pojo на своем языке.
Они гораздо меньше. Пример сверху содержит много не всегда нужной информации, скажем, паттерны и примеры. Но если вернуть их в java код, он тоже сильно вырастет. И не забудь про шаблонный код, который в схемах указывается парой настроек в плагине, а в коде его надо писать самому. И да, я знаю про ломбок, тут альтернатива.
Никакой логики в pojo. Когда ваши классы самописные, кто-то может соблазниться и добавить удобный ему метод. В json схемы метод добавить нельзя, как и в сгенерированный класс.
Наверно, на этом все.
Вывод:
Я старался донести, что json схемы очень хороший формат взаимодействия между проектами. Однажды я с ним встретился на одном проекте, и он запал мне в сердце. Я использую их почти везде. Да, это не всегда удобно, ведь чтобы посмотреть исходники, надо собирать проект. Но это pojo, а значит, логики там быть не может, со схемами и не будет.
PS.. я иногда объясняю плохо, так что вот видео с хорошим докладом:
Кирилл Меркушев — Кодогенерация как способ решения проблем автоматизатора.
Ребят вопрос немного не по теме, но может кто нибудь видел классный сайт с генерацией джейсон файлов с рандомными данными(бесплатно до 1000 записей разрешают), там можно было еще задавать количество полей, их названия, типы. я 2 раза в каких то статьях натыкался, но по глупости не сохранил себе, думал легко найти смогу, но вот что то не получается. Буду очень признателен, если у кого то есть
Интересно... но для меня пока как то сложно и не совсем понятно применение. Не могу понять для автоматизации постройки каких типов классов его использовать.
впервые о таком читаю, спасибо :)
но лично мне схема выглядит намного сложнее самого класса. да и в примере код с классами получился на 15 строк короче самой схемы))
в общем, со своими классами (+ломбок) - как-то "понятнее" и привычнее)) но за альтернативу спасибо :)
ПЕРЕЙДИТЕ В ПОЛНУЮ ВЕРСИЮ