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

Question

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

而无需编写额外的类？

Answer 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);
    }
}

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

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

Answer 4

对于那些正在使用 FeignClient 的人。 只需在 Feign 中定义自定义配置，并提供 Jacksondecoder 即可。

下面的示例

@FeignClient(value = "name", url = "sample.url", configuration = XyzFeignClientConfig.class)

在你的 feign 配置中只返回 JacksonDecoder 的 bean。

public class XyzFeignClientConfig {
    @Bean
    public Decoder decoder() {
        return new JacksonDecoder();
    }
}

Answer 5

只需在application.yaml文件中添加：

spring:
  jackson:
    deserialization:
      FAIL_ON_UNKNOWN_PROPERTIES: false