Как мы можем настроить внутренний картограф Джексона при использовании RestTemplate?

Question

Я хочу обновить свойства SerializationConfig.Feature... для картографа Джексона, используемого Spring RestTemplate. Любая идея, как я могу получить это или где я могу / должен его настроить.

Answer 1

По умолчанию RestTemplate конструктор регистрирует набор HttpMessageConverters:

this.messageConverters.add(new ByteArrayHttpMessageConverter());
this.messageConverters.add(new StringHttpMessageConverter());
this.messageConverters.add(new ResourceHttpMessageConverter());
this.messageConverters.add(new SourceHttpMessageConverter());
this.messageConverters.add(new XmlAwareFormHttpMessageConverter());
if (jaxb2Present) {
    this.messageConverters.add(new Jaxb2RootElementHttpMessageConverter());
}
if (jacksonPresent) {
    this.messageConverters.add(new MappingJacksonHttpMessageConverter());
}
if (romePresent) {
    this.messageConverters.add(new AtomFeedHttpMessageConverter());
    this.messageConverters.add(new RssChannelHttpMessageConverter());
}

MappingJacksonHttpMessageConverter по очереди создает ObjectMapper экземпляр напрямую. Вы можете найти этот конвертер и заменить ObjectMapper или зарегистрируйте новый перед этим. Это должно работать:

@Bean
public RestOperations restOperations() {
    RestTemplate rest = new RestTemplate();
    //this is crucial!
    rest.getMessageConverters().add(0, mappingJacksonHttpMessageConverter());
    return rest;
}

@Bean
public MappingJacksonHttpMessageConverter mappingJacksonHttpMessageConverter() {
    MappingJacksonHttpMessageConverter converter = new MappingJacksonHttpMessageConverter();
    converter.setObjectMapper(myObjectMapper());
    return converter;
}

@Bean
public ObjectMapper myObjectMapper() {
    //your custom ObjectMapper here
}

В XML это что-то вроде этого:

<bean id="restOperations" class="org.springframework.web.client.RestTemplate">
    <property name="messageConverters">
        <util:list>
            <bean class="org.springframework.http.converter.ByteArrayHttpMessageConverter"/>
            <bean class="org.springframework.http.converter.StringHttpMessageConverter"/>
            <bean class="org.springframework.http.converter.ResourceHttpMessageConverter"/>
            <bean class="org.springframework.http.converter.xml.SourceHttpMessageConverter"/>
            <bean class="org.springframework.http.converter.xml.XmlAwareFormHttpMessageConverter"/>
            <bean class="org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter"/>
            <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">
                <property name="objectMapper" ref="customObjectMapper"/>
            </bean>
        </util:list>
    </property>
</bean>

<bean id="customObjectMapper" class="org.codehaus.jackson.map.ObjectMapper"/>

Обратите внимание, что переход на самом деле не 1:1 - я должен явно создать messageConverters список в XML в то время как с @Configuration подход я мог бы ссылаться на существующий и просто изменить его. Но это должно работать.

Answer 2

Если вы не используете Spring IOC, вы можете сделать что-то вроде этого (Java 8):

ObjectMapper objectMapper = new ObjectMapper();
// configure your ObjectMapper here

RestTemplate restTemplate = new RestTemplate();    

MappingJackson2HttpMessageConverter messageConverter = new MappingJackson2HttpMessageConverter();
messageConverter.setPrettyPrint(false);
messageConverter.setObjectMapper(objectMapper);
restTemplate.getMessageConverters().removeIf(m -> m.getClass().getName().equals(MappingJackson2HttpMessageConverter.class.getName()));
restTemplate.getMessageConverters().add(messageConverter);

Answer 3

RestTemplate инициализирует конвертеры сообщений по умолчанию. Вы должны заменить MappingJackson2HttpMessageConverter с вашим собственным bean-компонентом, который должен использовать сопоставитель объектов, который вы хотите использовать. Это сработало для меня:

@Bean
public RestTemplate restTemplate() {
    final RestTemplate restTemplate = new RestTemplate();

    //find and replace Jackson message converter with our own
    for (int i = 0; i < restTemplate.getMessageConverters().size(); i++) {
        final HttpMessageConverter<?> httpMessageConverter = restTemplate.getMessageConverters().get(i);
        if (httpMessageConverter instanceof MappingJackson2HttpMessageConverter){
            restTemplate.getMessageConverters().set(i, mappingJackson2HttpMessageConverter());
        }
    }

    return restTemplate;
}

@Bean
public MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter() {
    MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
    converter.setObjectMapper(myObjectMapper());
    return converter;
}

@Bean
public ObjectMapper myObjectMapper() {
    // return your own object mapper
}

Answer 4

Для завершения других ответов: если ваш ObjectMapper просто регистрирует Джексона Module при использовании пользовательских сериализаторов / десериализаторов вы можете зарегистрировать свой модуль непосредственно на существующем ObjectMapper от RestTemplateпо умолчанию MappingJackson2HttpMessageConverter следующим образом (пример без DI, но то же самое относится и к DI):

    SimpleModule module = new SimpleModule();
    module.addSerializer(...);
    module.addDeserializer(...);

    MappingJackson2HttpMessageConverter messageConverter = restTemplate.getMessageConverters().stream()
                    .filter(MappingJackson2HttpMessageConverter.class::isInstance)
                    .map(MappingJackson2HttpMessageConverter.class::cast)
                    .findFirst().orElseThrow( () -> new RuntimeException("MappingJackson2HttpMessageConverter not found"));
    messageConverter.getObjectMapper().registerModule(module);

Это позволит вам завершить настройку оригинала ObjectMapper (как сделано Spring's Jackson2ObjectMapperBuilder), вместо того, чтобы заменить его.

Answer 5

Используя Spring Boot, это очень просто:

RestTemplate template = new RestTemplateBuilder()
                            .additionalMessageConverters(new MappingJackson2HttpMessageConverter(objectMapper))
                            .build()

(Проверено с помощью Spring Boot 2.2.1)

Answer 6

Чтобы просто обновить SerializationConfig.Feature, используя текущий ObjectMapper:

      RestTemplate restTemplate =  new RestTemplate();
restTemplate.getMessageConverters().forEach(mc -> {
            if (mc instanceof MappingJackson2HttpMessageConverter ) {
                //whatever you want to change
                ((MappingJackson2HttpMessageConverter) mc).getObjectMapper().setSerializationInclusion(Include.NON_NULL);
            }
        });