消息转换器

你可以在 Java 配置中设置要使用的 HttpMessageConverter 实例,通过覆盖 configureMessageConverters() 来替换默认使用的转换器。你也可以通过覆盖 extendMessageConverters() 在最后自定义配置的消息转换器列表。

在 Spring Boot 应用中,`WebMvcAutoConfiguration` 会在默认转换器之外,添加其检测到的任何 HttpMessageConverter bean。因此,在 Boot 应用中,最好使用 HttpMessageConverters 机制。或者,也可以使用 extendMessageConverters 在最后修改消息转换器。

以下示例添加了 XML 和 Jackson JSON 转换器,并使用自定义的 ObjectMapper 替换了默认的转换器

  • Java

  • Kotlin

  • Xml

@Configuration
public class WebConfiguration implements WebMvcConfigurer {

	@Override
	public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
		Jackson2ObjectMapperBuilder builder = new Jackson2ObjectMapperBuilder()
				.indentOutput(true)
				.dateFormat(new SimpleDateFormat("yyyy-MM-dd"))
				.modulesToInstall(new ParameterNamesModule());
		converters.add(new MappingJackson2HttpMessageConverter(builder.build()));
		converters.add(new MappingJackson2XmlHttpMessageConverter(builder.createXmlMapper(true).build()));
	}
}
@Configuration
class WebConfiguration : WebMvcConfigurer {

	override fun configureMessageConverters(converters: MutableList<HttpMessageConverter<*>>) {
		val builder = Jackson2ObjectMapperBuilder()
			.indentOutput(true)
			.dateFormat(SimpleDateFormat("yyyy-MM-dd"))
			.modulesToInstall(ParameterNamesModule())
		converters.add(MappingJackson2HttpMessageConverter(builder.build()))
		converters.add(MappingJackson2XmlHttpMessageConverter(builder.createXmlMapper(true).build()))
	}
}
<mvc:annotation-driven>
	<mvc:message-converters>
		<bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
			<property name="objectMapper" ref="objectMapper"/>
		</bean>
		<bean class="org.springframework.http.converter.xml.MappingJackson2XmlHttpMessageConverter">
			<property name="objectMapper" ref="xmlMapper"/>
		</bean>
	</mvc:message-converters>
</mvc:annotation-driven>

<bean id="objectMapper" class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean"
	  p:indentOutput="true"
	  p:simpleDateFormat="yyyy-MM-dd"
	  p:modulesToInstall="com.fasterxml.jackson.module.paramnames.ParameterNamesModule"/>

<bean id="xmlMapper" parent="objectMapper" p:createXmlMapper="true"/>

在前面的示例中,Jackson2ObjectMapperBuilder 用于为 MappingJackson2HttpMessageConverterMappingJackson2XmlHttpMessageConverter 创建通用配置,包括启用缩进、自定义日期格式以及注册 jackson-module-parameter-names,后者增加了对访问参数名称的支持(Java 8 中添加的功能)。

此 builder 如下自定义 Jackson 的默认属性

如果以下知名模块在类路径中被检测到,它也会自动注册

启用 Jackson XML 支持的缩进功能需要 woodstox-core-asl 依赖项,除了 jackson-dataformat-xml 依赖项之外。

还有其他有趣的 Jackson 模块可用