Java for Beginner

Jackson

Глобальная настройка ObjectMapper: как управлять сериализацией и десериализацией

Jackson предоставляет удобный способ централизованно настраивать поведение через ObjectMapper. Эта конфигурация позволяет управлять форматированием JSON, обработкой неизвестных полей, null-значений и множеством других аспектов.

Инициализация ObjectMapper

import com.fasterxml.jackson.databind.ObjectMapper;

ObjectMapper mapper = new ObjectMapper();
Можно использовать его напрямую или создать бин (например, в Spring).

1. Игнорирование неизвестных полей

По умолчанию Jackson выбросит исключение, если в JSON попадётся поле, которого нет в Java-классе.

Это можно отключить так:

import com.fasterxml.jackson.databind.DeserializationFeature;

mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);

Теперь лишние поля будут просто игнорироваться:

{
  "name": "Alice",
  "age": 30,
  "extra_field": "ignored"
}

2. Красивая печать JSON (Pretty Print)

По умолчанию JSON сериализуется в одну строку. Чтобы включить форматирование с отступами:

import com.fasterxml.jackson.databind.SerializationFeature;

mapper.enable(SerializationFeature.INDENT_OUTPUT);

Пример вывода:

{
  "name" : "Alice",
  "age" : 30
}
Это особенно полезно для логирования и отладки.

3. Исключение null-полей

Если нужно убрать из JSON все поля с null, можно настроить так:

import com.fasterxml.jackson.annotation.JsonInclude;

mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

Пример:

public class User {
    public String name;
    public String email; // может быть null
}

Результат без email, если он null:

{
  "name": "Alice"
}

4. Ошибка при отсутствии обязательных полей

По умолчанию Jackson пропускает отсутствующие поля. Но можно требовать их наличия:

mapper.configure(DeserializationFeature.FAIL_ON_NULL_FOR_PRIMITIVES, true);
mapper.configure(DeserializationFeature.FAIL_ON_MISSING_CREATOR_PROPERTIES, true);

5. Написание чисел как строки

mapper.configure(SerializationFeature.WRITE_NUMBERS_AS_STRINGS, true);

Результат:

{
  "age": "30"
}

6. Установка глобального формата дат

import java.text.SimpleDateFormat;

mapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd"));

Когда это полезно
— В проектах с нестабильными API
— При интеграции с фронтендом, где важно форматирование
— При логировании JSON в читаемом виде
— Для обеспечения устойчивости к изменяющимся данным

#Java #Training #Medium #Jackson #ObjectMapper

136 views05:59

Java for Beginner

3. Основные возможности ObjectMapper

ObjectMapper предоставляет широкий набор функций для настройки сериализации и десериализации.

Вот ключевые возможности:

3.1. Базовые операции

import com.fasterxml.jackson.databind.ObjectMapper;

public class Example {
    public static void main(String[] args) throws Exception {
        ObjectMapper mapper = new ObjectMapper();

        // POJO
        public class User {
            private String name;
            private int age;

            // Getters and setters
        }

        // Сериализация
        User user = new User("Alice", 30);
        String json = mapper.writeValueAsString(user);
        System.out.println(json); // {"name":"Alice","age":30}

        // Десериализация
        String jsonInput = "{\"name\":\"Bob\",\"age\":25}";
        User deserializedUser = mapper.readValue(jsonInput, User.class);
        System.out.println(deserializedUser.getName()); // Bob
    }
}

3.2. Конфигурация ObjectMapper

ObjectMapper позволяет настраивать поведение через методы конфигурации:

ObjectMapper mapper = new ObjectMapper();

// Игнорировать неизвестные поля при десериализации
mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);

// Включить форматирование JSON (pretty print)
mapper.configure(SerializationFeature.INDENT_OUTPUT, true);

// Игнорировать null-поля при сериализации
mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

3.3. Аннотации

Jackson предоставляет множество аннотаций для управления сериализацией/десериализацией:

