Skip to main content

Migrate mapper setter calls to builder pattern

org.openrewrite.java.jackson.MigrateMapperSettersToBuilder

In Jackson 3, JsonMapper and other format-aligned mappers are immutable. Configuration methods like setFilterProvider, addMixIn, disable, enable, etc. must be called on the builder instead. This recipe migrates setter calls to the builder pattern when safe, or adds TODO comments when automatic migration is not possible.

Tags​

Recipe source​

GitHub: MigrateMapperSettersToBuilder.java, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Used by​

This recipe is used as part of the following composite recipes:

Example​

Before​
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.core.Base64Variants;
import com.fasterxml.jackson.core.PrettyPrinter;
import com.fasterxml.jackson.databind.AnnotationIntrospector;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.InjectableValues;
import com.fasterxml.jackson.databind.MapperFeature;
import com.fasterxml.jackson.databind.Module;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.PropertyNamingStrategy;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.databind.cfg.CacheProvider;
import com.fasterxml.jackson.databind.cfg.ConstructorDetector;
import com.fasterxml.jackson.databind.cfg.ContextAttributes;
import com.fasterxml.jackson.databind.cfg.HandlerInstantiator;
import com.fasterxml.jackson.databind.deser.DeserializationProblemHandler;
import com.fasterxml.jackson.databind.introspect.AccessorNamingStrategy;
import com.fasterxml.jackson.databind.json.JsonMapper;
import com.fasterxml.jackson.databind.jsontype.PolymorphicTypeValidator;
import com.fasterxml.jackson.databind.jsontype.SubtypeResolver;
import com.fasterxml.jackson.databind.jsontype.TypeResolverBuilder;
import com.fasterxml.jackson.databind.node.JsonNodeFactory;
import com.fasterxml.jackson.databind.ser.FilterProvider;
import com.fasterxml.jackson.databind.ser.SerializerFactory;
import com.fasterxml.jackson.databind.type.TypeFactory;

import java.text.SimpleDateFormat;
import java.util.Locale;
import java.util.TimeZone;

class A {
    JsonMapper create(
            Module module,
            DeserializationProblemHandler handler,
            PolymorphicTypeValidator validator,
            TypeResolverBuilder<?> typeResolver,
            FilterProvider filterProvider,
            SerializerFactory serializerFactory,
            PrettyPrinter prettyPrinter,
            InjectableValues injectableValues,
            ConstructorDetector constructorDetector,
            CacheProvider cacheProvider,
            AnnotationIntrospector introspector,
            SubtypeResolver subtypeResolver,
            HandlerInstantiator handlerInstantiator,
            PropertyNamingStrategy namingStrategy,
            AccessorNamingStrategy.Provider accessorNaming,
            ContextAttributes attributes
    ) {
        JsonMapper mapper = new JsonMapper();
        mapper.configure(MapperFeature.AUTO_DETECT_FIELDS, true);
        mapper.disable(SerializationFeature.INDENT_OUTPUT);
        mapper.enable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
        mapper.registerModule(module);
        mapper.registerModules(module);
        mapper.findAndRegisterModules();
        mapper.addMixIn(Object.class, Comparable.class);
        mapper.registerSubtypes(Object.class);
        mapper.addHandler(handler);
        mapper.clearProblemHandlers();
        mapper.activateDefaultTyping(validator);
        mapper.activateDefaultTypingAsProperty(validator, ObjectMapper.DefaultTyping.NON_FINAL, "@type");
        mapper.deactivateDefaultTyping();
        mapper.setDefaultTyping(typeResolver);
        mapper.setFilterProvider(filterProvider);
        mapper.setSerializerFactory(serializerFactory);
        mapper.setDefaultPrettyPrinter(prettyPrinter);
        mapper.setInjectableValues(injectableValues);
        mapper.setNodeFactory(JsonNodeFactory.instance);
        mapper.setConstructorDetector(constructorDetector);
        mapper.setCacheProvider(cacheProvider);
        mapper.setAnnotationIntrospector(introspector);
        mapper.setTypeFactory(TypeFactory.defaultInstance());
        mapper.setSubtypeResolver(subtypeResolver);
        mapper.setVisibility(PropertyAccessor.FIELD, JsonAutoDetect.Visibility.ANY);
        mapper.setHandlerInstantiator(handlerInstantiator);
        mapper.setPropertyNamingStrategy(namingStrategy);
        mapper.setAccessorNaming(accessorNaming);
        mapper.setPolymorphicTypeValidator(validator);
        mapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd"));
        mapper.setTimeZone(TimeZone.getDefault());
        mapper.setLocale(Locale.US);
        mapper.setBase64Variant(Base64Variants.MIME);
        mapper.setDefaultAttributes(attributes);
        mapper.setDefaultPropertyInclusion(JsonInclude.Value.empty());
        mapper.setDefaultSetterInfo(JsonSetter.Value.empty());
        mapper.setDefaultMergeable(Boolean.TRUE);
        mapper.setDefaultLeniency(Boolean.TRUE);
        return mapper;
    }
}
After​
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.core.Base64Variants;
import com.fasterxml.jackson.core.PrettyPrinter;
import com.fasterxml.jackson.databind.AnnotationIntrospector;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.InjectableValues;
import com.fasterxml.jackson.databind.MapperFeature;
import com.fasterxml.jackson.databind.Module;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.PropertyNamingStrategy;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.databind.cfg.CacheProvider;
import com.fasterxml.jackson.databind.cfg.ConstructorDetector;
import com.fasterxml.jackson.databind.cfg.ContextAttributes;
import com.fasterxml.jackson.databind.cfg.HandlerInstantiator;
import com.fasterxml.jackson.databind.deser.DeserializationProblemHandler;
import com.fasterxml.jackson.databind.introspect.AccessorNamingStrategy;
import com.fasterxml.jackson.databind.json.JsonMapper;
import com.fasterxml.jackson.databind.jsontype.PolymorphicTypeValidator;
import com.fasterxml.jackson.databind.jsontype.SubtypeResolver;
import com.fasterxml.jackson.databind.jsontype.TypeResolverBuilder;
import com.fasterxml.jackson.databind.node.JsonNodeFactory;
import com.fasterxml.jackson.databind.ser.FilterProvider;
import com.fasterxml.jackson.databind.ser.SerializerFactory;
import com.fasterxml.jackson.databind.type.TypeFactory;

