Skip to main content
Open source

Migrates from Jackson 2.x to Jackson 3.x

Recipe IDorg.openrewrite.java.jackson.UpgradeJackson_2_3
Artifactorg.openrewrite.recipe:rewrite-jackson

Migrate applications to the latest Jackson 3.x release. This recipe handles package changes (com.fasterxml.jackson -> tools.jackson), dependency updates, core class renames, exception renames, and method renames (e.g., JsonGenerator.writeObject() -> writePOJO(), JsonParser.getCurrentValue() -> currentValue()).

Composite recipeJavajackson-3Apache License Version 2.0
Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Definition​

Recipes36
36 recipes

Examples​

xml
Before
<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.example</groupId>
    <artifactId>example</artifactId>
    <version>1.0.0</version>
    <dependencies>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
            <version>2.19.0</version>
        </dependency>
    </dependencies>
</project>
After
<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.example</groupId>
    <artifactId>example</artifactId>
    <version>1.0.0</version>
    <dependencies>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
            <version>2.21</version>
        </dependency>
    </dependencies>
</project>
java
Before
import com.fasterxml.jackson.core.JsonGenerator;

class Test {
    void test(JsonGenerator gen, Object value) throws Exception {
        gen.writeObject(value);
    }
}
After
import tools.jackson.core.JsonGenerator;

class Test {
    void test(JsonGenerator gen, Object value) throws Exception {
        gen.writePOJO(value);
    }
}
java
Before
import com.fasterxml.jackson.core.JsonFactory;

class Test {
    JsonFactory factory = new JsonFactory();
}
After
import tools.jackson.core.json.JsonFactory;

class Test {
    JsonFactory factory = JsonFactory.builder()
            .build();
}
Example 4
Unchanged
import lombok.Builder;
import lombok.Value;
import lombok.extern.jackson.Jacksonized;

@Value
@Builder
@Jacksonized
class MyDto {
    String name;
    int age;
}
java
Before
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import java.io.IOException;

class MySerializer extends JsonSerializer<String> {
    @Override
    public void serialize(String value, JsonGenerator gen, SerializerProvider provider) throws IOException {
        gen.writeString(value.toUpperCase());
    }
}
After
import tools.jackson.core.JsonGenerator;
import tools.jackson.databind.SerializationContext;
import tools.jackson.databind.ValueSerializer;

class MySerializer extends ValueSerializer<String> {
    @Override
    public void serialize(String value, JsonGenerator gen, SerializationContext provider) {
        gen.writeString(value.toUpperCase());
    }
}
java
Before
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonToken;

class Test {
    void parse(JsonParser parser) {
        if (parser.currentToken() == JsonToken.FIELD_NAME) {
            System.out.println("It's a field");
        }
    }
}
After
import tools.jackson.core.JsonParser;
import tools.jackson.core.JsonToken;

class Test {
    void parse(JsonParser parser) {
        if (parser.currentToken() == JsonToken.PROPERTY_NAME) {
            System.out.println("It's a field");
        }
    }
}
java
Before
import com.fasterxml.jackson.core.JsonGenerationException;
import com.fasterxml.jackson.core.JsonGenerator;

class Test {
    void example(JsonGenerator gen) {
        throw new JsonGenerationException("message", gen);
    }
}
After
import tools.jackson.core.JsonGenerator;
import tools.jackson.core.exc.StreamWriteException;

class Test {
    void example(JsonGenerator gen) {
        throw new StreamWriteException(gen, "message");
    }
}
java
Before
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
import java.io.IOException;

class MyDeserializer extends StdDeserializer<String> {
    public MyDeserializer() {
        this(null);
    }

    public MyDeserializer(Class<?> vc) {
        super(vc);
    }

    @Override
    public String deserialize(JsonParser p, DeserializationContext ctxt)
            throws IOException {
        return p.getValueAsString();
    }
}
After
import tools.jackson.core.JsonParser;
import tools.jackson.databind.DeserializationContext;
import tools.jackson.databind.deser.std.StdDeserializer;

class MyDeserializer extends StdDeserializer<String> {
    public MyDeserializer() {
        this(String.class);
    }

    public MyDeserializer(Class<?> vc) {
        super(vc);
    }

