消息转换器

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

在 Spring Boot 应用程序中,WebMvcAutoConfiguration 会添加它检测到的任何 HttpMessageConverter bean,以及默认转换器。因此,在 Boot 应用程序中,建议使用 HttpMessageConverters 机制。或者,使用 extendMessageConverters 在最后修改消息转换器。

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

  • Java

  • Kotlin

@Configuration
@EnableWebMvc
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
@EnableWebMvc
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()))

在前面的示例中,Jackson2ObjectMapperBuilder 用于为 MappingJackson2HttpMessageConverterMappingJackson2XmlHttpMessageConverter 创建一个公共配置,其中启用了缩进,自定义了日期格式,并注册了 jackson-module-parameter-names,它添加了对访问参数名称的支持(Java 8 中添加的功能)。

此构建器按如下方式自定义 Jackson 的默认属性

它还会自动注册以下众所周知的模块(如果在类路径中检测到):

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

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

以下示例展示了如何在 XML 中实现相同的配置

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