import java.text.SimpleDateFormat;
import java.util.Locale;
import java.util.TimeZone;

class A {
    JsonMapper create(
            Module module,
            DeserializationProblemHandler handler,
            PolymorphicTypeValidator validator,
            TypeResolverBuilder<?> typeResolver,
            FilterProvider filterProvider,
            SerializerFactory serializerFactory,
            PrettyPrinter prettyPrinter,
            InjectableValues injectableValues,
            ConstructorDetector constructorDetector,
            CacheProvider cacheProvider,
            AnnotationIntrospector introspector,
            SubtypeResolver subtypeResolver,
            HandlerInstantiator handlerInstantiator,
            PropertyNamingStrategy namingStrategy,
            AccessorNamingStrategy.Provider accessorNaming,
            ContextAttributes attributes
    ) {
        return JsonMapper.builder()
                .configure(MapperFeature.AUTO_DETECT_FIELDS, true)
                .disable(SerializationFeature.INDENT_OUTPUT)
                .enable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES)
                .addModule(module)
                .addModules(module)
                .findAndAddModules()
                .addMixIn(Object.class, Comparable.class)
                .registerSubtypes(Object.class)
                .addHandler(handler)
                .clearProblemHandlers()
                .activateDefaultTyping(validator)
                .activateDefaultTypingAsProperty(validator, ObjectMapper.DefaultTyping.NON_FINAL, "@type")
                .deactivateDefaultTyping()
                .setDefaultTyping(typeResolver)
                .filterProvider(filterProvider)
                .serializerFactory(serializerFactory)
                .defaultPrettyPrinter(prettyPrinter)
                .injectableValues(injectableValues)
                .nodeFactory(JsonNodeFactory.instance)
                .constructorDetector(constructorDetector)
                .cacheProvider(cacheProvider)
                .annotationIntrospector(introspector)
                .typeFactory(TypeFactory.defaultInstance())
                .subtypeResolver(subtypeResolver)
                .visibility(PropertyAccessor.FIELD, JsonAutoDetect.Visibility.ANY)
                .handlerInstantiator(handlerInstantiator)
                .propertyNamingStrategy(namingStrategy)
                .accessorNaming(accessorNaming)
                .polymorphicTypeValidator(validator)
                .defaultDateFormat(new SimpleDateFormat("yyyy-MM-dd"))
                .defaultTimeZone(TimeZone.getDefault())
                .defaultLocale(Locale.US)
                .defaultBase64Variant(Base64Variants.MIME)
                .defaultAttributes(attributes)
                .defaultPropertyInclusion(JsonInclude.Value.empty())
                .defaultSetterInfo(JsonSetter.Value.empty())
                .defaultMergeable(Boolean.TRUE)
                .defaultLeniency(Boolean.TRUE)
                .build();
    }
}

Usage​

This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell
mod run . --recipe MigrateMapperSettersToBuilder

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite.recipe:rewrite-jackson:1.21.0

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.