Введение в Джексон ObjectMapper

1. обзор

Эта статья посвящена пониманию класса JacksonObjectMapper и тому, как сериализовать объекты Java в JSON и десериализовать строку JSON в объекты Java. Чтобы понять больше о библиотеке Джексона в целом, неплохо начать сJackson Tutorial.

Дальнейшее чтение:

Наследование с Джексоном

Из этого туториала вы узнаете, как обрабатывать включение метаданных подтипа и игнорировать свойства, унаследованные от суперклассов с Джексоном.

Джексон JSON Просмотров

Как использовать аннотацию @JsonView в Джексоне для идеального управления сериализацией ваших объектов (без Spring и с Spring).

Джексон - Custom Serializer

Управляйте выводом JSON с помощью Jackson 2 с помощью пользовательского сериализатора.

2. зависимости

Давайте сначала добавим следующие зависимости кpom.xml:


    com.fasterxml.jackson.core
    jackson-databind
    2.9.8

Эта зависимость также транзитивно добавляет следующие библиотеки в путь к классам:

jackson-annotations-2.9.8.jar
jackson-core-2.9.8.jar
jackson-databind-2.9.8.jar

Всегда используйте последние версии в центральном репозитории Maven дляJackson databind.

3. Чтение и запись с использованиемObjectMapper

Начнем с основных операций чтения и записи.

The simple readValue API of the ObjectMapper is a good entry point. Мы можем использовать его для анализа или десериализации содержимого JSON в объект Java.

Кроме того, что касается записи,we can use the writeValue API to serialize any Java object as JSON output.

В этой статье мы будем использовать следующий классCar с двумя полями в качестве объекта для сериализации или десериализации:

public class Car {

    private String color;
    private String type;

    // standard getters setters
}

3.1. Объект Java в JSON

Давайте посмотрим на первый пример сериализации Java-объекта в JSON с использованием методаwriteValue классаObjectMapper:

ObjectMapper objectMapper = new ObjectMapper();
Car car = new Car("yellow", "renault");
objectMapper.writeValue(new File("target/car.json"), car);

Вывод вышеупомянутого в файле будет:

{"color":"yellow","type":"renault"}

МетодыwriteValueAsString иwriteValueAsBytes классаObjectMapper генерируют JSON из объекта Java и возвращают сгенерированный JSON в виде строки или массива байтов:

String carAsString = objectMapper.writeValueAsString(car);

3.2. JSON в объект Java

Ниже приведен простой пример преобразования строки JSON в объект Java с использованием классаObjectMapper:

String json = "{ \"color\" : \"Black\", \"type\" : \"BMW\" }";
Car car = objectMapper.readValue(json, Car.class);

ФункцияreadValue() также принимает другие формы ввода, такие как файл, содержащий строку JSON:

Car car = objectMapper.readValue(new File("src/test/resources/json_car.json"), Car.class);

или URL:

Car car = objectMapper.readValue(new URL("file:src/test/resources/json_car.json"), Car.class);

3.3. JSON в ДжексонJsonNode

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

String json = "{ \"color\" : \"Black\", \"type\" : \"FIAT\" }";
JsonNode jsonNode = objectMapper.readTree(json);
String color = jsonNode.get("color").asText();
// Output: color -> Black

3.4. Создание списка Java из строки массива JSON

Мы можем проанализировать JSON в форме массива в список объектов Java, используяTypeReference:

String jsonCarArray =
  "[{ \"color\" : \"Black\", \"type\" : \"BMW\" }, { \"color\" : \"Red\", \"type\" : \"FIAT\" }]";
List listCar = objectMapper.readValue(jsonCarArray, new TypeReference>(){});

3.5. Создание карты Java из строки JSON

Точно так же мы можем разобрать JSON на JavaMap:

String json = "{ \"color\" : \"Black\", \"type\" : \"BMW\" }";
Map map
  = objectMapper.readValue(json, new TypeReference>(){});

4. Расширенные возможности

Одна из самых сильных сторон библиотеки Джексона - это настраиваемый процесс сериализации и десериализации.

В этом разделе мы рассмотрим некоторые дополнительные функции, в которых входной или выходной ответ JSON может отличаться от объекта, который генерирует или потребляет ответ.

4.1. Настройка функции сериализации или десериализации

При преобразовании объектов JSON в классы Java, если в строке JSON появятся новые поля, процесс по умолчанию приведет к исключению:

String jsonString
  = "{ \"color\" : \"Black\", \"type\" : \"Fiat\", \"year\" : \"1970\" }";

Строка JSON в приведенном выше примере в процессе синтаксического анализа по умолчанию для объекта Java дляClass Car приведет к исключениюUnrecognizedPropertyException.

С помощью методаconfigure мы можем расширить процесс по умолчанию, чтобы игнорировать новые поля:

objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
Car car = objectMapper.readValue(jsonString, Car.class);

JsonNode jsonNodeRoot = objectMapper.readTree(jsonString);
JsonNode jsonNodeYear = jsonNodeRoot.get("year");
String year = jsonNodeYear.asText();

Еще один вариант основан наFAIL_ON_NULL_FOR_PRIMITIVES, который определяет, разрешены ли значенияnull для примитивных значений:

objectMapper.configure(DeserializationFeature.FAIL_ON_NULL_FOR_PRIMITIVES, false);

