How to ignore "null" or empty properties in json, globally, using Spring configuration

Question

I'm trying to return only the properties that have values, but the null ones are also being returned.

I know that there's an annotation that does this ( @JsonInclude(Include.NON_NULL) ), but then I need these in every single entity class.

So, my question is: Is there a way to configure this globally through spring config? (avoiding XML, preferably)

EDIT: It seems that this question has been considered a duplicate, but I don't think so. The real question here is how to configure it through spring config, which I couldn't find in other questions.

Jon Peterson · Accepted Answer · 2016-08-08 13:23:29Z

26

If you are using Spring Boot, this is as easy as:

spring.jackson.serialization-inclusion=non_null

If not, then you can configure the ObjectMapper in the MappingJackson2HttpMessageConverter like so:

@Configuration
class WebMvcConfiguration extends WebMvcConfigurationSupport {
    @Override
    protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        for(HttpMessageConverter converter: converters) {
            if(converter instanceof MappingJackson2HttpMessageConverter) {
                ObjectMapper mapper = ((MappingJackson2HttpMessageConverter)converter).getObjectMapper()
                mapper.setSerializationInclusion(Include.NON_NULL);
            }
        }
    }
}

edited Aug 8, 2016 at 13:23

answered Aug 8, 2016 at 12:30

Jon Peterson

3,01628 silver badges33 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

David Tinker Over a year ago

It seems you need to use 'spring.jackson.default-property-inclusion = non_null' with newer Spring Boot (1.5.2)

Kevin Guanche Darias Over a year ago

The property from @DavidTinker didn't work for me, in Spring Boot 2.25, while the Java manual configuration worked

JRA_TLL · Accepted Answer · 2020-06-01 12:15:40Z

7

In newer versions of Spring Boot (2.0+), use:

spring.jackson.default-property-inclusion=non_null

answered Jun 1, 2020 at 12:15

JRA_TLL

1,38915 silver badges26 bronze badges

Comments

António Ribeiro · Accepted Answer · 2023-02-17 12:24:25Z

The programmatic alternative to Abolfazl Hashemi's answer is the following:

/**
 * Jackson configuration class.
 */
@Configuration
public class JacksonConfig {

    @Bean
    public ObjectMapper buildObjectMapper() {
       return new ObjectMapper().setSerializationInclusion(Include.NON_NULL);
    }
}

This way, you're basically telling to the Spring container that, every time an ObjectMapper is used, only properties with non-null values are to be included in the mappings.

Another alternative, as per the Spring Boot documentation, for Jackson 2+, is to configure it in the application.properties:

spring.jackson.default-property-inclusion=non_null

EDIT:

If, instead of application.properties one is relying on application.yml, then the following configuration should be used:

spring:
    jackson:
        default-property-inclusion: non_null

user85421 · Accepted Answer · 2018-02-15 14:11:53Z

4

If you use jackson ObjectMapper for generating json, you can define following custom ObjectMapper for this purpose and use it instead:

<bean id="jacksonObjectMapper" class="com.fasterxml.jackson.databind.ObjectMapper">
   <property name="serializationInclusion">
      <value type="com.fasterxml.jackson.annotation.JsonInclude.Include">NON_NULL</value>
   </property>
</bean>

edited Feb 15, 2018 at 14:11

user85421

29.8k11 gold badges66 silver badges96 bronze badges

answered Aug 8, 2016 at 12:19

Abolfazl Hashemi

7749 silver badges23 bronze badges

Collectives™ on Stack Overflow

How to ignore "null" or empty properties in json, globally, using Spring configuration

4 Answers 4

2 Comments

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

2 Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related