    @Override
    public String deserialize(JsonParser p, DeserializationContext ctxt) {
        return p.getValueAsString();
    }
}
java
Before
import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.type.TypeFactory;

class Test {
    JavaType getType() {
        return TypeFactory.defaultInstance().constructType(String.class);
    }
}
After
import tools.jackson.databind.JavaType;
import tools.jackson.databind.type.TypeFactory;

class Test {
    JavaType getType() {
        return TypeFactory.createDefaultInstance().constructType(String.class);
    }
}
java
Unchanged
<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.example</groupId>
    <artifactId>example</artifactId>
    <version>1.0.0</version>
    <dependencies>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
            <version>2.19.0</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>2.19.0</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.19.0</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.module</groupId>
            <artifactId>jackson-module-parameter-names</artifactId>
            <version>2.19.0</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.datatype</groupId>
            <artifactId>jackson-datatype-jdk8</artifactId>
            <version>2.19.0</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.datatype</groupId>
            <artifactId>jackson-datatype-jsr310</artifactId>
            <version>2.19.0</version>
        </dependency>
    </dependencies>
</project>
Before
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.core.JsonFactory;
import com.fasterxml.jackson.core.JsonFactoryBuilder;
import com.fasterxml.jackson.databind.ObjectMapper;

class Test {
    public String foo(@JsonProperty("foo") String foo) {
        return foo;
    }

    static void helloJackson() {
        Object[] input = new Object[] { "one", "two" };
        JsonFactory factory = new JsonFactoryBuilder().build();
    }
}
After
import com.fasterxml.jackson.annotation.JsonProperty;
import tools.jackson.core.JsonFactoryBuilder;
import tools.jackson.databind.ObjectMapper;
import tools.jackson.core.TokenStreamFactory;

class Test {
    public String foo(@JsonProperty("foo") String foo) {
        return foo;
    }

    static void helloJackson() {
        Object[] input = new Object[] { "one", "two" };
        TokenStreamFactory factory = new JsonFactoryBuilder().build();
    }
}
xml
Before
<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.example</groupId>
    <artifactId>example</artifactId>
    <version>1.0.0</version>
    <dependencies>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
            <version>2.19.0</version>
        </dependency>
    </dependencies>
</project>
After
<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.example</groupId>
    <artifactId>example</artifactId>
    <version>1.0.0</version>
    <dependencies>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
            <version>2.21</version>
        </dependency>
    </dependencies>
</project>
java
Before
import com.fasterxml.jackson.core.JsonGenerator;

class Test {
    void test(JsonGenerator gen, Object value) throws Exception {
        gen.writeObject(value);
    }
}
After
import tools.jackson.core.JsonGenerator;

class Test {
    void test(JsonGenerator gen, Object value) throws Exception {
        gen.writePOJO(value);
    }
}
java
Before
import com.fasterxml.jackson.core.JsonFactory;

class Test {
    JsonFactory factory = new JsonFactory();
}
After
import tools.jackson.core.json.JsonFactory;

class Test {
    JsonFactory factory = JsonFactory.builder()
            .build();
}
Example 14
Unchanged
import lombok.Builder;
import lombok.Value;
import lombok.extern.jackson.Jacksonized;

@Value
@Builder
@Jacksonized
class MyDto {
    String name;
    int age;
}
java
Before
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import java.io.IOException;

class MySerializer extends JsonSerializer<String> {
    @Override
    public void serialize(String value, JsonGenerator gen, SerializerProvider provider) throws IOException {
        gen.writeString(value.toUpperCase());
    }
}
After
import tools.jackson.core.JsonGenerator;
import tools.jackson.databind.SerializationContext;
import tools.jackson.databind.ValueSerializer;

class MySerializer extends ValueSerializer<String> {
    @Override
    public void serialize(String value, JsonGenerator gen, SerializationContext provider) {
        gen.writeString(value.toUpperCase());
    }
}
java
Before
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonToken;

class Test {
    void parse(JsonParser parser) {
        if (parser.currentToken() == JsonToken.FIELD_NAME) {
            System.out.println("It's a field");
        }
    }
}
After
import tools.jackson.core.JsonParser;
import tools.jackson.core.JsonToken;

class Test {
    void parse(JsonParser parser) {
        if (parser.currentToken() == JsonToken.PROPERTY_NAME) {
            System.out.println("It's a field");
        }
    }
}
java
Before
import com.fasterxml.jackson.core.JsonGenerationException;
import com.fasterxml.jackson.core.JsonGenerator;

class Test {
    void example(JsonGenerator gen) {
        throw new JsonGenerationException("message", gen);
    }
}
After
import tools.jackson.core.JsonGenerator;
import tools.jackson.core.exc.StreamWriteException;

class Test {
    void example(JsonGenerator gen) {
        throw new StreamWriteException(gen, "message");
    }
}
java
Before
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
import java.io.IOException;

class MyDeserializer extends StdDeserializer<String> {
    public MyDeserializer() {
        this(null);
    }

    public MyDeserializer(Class<?> vc) {
        super(vc);
    }

    @Override
    public String deserialize(JsonParser p, DeserializationContext ctxt)
            throws IOException {
        return p.getValueAsString();
    }
}
After
import tools.jackson.core.JsonParser;
import tools.jackson.databind.DeserializationContext;
import tools.jackson.databind.deser.std.StdDeserializer;

class MyDeserializer extends StdDeserializer<String> {
    public MyDeserializer() {
        this(String.class);
    }

    public MyDeserializer(Class<?> vc) {
        super(vc);
    }

    @Override
    public String deserialize(JsonParser p, DeserializationContext ctxt) {
        return p.getValueAsString();
    }
}
java
Before
import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.type.TypeFactory;

class Test {
    JavaType getType() {
        return TypeFactory.defaultInstance().constructType(String.class);
    }
}
After
import tools.jackson.databind.JavaType;
import tools.jackson.databind.type.TypeFactory;

class Test {
    JavaType getType() {
        return TypeFactory.createDefaultInstance().constructType(String.class);
    }
}
java
Unchanged
<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.example</groupId>
    <artifactId>example</artifactId>
    <version>1.0.0</version>
    <dependencies>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
            <version>2.19.0</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>2.19.0</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.19.0</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.module</groupId>
            <artifactId>jackson-module-parameter-names</artifactId>
            <version>2.19.0</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.datatype</groupId>
            <artifactId>jackson-datatype-jdk8</artifactId>
            <version>2.19.0</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.datatype</groupId>
            <artifactId>jackson-datatype-jsr310</artifactId>
            <version>2.19.0</version>
        </dependency>
    </dependencies>
</project>
Before
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.core.JsonFactory;
import com.fasterxml.jackson.core.JsonFactoryBuilder;
import com.fasterxml.jackson.databind.ObjectMapper;

class Test {
    public String foo(@JsonProperty("foo") String foo) {
        return foo;
    }

    static void helloJackson() {
        Object[] input = new Object[] { "one", "two" };
        JsonFactory factory = new JsonFactoryBuilder().build();
    }
}
After
import com.fasterxml.jackson.annotation.JsonProperty;
import tools.jackson.core.JsonFactoryBuilder;
import tools.jackson.databind.ObjectMapper;
import tools.jackson.core.TokenStreamFactory;

class Test {
    public String foo(@JsonProperty("foo") String foo) {
        return foo;
    }

    static void helloJackson() {
        Object[] input = new Object[] { "one", "two" };
        TokenStreamFactory factory = new JsonFactoryBuilder().build();
    }
}

Usage​

Run this recipe

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 UpgradeJackson_2_3

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

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

Data tables​

Source files that had results
org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

ColumnDescription
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.
Source files that had search results
org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

ColumnDescription
Source path of search result before the runThe source path of the file with the search result markers present.
Source path of search result after run 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.
ResultThe trimmed printed tree of the LST element that the marker is attached to.
DescriptionThe content of the description of the marker.
Recipe that added the search markerThe specific recipe that added the Search marker.
Source files that errored on a recipe
org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

ColumnDescription
Source pathThe file that failed to parse.
Recipe that made changesThe specific recipe that made a change.
Stack traceThe stack trace of the failure.
Recipe performance
org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

ColumnDescription
The recipeThe recipe whose stats are being measured both individually and cumulatively.
Source file countThe number of source files the recipe ran over.
Source file changed countThe number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)The total time spent across the scanning phase of this recipe.
Max scanning time (ns)The max time scanning any one source file.
Cumulative edit time (ns)The total time spent across the editing phase of this recipe.
Max edit time (ns)The max time editing any one source file.