Точно так жеFAIL_ON_NUMBERS_FOR_ENUM контролирует, разрешено ли сериализовать / десериализовать значения перечисления как числа:

objectMapper.configure(DeserializationFeature.FAIL_ON_NUMBERS_FOR_ENUMS, false);

Вы можете найти полный список функций сериализации и десериализации наofficial site.

4.2. Создание настраиваемого сериализатора или десериализатора

Еще одна важная особенность классаObjectMapper - это возможность регистрировать собственныеserializer иdeserializer. Пользовательский сериализатор и десериализатор очень полезны в ситуациях, когда входной или выходной ответ JSON отличается по структуре от класса Java, в который он должен быть сериализован или десериализован.

Ниже приведен пример настраиваемого сериализатора JSON:

public class CustomCarSerializer extends StdSerializer {

    public CustomCarSerializer() {
        this(null);
    }

    public CustomCarSerializer(Class t) {
        super(t);
    }

    @Override
    public void serialize(
      Car car, JsonGenerator jsonGenerator, SerializerProvider serializer) {
        jsonGenerator.writeStartObject();
        jsonGenerator.writeStringField("car_brand", car.getType());
        jsonGenerator.writeEndObject();
    }
}

Этот пользовательский сериализатор может быть вызван так:

ObjectMapper mapper = new ObjectMapper();
SimpleModule module =
  new SimpleModule("CustomCarSerializer", new Version(1, 0, 0, null, null, null));
module.addSerializer(Car.class, new CustomCarSerializer());
mapper.registerModule(module);
Car car = new Car("yellow", "renault");
String carJson = mapper.writeValueAsString(car);

Вот как выглядитCar (как вывод JSON) на стороне клиента:

var carJson = {"car_brand":"renault"}

А вот примерa custom JSON deserializer:

public class CustomCarDeserializer extends StdDeserializer {

    public CustomCarDeserializer() {
        this(null);
    }

    public CustomCarDeserializer(Class vc) {
        super(vc);
    }

    @Override
    public Car deserialize(JsonParser parser, DeserializationContext deserializer) {
        Car car = new Car();
        ObjectCodec codec = parser.getCodec();
        JsonNode node = codec.readTree(parser);

        // try catch block
        JsonNode colorNode = node.get("color");
        String color = colorNode.asText();
        car.setColor(color);
        return car;
    }
}

Этот пользовательский десериализатор может быть вызван следующим образом:

String json = "{ \"color\" : \"Black\", \"type\" : \"BMW\" }";
ObjectMapper mapper = new ObjectMapper();
SimpleModule module =
  new SimpleModule("CustomCarDeserializer", new Version(1, 0, 0, null, null, null));
module.addDeserializer(Car.class, new CustomCarDeserializer());
mapper.registerModule(module);
Car car = mapper.readValue(json, Car.class);

4.3. Обработка форматов дат

Сериализация по умолчаниюjava.util.Date дает число, т.е. метка времени эпохи (количество миллисекунд с 1 января 1970 года по Гринвичу). Но это не очень удобочитаемо и требует дальнейшего преобразования для отображения в удобочитаемом формате.

Давайте обернем экземплярCar, который мы использовали до сих пор, в классRequest со свойствомdatePurchased:

public class Request
{
    private Car car;
    private Date datePurchased;

    // standard getters setters
}

Для управления форматом даты String и установите его, например, yyyy-MM-dd HH:mm a z, рассмотрите следующий фрагмент:

ObjectMapper objectMapper = new ObjectMapper();
DateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm a z");
objectMapper.setDateFormat(df);
String carAsString = objectMapper.writeValueAsString(request);
// output: {"car":{"color":"yellow","type":"renault"},"datePurchased":"2016-07-03 11:43 AM CEST"}

Чтобы узнать больше о сериализации дат с помощью Джексона, прочтитеour more in-depth write-up.

4.4. Обработка коллекций

Еще одна небольшая, но полезная функция, доступная через классDeserializationFeature, - это возможность сгенерировать нужный тип коллекции из ответа JSON Array.

Например, мы можем сгенерировать результат в виде массива:

String jsonCarArray =
  "[{ \"color\" : \"Black\", \"type\" : \"BMW\" }, { \"color\" : \"Red\", \"type\" : \"FIAT\" }]";
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.configure(DeserializationFeature.USE_JAVA_ARRAY_FOR_JSON_ARRAY, true);
Car[] cars = objectMapper.readValue(jsonCarArray, Car[].class);
// print cars

Или какList:

String jsonCarArray =
  "[{ \"color\" : \"Black\", \"type\" : \"BMW\" }, { \"color\" : \"Red\", \"type\" : \"FIAT\" }]";
ObjectMapper objectMapper = new ObjectMapper();
List listCar = objectMapper.readValue(jsonCarArray, new TypeReference>(){});
// print cars

Более подробная информация об обработке коллекций с помощью Jackson доступнаhere.

5. Заключение

Jackson - это солидная и зрелая библиотека сериализации / десериализации JSON для Java. APIObjectMapper предоставляет простой способ синтаксического анализа и создания объектов ответа JSON с большой гибкостью.

В статье рассматриваются основные особенности, которые делают библиотеку столь популярной. Исходный код, сопровождающий статью, можно найтиover on GitHub.

TOC

Введение в Джексон ObjectMapper