Ignore Null Fields with Jackson

Last updated: February 9, 2023

Written by: Eugen Paraschiv

Data
Jackson

Jackson Basics
Java Null

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

This quick tutorial is going to cover how to set up Jackson to ignore null fields when serializing a java class.

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

Jackson - Change Name of Field

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

Jackson - Decide What Fields Get Serialized/Deserialized

How to control which fields get serialized/deserialized by Jackson and which fields get ignored.

2. Ignore Null Fields on the Class

Jackson allow us to control this behavior at either the class level:

@JsonInclude(Include.NON_NULL)public class MyDto { ... }

Or with more granularity at the field level:

public class MyDto { @JsonInclude(Include.NON_NULL) private String stringValue; private int intValue; // standard getters and setters}

Now we should be able to test that null values are indeed not part of the final JSON output:

@Testpublic void givenNullsIgnoredOnClass_whenWritingObjectWithNullField_thenIgnored() throws JsonProcessingException { ObjectMapper mapper = new ObjectMapper(); MyDto dtoObject = new MyDto(); String dtoAsString = mapper.writeValueAsString(dtoObject); assertThat(dtoAsString, containsString("intValue")); assertThat(dtoAsString, not(containsString("stringValue")));}

3. Ignore Null Fields Globally

Jackson also allows us to configure this behavior globally on the ObjectMapper:

mapper.setSerializationInclusion(Include.NON_NULL);

Now any null field in any class serialized through this mapper is going to be ignored:

@Testpublic void givenNullsIgnoredGlobally_whenWritingObjectWithNullField_thenIgnored() throws JsonProcessingException { ObjectMapper mapper = new ObjectMapper(); mapper.setSerializationInclusion(Include.NON_NULL); MyDto dtoObject = new MyDto(); String dtoAsString = mapper.writeValueAsString(dtoObject); assertThat(dtoAsString, containsString("intValue")); assertThat(dtoAsString, containsString("booleanValue")); assertThat(dtoAsString, not(containsString("stringValue")));}

4. Conclusion

Ignoring null fields is such a common Jackson configuration because it’s often the case that we need to have better control over the JSON output. This article demonstrates how to do that for classes. There are, however, more advanced use cases, such as ignoring null values when serializing a Map.

The implementation of all of these examples and code snippets can be found in the Github project.

Ignore Null Fields with Jackson | Baeldung (2024)