Форматирование JSON в ObjectMapper Jackson 2.2: подробный гайд

Быстрый ответ

Чтобы ваш JSON выглядел более структурированно при использовании Jackson, настройте ObjectMapper следующим образом:

ObjectMapper mapper = new ObjectMapper().enable(SerializationFeature.INDENT_OUTPUT);
String json = mapper.writeValueAsString(yourObject); // Замените yourObject на ваш объект данных

Включите INDENT_OUTPUT, чтобы ваш JSON был более структурированным благодаря добавлению необходимых отступов.

Подробная настройка

Приведение строки в порядок

Если у вас есть JSON в виде строки, которая выглядит неопрятно, и вы хотите сделать её более читаемой, используйте метод writerWithDefaultPrettyPrinter:

// "Начинается процесс форматирования..."
String prettyJsonString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(jsonInstance);

Подробнее об этом расскажет наш спикер на видео

Запись в файл

Вы можете записать отформатированные и структурно оформленные данные JSON непосредственно в файл, чтобы сохранить их в удобочитаемом виде:

// "И вот ваш красиво оформленный JSON!"
mapper.writerWithDefaultPrettyPrinter().writeValue(new File("output.json"), yourObject); // json-данные готовы к использованию!

Gson: Альтернатива

Если хотите попробовать другой подход с использованием библиотеки Gson, её API предлагает следующий метод для форматированного вывода:

String json = new GsonBuilder().setPrettyPrinting().create().toJson(yourObject); // И вот ваш отформатированный JSON!

От обычного файла к красивому

Чтобы преобразовать неструктурированный JSON-файл в отформатированную строку, выполните следующие действия:

byte[] jsonData = Files.readAllBytes(Paths.get(filePath)); 
YourClass yourObject = objectMapper.readValue(jsonData, YourClass.class);
String prettyJson = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(yourObject); // Пора для отформатированных данных!

Визуализация

Сравним визуально базовую настройку ObjectMapper и достижимый результат с применением форматирования:

ObjectMapper mapper = new ObjectMapper();
mapper.enable(SerializationFeature.INDENT_OUTPUT); // Добавляем форматирование!

Иллюстрация преобразования:

До:

{"name":"John","age":30,"city":"New York"}

После:

{
  "name": "John",
  "age": 30,
  "city": "New York"
}

Опция INDENT_OUTPUT как магия преобразует неструктурированный JSON в удобоваримый и понятный формат.

Работаем с ObjectMapper

Соблюдаем правила

При использовании ObjectMapper, помните о важности следующих моментов:

• Убедитесь, что в ваших классах имеются корректные геттеры и сеттеры.
• Будьте готовы к обработке исключений, которые могут возникнуть во время работы.

Настраиваем отступы

Вы можете установить величину отступов под свои предпочтения:

DefaultPrettyPrinter printer = new DefaultPrettyPrinter().withIndent("    "); // 4 пробела создают отличное форматирование!
String customPrettyJson = mapper.writer(printer).writeValueAsString(yourObject);

Мощность парсинга

ObjectMapper прекрасно работает не только с сериализацией, но и с чтением JSON:

YourClass obj = mapper.readValue(jsonString, YourClass.class); // Удобный и быстрый парсинг данных.

Он умеет работать со строками, файлами, потоками данных и другими источниками.

Вывод на консоль

Чтобы быстро посмотреть на результат форматирования или продемонстрировать его кому-либо, выведите JSON на консоль:

System.out.println(prettyJson); // "Вот так выглядит мой отформатированный JSON!"

Не забывайте использовать актуальную версию Jackson для возможности эффективного форматирования.

Полезные материалы

1. java – Jackson Vs. Gson – Stack Overflow — Сравнение двух популярных библиотек для работы с JSON — Jackson и Gson.
2. Jackson Tutorial — Полное руководство по многофункциональной библиотеке обработки JSON Jackson.
3. Customize Jackson JSON Mapping — Персонализация маппинга JSON в объекты Java с использованием Jackson.
4. Pretty Print JSON With Jackson — Примеры форматирования JSON с использованием Jackson.
5. Jackson Annotation Examples — Обзор и примеры использования аннотаций Jackson, контролирующих процессы сериализации и десериализации.