README.md

nrich-jackson

Overview

nrich-jackson is a module that adds additional Jackson's serializers and deserializers that have proved to be useful in projects (i.e. serializing empty strings to null, deserializing class property with certain classes etc.)

Setting up Spring beans

Functionalities of this module are defined as separate Jackson modules and are located in JacksonModuleUtil class. Modules can be declared as beans in which case they will be registered automatically when Spring Boot is used with default ObjectMapper registered through JacksonAutoConfiguration, or they can be manually registered on any ObjectMapper instance.

@Configuration(proxyBeanMethods = false)
public class ApplicationConfiguration {

    @Bean
    public ObjectMapper registryObjectMapper() {
        ObjectMapper objectMapper = new ObjectMapper();

        objectMapper.registerModule(JacksonModuleUtil.convertEmptyStringToNullModule());
        objectMapper.registerModule(JacksonModuleUtil.classNameSerializerModule(true, Collections.singletonList("net.croz.test")));

        return objectMapper;
    }
}

JacksonModuleUtil.convertEmptyStringToNullModule is module responsible for converting empty strings to null values JacksonModuleUtil.classNameSerializerModule is module responsible for serializing class property. It accepts two arguments. First argument decides if class property should be serialized for classes annotated with jakarta.persistence.Entity annotation or not. Second is (optional) additional package list whose class property should also be serialized.

Usage

When registered on ObjectMapper these modules are used automatically when serializing and deserializing JSON content.