Getting Started with Custom Deserialization in Jackson

1. Overview

This quick tutorial will illustrate how to use Jackson 2 to deserialize JSON using a custom Deserializer.

If you want to dig deeper and learn other cool things you can do with the Jackson 2 – head on over to the main Jackson tutorial.

2. Standard Deserialization

Let’s start by defining 2 entities and see how Jackson will deserialize a JSON representation to these entities without any customization:

public class User {
    public int id;
    public String name;
}
public class Item {
    public int id;
    public String itemName;
    public User owner;
}

Now, let’s define the JSON representation we want to deserialize:

{
    "id": 1,
    "itemName": "theItem",
    "owner": {
        "id": 2,
        "name": "theUser"
    }
}

And finally, let’s unmarshall this JSON to Java Entities:

Item itemWithOwner = new ObjectMapper().readValue(json, Item.class);

3. Custom Deserializer on ObjectMapper

In the previous example, the JSON representation matched the java entities perfectly – next, we will simplify the JSON:

{
    "id": 1,
    "itemName": "theItem",
    "createdBy": 2
}

When unmarshalling this to the exact same entities – by default, this will of course fail:

com.fasterxml.jackson.databind.exc.UnrecognizedPropertyException: 
Unrecognized field "createdBy" (class com.maixuanviet.jackson.dtos.Item), 
not marked as ignorable (3 known properties: "id", "owner", "itemName"])
 at [Source: java.io.StringReader@53c7a917; line: 1, column: 43] 
 (through reference chain: com.maixuanviet.jackson.dtos.Item["createdBy"])

We’ll solve this by doing our own deserialization with a custom Deserializer:

public class ItemDeserializer extends StdDeserializer<Item> { 

    public ItemDeserializer() { 
        this(null); 
    } 

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

    @Override
    public Item deserialize(JsonParser jp, DeserializationContext ctxt) 
      throws IOException, JsonProcessingException {
        JsonNode node = jp.getCodec().readTree(jp);
        int id = (Integer) ((IntNode) node.get("id")).numberValue();
        String itemName = node.get("itemName").asText();
        int userId = (Integer) ((IntNode) node.get("createdBy")).numberValue();

        return new Item(id, itemName, new User(userId, null));
    }
}

As you can see, the deserializer is working with the standard Jackson representation of JSON – the JsonNode. Once the input JSON is represented as a JsonNode, we can now extract the relevant information from it and construct our own Item entity.

Simply put, we need to register this custom deserializer and simply deserialize the JSON normally:

ObjectMapper mapper = new ObjectMapper();
SimpleModule module = new SimpleModule();
module.addDeserializer(Item.class, new ItemDeserializer());
mapper.registerModule(module);

Item readValue = mapper.readValue(json, Item.class);

4. Custom Deserializer on the Class

Alternatively, we can also register the deserializer directly on the class:

@JsonDeserialize(using = ItemDeserializer.class)
public class Item {
    ...
}

With the deserializer defined at the class level, there is no need to register it on the ObjectMapper – a default mapper will work fine:

Item itemWithOwner = new ObjectMapper().readValue(json, Item.class);

This type of per-class configuration is very useful in situations in which we may not have direct access to the raw ObjectMapper to configure.

5. Conclusion

This article shows how to leverage Jackson 2 to read non-standard JSON input – and how to map that input to any java entity graph with full control over the mapping.

The implementation of all these examples and code snippets can be found in over on GitHub – it’s a Maven-based project, so it should be easy to import and run as it is.

Related posts:

Case-Insensitive String Matching in Java
Java Program to implement Circular Buffer
Configure a RestTemplate with RestTemplateBuilder
Java Program to find the maximum subarray sum O(n^2) time(naive method)
Java Program to Check if it is a Sparse Matrix
Life Cycle of a Thread in Java
Java Program to Perform String Matching Using String Library
Spring Cloud Series – The Gateway Pattern
Java Program to Implement Gale Shapley Algorithm
How to Get a Name of a Method Being Executed?
Check if a String is a Palindrome in Java
Hướng dẫn Java Design Pattern – Abstract Factory
Sử dụng JDBC API thực thi câu lệnh truy vấn dữ liệu
Spring Boot Security Auto-Configuration
Quản lý bộ nhớ trong Java với Heap Space vs Stack
Chuyển đổi từ HashMap sang ArrayList
How to Find an Element in a List with Java
Java Program to Implement Interpolation Search Algorithm
Derived Query Methods in Spring Data JPA Repositories
Java Program to Find MST (Minimum Spanning Tree) using Prim’s Algorithm
Spring Cloud AWS – EC2
Hướng dẫn sử dụng biểu thức chính quy (Regular Expression) trong Java
Logging in Spring Boot
Spring 5 Functional Bean Registration
Java Program to Implement Hash Tables with Double Hashing
Working with Tree Model Nodes in Jackson
Concatenating Strings In Java
HttpClient Connection Management
Java Program to find the maximum subarray sum using Binary Search approach
Automatic Property Expansion with Spring Boot
Java Map With Case-Insensitive Keys
Java Program to Check if a Directed Graph is a Tree or Not Using DFS