How do you globally set Jackson to ignore unknown properties within Spring?

XmlSpringJackson

Xml Problem Overview


Jackson has annotations for ignoring unknown properties within a class using:

@JsonIgnoreProperties(ignoreUnknown = true) 

It allows you to ignore a specific property using this annotation:

@JsonIgnore

If you'd like to globally set it you can modify the object mapper:

// jackson 1.9 and before
objectMapper.configure(DeserializationConfig.Feature.FAIL_ON_UNKNOWN_PROPERTIES, false);
// or jackson 2.0
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);

How do you set this globally using spring so it can be @Autowired at server start up without writing additional classes?

Xml Solutions


Solution 1 - Xml

For jackson 1.9x or below you can ignore unknown properties with object mapper provider

@Provider
@Component
public class JerseyObjectMapperProvider implements ContextResolver<ObjectMapper> {

    @Override
    public ObjectMapper getContext(Class<?> type) {

        ObjectMapper result = new ObjectMapper();
        result.configure(DeserializationConfig.Feature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        return result;
    }
}

For jackson 2.x and above you can ignore unknown properties with object mapper provider

@Provider
@Component
public class JerseyObjectMapperProvider implements ContextResolver<ObjectMapper> {

    @Override
    public ObjectMapper getContext(Class<?> type) {

        ObjectMapper result = new ObjectMapper();
        result.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        return result;
    }
}

Jersey classes are not auto-discovered by Spring. Have to register them manually.

public class JerseyConfig extends ResourceConfig {
    public JerseyConfig() {
        register(JerseyObjectMapperProvider.class);
    }
}

Solution 2 - Xml

This can be achieved using spring's MethodInvokingFactoryBean:

<!-- Jackson Mapper -->
<bean id="jacksonObjectMapper" class="org.codehaus.jackson.map.ObjectMapper" />
<bean class="org.springframework.beans.factory.config.MethodInvokingFactoryBean">
	<property name="targetObject" ref="jacksonObjectMapper" />
	<property name="targetMethod" value="configure" />
	<property name="arguments">
		<list>
			<value type="org.codehaus.jackson.map.DeserializationConfig.Feature">FAIL_ON_UNKNOWN_PROPERTIES</value>
			<value>false</value>
		</list>
	</property>
</bean>

This can be wired to a RestTemplate like this:

<bean id="restTemplate" class="org.springframework.web.client.RestTemplate">
	<property name="messageConverters">
		<list>
			<bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">
                <property name="objectMapper" ref="jacksonObjectMapper" />
            </bean>
		</list>
	</property>
</bean>

It can also be injected directly into the message converters for use with Spring MVC:

<mvc:annotation-driven>
	<mvc:message-converters>
		<!-- Jackson converter for HTTP messages -->
		<bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">
            <property name="objectMapper" ref="jacksonObjectMapper" />
        </bean>
	</mvc:message-converters>
</mvc:annotation-driven>

Solution 3 - Xml

For newer Jackson versions (2.x) there are a few changes:

<!-- Jackson Mapper -->
<bean id="jacksonObjectMapper" class="com.fasterxml.jackson.databind.ObjectMapper" />
<bean
	class="org.springframework.beans.factory.config.MethodInvokingFactoryBean">
	<property name="targetObject" ref="jacksonObjectMapper" />
	<property name="targetMethod" value="configure" />
	<property name="arguments">
		<list>
			<value type="com.fasterxml.jackson.databind.DeserializationFeature">FAIL_ON_UNKNOWN_PROPERTIES</value>
			<value>false</value>
		</list>
	</property>
</bean>

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionjnrcorpView Question on Stackoverflow
Solution 1 - XmlxdebugView Answer on Stackoverflow
Solution 2 - XmljnrcorpView Answer on Stackoverflow
Solution 3 - XmlpakmanView Answer on Stackoverflow