Jackson Unmarshalling JSON with Unknown Properties

Last updated: December 8, 2021

Written by: Eugen Paraschiv

Data
Jackson

Jackson Basics

It's finally here:

>> The Road toMembership and Baeldung Pro.

Going into ads, no-ads reading, and bit about howBaeldung works if you're curious :)

Azure Container Apps is a fully managed serverless containerservice that enables you to build and deploy modern,cloud-native Java applications and microservices at scale. Itoffers a simplified developer experience while providing theflexibility and portability of containers.

Of course, Azure Container Apps has really solid support for ourecosystem, from a number of build options, managed Java components,native metrics, dynamic logger, and quite a bit more.

To learn more about Java features on Azure Container Apps, visitthe documentationpage.

You can also ask questions and leave feedback on the AzureContainer Apps GitHub page.

Java applications have a notoriously slow startup and a longwarmup time. The CRaC (Coordinated Restore at Checkpoint)project from OpenJDK can help improve these issues by creating acheckpoint with an application's peak performance and restoringan instance of the JVM to that point.

To take full advantage of this feature, BellSoft providescontainers that are highly optimized for Java applications. Thesepackage Alpaquita Linux (a full-featured OS optimized for Java andcloud environment) and Liberica JDK (an open-source Java runtimebased on OpenJDK).

These ready-to-use images allow us to easily integrate CRaCin a Spring Boot application:

Improve Javaapplication performance with CRaC support

Modern software architecture is often broken. Slow deliveryleads to missed opportunities, innovation is stalled due toarchitectural complexities, and engineering resources areexceedingly expensive.

Orkes is the leading workflow orchestration platformbuilt to enable teams to transform the way they develop, connect,and deploy applications, microservices, AI agents, and more.

With Orkes Conductor managed through Orkes Cloud, developers canfocus on building mission critical applications without worryingabout infrastructure maintenance to meet goals and, simply put,taking new products live faster and reducing total cost ofownership.

Try a 14-DayFree Trial of Orkes Conductor today.

Of course, Azure Container Apps has really solid support for ourecosystem, from a number of build options, managed Java components,native metrics, dynamic logger, and quite a bit more.

To learn more about Java features on Azure Container Apps, youcan get started over on the documentation page.

And, you can also ask questions and leave feedback on the AzureContainer Apps GitHub page.

1. Overview

In this tutorial, we’re going to take a look at the unmarshalling process with Jackson 2.x, specifically how to deal with JSON content with unknown properties.

To dig deeper and learn other cool things we can do with Jackson, we can check out the main Jackson tutorial.

Jackson Ignore Properties on Marshalling

Control your JSON Output - Ignore certain fields directly, by name or by type (with mixins) for Jackson bliss.

Jackson - Change Name of Field

Jackson - Change the name of a field to adhere to a specific JSON format.

2. Unmarshall a JSON With Additional/Unknown Fields

JSON input comes in all shapes and sizes, and most of the time, we need to map it to predefined Java objects with a set number of fields. The goal is to simply ignore any JSON properties that cannot be mapped to an existing Java field.

For example, say we need to unmarshal JSON to the following Java entity:

public class MyDto { private String stringValue; private int intValue; private boolean booleanValue; // standard constructor, getters and setters }

**2.1. UnrecognizedPropertyException on Unknown Fields**

Trying to unmarshala JSON with unknown properties to this simple Java Entity will lead to a com.fasterxml.jackson.databind.exc.UnrecognizedPropertyException:

@Test(expected = UnrecognizedPropertyException.class)public void givenJsonHasUnknownValues_whenDeserializingAJsonToAClass_thenExceptionIsThrown() throws JsonParseException, JsonMappingException, IOException { String jsonAsString = "{\"stringValue\":\"a\"," + "\"intValue\":1," + "\"booleanValue\":true," + "\"stringValue2\":\"something\"}"; ObjectMapper mapper = new ObjectMapper(); MyDto readValue = mapper.readValue(jsonAsString, MyDto.class); assertNotNull(readValue);}

This will fail with the following exception:

com.fasterxml.jackson.databind.exc.UnrecognizedPropertyException: Unrecognized field "stringValue2" (class org.baeldung.jackson.ignore.MyDto), not marked as ignorable (3 known properties: "stringValue", "booleanValue", "intValue"])

2.2. Dealing With Unknown Fields Using the ObjectMapper

We can now configure the full ObjectMapper to ignore unknown properties in the JSON:

new ObjectMapper() .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)

We should then be able to read this kind of JSON into a predefined Java entity:

@Testpublic void givenJsonHasUnknownValuesButJacksonIsIgnoringUnknownFields_whenDeserializing_thenCorrect() throws JsonParseException, JsonMappingException, IOException { String jsonAsString = "{\"stringValue\":\"a\"," + "\"intValue\":1," + "\"booleanValue\":true," + "\"stringValue2\":\"something\"}"; ObjectMapper mapper = new ObjectMapper() .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); MyDto readValue = mapper.readValue(jsonAsString, MyDto.class); assertNotNull(readValue); assertThat(readValue.getStringValue(), equalTo("a")); assertThat(readValue.isBooleanValue(), equalTo(true)); assertThat(readValue.getIntValue(), equalTo(1));}

2.3. Dealing With Unknown Fields at the Class Level

We can also mark a single class as accepting unknown fields, instead of the entire Jackson ObjectMapper:

@JsonIgnoreProperties(ignoreUnknown = true)public class MyDtoIgnoreUnknown { ... }

Now we should be able to test the same behavior as before. The unknown fields are simply ignored, and only known fields are mapped:

@Testpublic void givenJsonHasUnknownValuesButUnknownFieldsAreIgnoredOnClass_whenDeserializing_thenCorrect() throws JsonParseException, JsonMappingException, IOException { String jsonAsString = "{\"stringValue\":\"a\"," + "\"intValue\":1," + "\"booleanValue\":true," + "\"stringValue2\":\"something\"}"; ObjectMapper mapper = new ObjectMapper(); MyDtoIgnoreUnknown readValue = mapper .readValue(jsonAsString, MyDtoIgnoreUnknown.class); assertNotNull(readValue); assertThat(readValue.getStringValue(), equalTo("a")); assertThat(readValue.isBooleanValue(), equalTo(true)); assertThat(readValue.getIntValue(), equalTo(1));}

3. Unmarshall an Incomplete JSON

Similar to additional unknown fields, unmarshalling an incomplete JSON, a JSON that doesn’t contain all the fields in the Java class, isn’t a problem with Jackson:

@Testpublic void givenNotAllFieldsHaveValuesInJson_whenDeserializingAJsonToAClass_thenCorrect() throws JsonParseException, JsonMappingException, IOException { String jsonAsString = "{"stringValue":"a","booleanValue":true}"; ObjectMapper mapper = new ObjectMapper(); MyDto readValue = mapper.readValue(jsonAsString, MyDto.class); assertNotNull(readValue); assertThat(readValue.getStringValue(), equalTo("a")); assertThat(readValue.isBooleanValue(), equalTo(true));}

4. Conclusion

In this article, we discussed deserializing a JSON with additional, unknown properties using Jackson.

This is one of the most common things to configure when working with Jackson, since we often need to map JSON results of external REST APIs to an internal Java representation of the entities of the API.

The implementation of all of these examples and code snippets can be found in my GitHub project.

Jackson Unmarshalling JSON with Unknown Properties | Baeldung (2024)