@JsonProperty("customName"): Переименовывает поле в JSON.
@JsonIgnore: Исключает поле из сериализации/десериализации.
@JsonInclude(JsonInclude.Include.NON_NULL): Исключает null-поля.
@JsonFormat: Задает формат для дат, чисел и других типов.
@JsonTypeInfo и @JsonSubTypes: Поддержка полиморфизма.

Пример:

public class User {
    @JsonProperty("full_name")
    private String name;

    @JsonIgnore
    private String password;

    @JsonFormat(pattern = "yyyy-MM-dd")
    private LocalDate birthDate;
}

3.4. Работа с Generics и сложными типами

Для работы с коллекциями или сложными типами используется TypeReference:

List<User> users = mapper.readValue(json, new TypeReference<List<User>>(){});

3.5. Потоковая обработка

Для больших данных можно использовать потоковый API:

JsonGenerator generator = mapper.getFactory().createGenerator(new FileOutputStream("output.json"));
generator.writeStartObject();
generator.writeStringField("name", "Alice");
generator.writeEndObject();
generator.close();

3.6. Кастомные сериализаторы/десериализаторы

Для нестандартных типов данных можно написать свои сериализаторы:

public class CustomSerializer extends StdSerializer<CustomType> {
    public CustomSerializer() {
        super(CustomType.class);
    }

    @Override
    public void serialize(CustomType value, JsonGenerator gen, SerializerProvider provider) throws IOException {
        gen.writeStartObject();
        gen.writeStringField("custom", value.getValue());
        gen.writeEndObject();
    }
}

// Регистрация
mapper.registerModule(new SimpleModule().addSerializer(CustomType.class, new CustomSerializer()));

#Java #middle #on_request #ObjectMapper

33 views07:58

Java for Beginner

4. Взаимодействие с Spring

ObjectMapper глубоко интегрирован с Spring Framework, особенно в модуле Spring Web (REST API). Spring использует Jackson для обработки JSON в контроллерах и взаимодействия с клиентами через HTTP.

4.1. Spring Boot и Jackson

Spring Boot автоматически настраивает ObjectMapper как бин, если в зависимостях есть jackson-databind. Вы можете кастомизировать его через свойства или конфигурацию.

Конфигурация через application.properties:

spring.jackson.serialization.indent-output=true
spring.jackson.deserialization.fail-on-unknown-properties=false
spring.jackson.date-format=yyyy-MM-dd

Кастомизация через Java-конфигурацию:

@Configuration
public class JacksonConfig {
    @Bean
    public ObjectMapper objectMapper() {
        ObjectMapper mapper = new ObjectMapper();
        mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
        return mapper;
    }
}

4.2. Использование в контроллерах

Spring автоматически использует ObjectMapper для сериализации ответов и десериализации запросов:

@RestController
@RequestMapping("/api/users")
public class UserController {
    @PostMapping
    public User createUser(@RequestBody User user) {
        // user автоматически десериализуется из JSON
        return user;
    }

    @GetMapping
    public List<User> getUsers() {
        // Список автоматически сериализуется в JSON
        return List.of(new User("Alice", 30));
    }
}

4.3. Кастомизация для HTTP

Spring использует MappingJackson2HttpMessageConverter для обработки JSON.

Вы можете настроить его, чтобы использовать кастомный ObjectMapper:

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
        converter.setObjectMapper(customObjectMapper());
        converters.add(converter);
    }

    @Bean
    public ObjectMapper customObjectMapper() {
        return new ObjectMapper().configure(SerializationFeature.INDENT_OUTPUT, true);
    }
}

5. Взаимодействие с другими библиотеками

ObjectMapper часто используется в связке с другими библиотеками, которые работают с JSON или требуют сериализации/десериализации.

5.1. MongoDB

Spring Data MongoDB использует Jackson для сериализации объектов в BSON (бинарный JSON).

Вы можете настроить MongoTemplate для использования кастомного ObjectMapper:

