Migrates from Jackson 2.x to Jackson 3.x

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.jackson.UpgradeJackson_2_3

If the recipe isn’t available locally, install it with:

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

Definition

This recipe runs the following recipes in order.

• Migrate from Jackson Codehaus (legacy) to Jackson FasterXMLorg.openrewrite.java.jackson.CodehausToFasterXML
• Replace IOException with JacksonException in catch clausesorg.openrewrite.java.jackson.IOExceptionToJacksonException
• Replace throw new IOException(..) inside Jackson serializer / deserializer overridesorg.openrewrite.java.jackson.ReplaceIOExceptionThrowInJacksonOverrides
• Replace null type in StdDeserializer constructor with actual typeorg.openrewrite.java.jackson.StdDeserializerNullConstructor
• Use DeserializationContext.readTreeAsValue() instead of ObjectCodec.treeToValue()org.openrewrite.java.jackson.UseReadTreeAsValueInDeserializer
• Update lombok.config for Jackson 3 compatibilityorg.openrewrite.java.jackson.LombokJacksonizedConfig
• Use format alignment ObjectMappersorg.openrewrite.java.jackson.UseFormatAlignedObjectMappers
• Modernize legacy jackson-core feature constantsorg.openrewrite.java.jackson.UpgradeJackson_2_3_ModernizeJacksonCoreFeatures
• Remove redundant Jackson 3 feature flag configurationsorg.openrewrite.java.jackson.UpgradeJackson_2_3_RemoveRedundantFeatureFlags
• Remove registrations of modules built-in to Jackson 3org.openrewrite.java.jackson.RemoveBuiltInModuleRegistrations
• Migrate mapper setter calls to builder patternorg.openrewrite.java.jackson.MigrateMapperSettersToBuilder
• Migrate factory setter calls to builder patternorg.openrewrite.java.jackson.MigrateFactorySettersToBuilder
• Update configuration of serialization inclusion in ObjectMapper for Jackson 3org.openrewrite.java.jackson.UpdateSerializationInclusionConfiguration
• Replace disable(MapperFeature.AUTO_DETECT_*) with changeDefaultVisibility() for Jackson 3org.openrewrite.java.jackson.UpdateAutoDetectVisibilityConfiguration
• Reorder method argumentsorg.openrewrite.java.ReorderMethodArguments
• Reorder method argumentsorg.openrewrite.java.ReorderMethodArguments
• Reorder method argumentsorg.openrewrite.java.ReorderMethodArguments
• Add missing Jackson dataformat dependenciesorg.openrewrite.java.jackson.AddMissingJacksonDependencies
• Upgrade Jackson 2.x dependencies to 3.xorg.openrewrite.java.jackson.UpgradeJackson_2_3_Dependencies
• Rename Jackson 2.x methods to 3.x equivalentsorg.openrewrite.java.jackson.UpgradeJackson_2_3_MethodRenames
• Migrate relocated feature constants to DateTimeFeature and EnumFeatureorg.openrewrite.java.jackson.UpgradeJackson_2_3_RelocatedFeatureConstants
• Replace constant with another constantorg.openrewrite.java.ReplaceConstantWithAnotherConstant
• Replace ObjectMapper.copy() with rebuild().build()org.openrewrite.java.jackson.ReplaceObjectMapperCopy
• Use modern date/time serialization defaultsorg.openrewrite.java.jackson.UseModernDateTimeSerialization
• Replace removed JsonGenerator capability methods with StreamWriteCapabilityorg.openrewrite.java.jackson.ReplaceStreamWriteCapability
• Replace @JsonIgnore with @JsonSetter on empty collection fieldsorg.openrewrite.java.jackson.ReplaceJsonIgnoreWithJsonSetter
• Add @JsonCreator to non-public constructorsorg.openrewrite.java.jackson.AddJsonCreatorToPrivateConstructors
• Add comment to method invocationsorg.openrewrite.java.AddCommentToMethodInvocations
• Add comment to method invocationsorg.openrewrite.java.AddCommentToMethodInvocations
• Add comment to SimpleModule method calls on modules that no longer extend SimpleModuleorg.openrewrite.java.jackson.CommentOutSimpleModuleMethodCalls
• Add comment to method invocationsorg.openrewrite.java.AddCommentToMethodInvocations
• Add comment to method invocationsorg.openrewrite.java.AddCommentToMethodInvocations
• Update Jackson 2.x types to 3.xorg.openrewrite.java.jackson.UpgradeJackson_2_3_TypeChanges
• Use JsonFactory.builder() over new JsonFactoryBuilder()org.openrewrite.java.jackson.UseJsonFactoryStaticBuilder
• Migrate deprecated @JsonSerialize(include = ...) to @JsonIncludeorg.openrewrite.java.jackson.JsonSerializeIncludeToJsonInclude
• Migrate ObjectMapper.readValue(URL, ...) to use openStream()org.openrewrite.java.jackson.ReadValueUrlToOpenStream
• Update Jackson package names from 2.x to 3.xorg.openrewrite.java.jackson.UpgradeJackson_2_3_PackageChanges
• Simplify catch clauses for Jackson exceptionsorg.openrewrite.java.jackson.SimplifyJacksonExceptionCatch

Data tables

Structured output this recipe can produce.

• Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
• Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
• Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
• Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats