您如何全局设置 Jackson 以忽略 Spring 中的未知属性？

Posted 2023-02-25

【中文标题】您如何全局设置 Jackson 以忽略 Spring 中的未知属性？

【英文标题】：How do you globally set Jackson to ignore unknown properties within Spring?

【发布时间】：2012-12-29 21:22:21

【问题描述】：

Jackson 有用于忽略类中未知属性的注释：

@JsonIgnoreProperties(ignoreUnknown = true) 

它允许您使用此注释忽略特定属性：

@JsonIgnore

如果您想全局设置它，您可以修改对象映射器：

// 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);

如何使用 spring 全局设置它，以便在服务器启动时它可以是 @Autowired 而无需编写额外的类？

【参考方案1】：

对于 jackson 1.9x 或更低版本，您可以使用对象映射器提供程序忽略未知属性

@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;
    

对于 jackson 2.x 及更高版本，您可以使用对象映射器提供程序忽略未知属性

@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 类不会被 Spring 自动发现。必须手动注册。

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

【讨论】：

注意：要将此 Jersey 配置与 Spring Boot 一起使用，您还需要手动注册：/** * Jersey classes are not auto-discovered by Spring. Have to register them manually. */ @Named public class JerseyConfig extends ResourceConfig public JerseyConfig() this.register(JerseyObjectMapperProvider.class);

感谢@Alex的建议

【参考方案2】：

这可以使用spring的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>

这可以像这样连接到 RestTemplate：

<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>

它也可以直接注入到消息转换器中以与 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>

【讨论】：

不确定有什么区别，但我使用的是 com.fasterxml.jackson.databind.ObjectMapper，因此必须使用 com.fasterxml.jackson.databind.DeserializationFeature。如果您仔细查看 jacksonObjectMapper bean 及其关联的 MethodInvokingFactoryBean，则会略有不同。

对于 Jackson v2 定义的消息转换应该是：org.springframework.http.converter.json.MappingJackson2HttpMessageConverter

【参考方案3】：

对于较新的 Jackson 版本 (2.x)，有一些更改：

<!-- 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>

【讨论】：

在Java代码中是这样的：objectMapper.configure(com.fasterxml.jackson.databind.DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);