@Configuration
public class MongoConfig {
    @Bean
    public MongoTemplate mongoTemplate(MongoDatabaseFactory factory) {
        ObjectMapper mapper = new ObjectMapper();
        mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        return new MongoTemplate(factory, new MappingMongoConverter(new DefaultDbRefResolver(factory), new MongoMappingContext()));
    }
}

5.2. Kafka

В Apache Kafka ObjectMapper используется для сериализации/десериализации сообщений.

Например:

@Bean
public KafkaTemplate<String, User> kafkaTemplate(ProducerFactory<String, User> producerFactory) {
    return new KafkaTemplate<>(producerFactory);
}

@KafkaListener(topics = "user-topic")
public void listen(@Payload String json, ConsumerRecord<String, String> record) throws IOException {
    User user = new ObjectMapper().readValue(json, User.class);
    System.out.println("Received: " + user);
}

5.3. Elasticsearch

Spring Data Elasticsearch также использует Jackson для работы с JSON. Вы можете настроить RestHighLevelClient с кастомным ObjectMapper.

5.4. Другие форматы

Jackson поддерживает модули для работы с другими форматами (XML, YAML, CBOR). Например:

ObjectMapper yamlMapper = new ObjectMapper(new YAMLFactory());
String yaml = yamlMapper.writeValueAsString(user);

#Java #middle #on_request #ObjectMapper

36 views07:58

Java for Beginner

6. Оптимизация и лучшие практики

Переиспользование ObjectMapper:
Создавайте один экземпляр ObjectMapper на приложение, чтобы избежать накладных расходов на инициализацию.
Используйте Spring для внедрения ObjectMapper как бина.

Потоковая обработка:
Для больших JSON используйте JsonParser и JsonGenerator вместо полной загрузки в JsonNode.

Кэширование:
ObjectMapper автоматически кэширует метаданные классов. Избегайте частого создания новых экземпляров.

Обработка ошибок:
Обрабатывайте исключения, такие как JsonProcessingException, для повышения надежности.
Настройте DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES для игнорирования неизвестных полей.

Тестирование:
Проверяйте сериализацию/десериализацию в тестах, особенно для сложных объектов.
Используйте библиотеки, такие как jsonassert, для сравнения JSON.

Безопасность:
Избегайте десериализации непроверенных данных, чтобы предотвратить атаки (например, уязвимости в стиле XXE).
Используйте @JsonIgnoreProperties для ограничения полей.

7. Распространенные проблемы и их решения

Циклические ссылки:
Используйте @JsonIdentityInfo для обработки циклических зависимостей:

@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
public class User {
    private Long id;
    private List<User> friends;
}

Неизвестные поля:
Настройте mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false).

Неправильные форматы дат:
Используйте @JsonFormat или настройте глобальный формат через mapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd")).

Производительность:
Для больших объектов используйте потоковую обработку или минимизируйте использование JsonNode.

8. Пример реального сценария

Допустим, вы разрабатываете REST API для управления пользователями. JSON-запросы и ответы должны быть в определенном формате, а некоторые поля — опциональными.

POJO:

@JsonInclude(JsonInclude.Include.NON_NULL)
public class User {
    @JsonProperty("full_name")
    private String name;

    @JsonFormat(pattern = "yyyy-MM-dd")
    private LocalDate birthDate;

    @JsonIgnore
    private String password;

    // Getters and setters
}

Контроллер:

@RestController
@RequestMapping("/api/users")
public class UserController {
    @PostMapping
    public ResponseEntity<User> createUser(@RequestBody User user) {
        // Логика сохранения
        return ResponseEntity.ok(user);
    }
}

Конфигурация:

@Configuration
public class JacksonConfig {
    @Bean
    public ObjectMapper objectMapper() {
        ObjectMapper mapper = new ObjectMapper();
        mapper.registerModule(new JavaTimeModule()); // Для LocalDate
        mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        return mapper;
    }
}

#Java #middle #on_request #ObjectMapper

53 views07:58

About

Blog

Apps

Platform