源码先锋

源码先锋

Spring Boot 如何扩展XML格式的请求和响应?

admin 170 188

在之前的所有SpringBoot教程中,我们都只提到和用到了针对HTML和JSON格式的请求与响应处理。那么对于XML格式的请求要如何快速的在Controller中包装成对象,以及如何以XML的格式返回一个对象呢?

实现原理:消息转换器(MessageConverter)

在扩展上述问题之前,我们先要知道SpringBoot中处理HTTP请求的实现是采用的SpringMVC。而在SpringMVC中有一个消息转换器这个概念,它主要负责处理各种不同格式的请求数据进行处理,并包转换成对象,以提供更好的编程体验。

在SpringMVC中定义了HttpMessageConverter接口,抽象了消息转换器对类型的判断、对读写的判断与操作,具体可见如下定义:

publicinterfaceHttpMessageConverterT{booleancanRead(Class?clazz,@NullableMediaTypemediaType);booleancanWrite(Class?clazz,@NullableMediaTypemediaType);ListMediaTypegetSupportedMediaTypes();Tread(Class?extsTclazz,HttpInputMessageinputMessage)throwsIOException,HttpMessageNotReadableException;voidwrite(Tt,@NullableMediaTypecontentType,HttpOutputMessageoutputMessage)throwsIOException,HttpMessageNotWritableException;}

众所周知,HTTP请求的Content-Type有各种不同格式定义,如果要支持Xml格式的消息转换,就必须要使用对应的转换器。SpringMVC中默认已经有一套采用Jackson实现的转换器MappingJackson2XmlHttpMessageConverter。

扩展实现

第一步:引入Xml消息转换器

在传统Spring应用中,我们可以通过如下配置加入对Xml格式数据的消息转换实现:

@ConfigurationpublicclassMessageConverterConfig1extsWebMvcConfigurerAdapter{@OverridepublicvoidconfigureMessageConverters(ListHttpMessageConverter?converters){Jackson2ObjectMapperBuilderbuilder=();(true);(newMappingJackson2XmlHttpMessageConverter(()));}}

在SpringBoot应用不用像上面这么麻烦,只需要加入jackson-dataformat-xml依赖,SpringBoot就会自动引入MappingJackson2XmlHttpMessageConverter的实现:

/groupIdartifactIdjackson-dataformat-xml/artifactId/depency

同时,为了配置Xml数据与维护对象属性的关系所要使用的注解也在上述依赖中,所以这个依赖也是必须的。

第二步:定义对象与Xml的关系

做好了基础扩展之后,下面就可以定义Xml内容对应的Java对象了,比如:

@Data@NoArgsConstructor@AllArgsConstructor@JacksonXmlRootElement(localName="User")publicclassUser{@JacksonXmlProperty(localName="name")privateStringname;@JacksonXmlProperty(localName="age")privateIntegerage;}

其中:@Data、@NoArgsConstructor、@AllArgsConstructor是lombok简化代码的注解,主要用于生成get、set以及构造函数。@JacksonXmlRootElement、@JacksonXmlProperty注解是用来维护对象属性在xml中的对应关系。

上述配置的User对象,其可以映射的Xml样例如下(后续可以使用上述xml来请求接口):

Usernameaaaa/nameage10/age/User

第三步:创建接收xml请求的接口

完成了要转换的对象之后,可以编写一个接口来接收xml并返回xml,比如:

@ControllerpublicclassUserController{@PostMapping(value="/user",consumes=_XML_VALUE,produces=_XML_VALUE)@ResponseBodypublicUsercreate(@RequestBodyUseruser){(":"+());(()+100);returnuser;}}

最后,启动SpringBoot应用,通过POSTMAN等请求工具,尝试一下这个接口,可以看到请求Xml,并且返回了经过处理后的Xml内容。

代码示例

本文的相关例子可以查看下面仓库中的chapter2-8目录:

Github:

Gitee: