浙江鸿翔水利建设有限公司网站,北京高端网站建设制作设计,网站做多长时间才会成功,建设银行交学费网站2018在之前的所有Spring Boot教程中#xff0c;我们都只提到和用到了针对HTML和JSON格式的请求与响应处理。那么对于XML格式的请求要如何快速的在Controller中包装成对象#xff0c;以及如何以XML的格式返回一个对象呢#xff1f;
实现原理#xff1a;消息转换器#xff08;M…在之前的所有Spring Boot教程中我们都只提到和用到了针对HTML和JSON格式的请求与响应处理。那么对于XML格式的请求要如何快速的在Controller中包装成对象以及如何以XML的格式返回一个对象呢
实现原理消息转换器Message Converter
在扩展上述问题之前我们先要知道Spring Boot中处理HTTP请求的实现是采用的Spring MVC。而在Spring MVC中有一个消息转换器这个概念它主要负责处理各种不同格式的请求数据进行处理并包转换成对象以提供更好的编程体验。
在Spring MVC中定义了HttpMessageConverter接口抽象了消息转换器对类型的判断、对读写的判断与操作具体可见如下定义
public interface HttpMessageConverterT { boolean canRead(Class? clazz, Nullable MediaType mediaType); boolean canWrite(Class? clazz, Nullable MediaType mediaType); ListMediaType getSupportedMediaTypes(); T read(Class? extends T clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException; void write(T t, Nullable MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException;}众所周知HTTP请求的Content-Type有各种不同格式定义如果要支持Xml格式的消息转换就必须要使用对应的转换器。Spring MVC中默认已经有一套采用Jackson实现的转换器MappingJackson2XmlHttpMessageConverter。
扩展实现
第一步引入Xml消息转换器
在传统Spring应用中我们可以通过如下配置加入对Xml格式数据的消息转换实现
Configurationpublic class MessageConverterConfig1 extends WebMvcConfigurerAdapter { Override public void configureMessageConverters(ListHttpMessageConverter? converters) { Jackson2ObjectMapperBuilder builder Jackson2ObjectMapperBuilder.xml(); builder.indentOutput(true); converters.add(new MappingJackson2XmlHttpMessageConverter(builder.build())); }}在Spring Boot应用不用像上面这么麻烦只需要加入jackson-dataformat-xml依赖Spring Boot就会自动引入MappingJackson2XmlHttpMessageConverter的实现
dependency groupIdcom.fasterxml.jackson.dataformat/groupId artifactIdjackson-dataformat-xml/artifactId/dependency同时为了配置Xml数据与维护对象属性的关系所要使用的注解也在上述依赖中所以这个依赖也是必须的。
第二步定义对象与Xml的关系
做好了基础扩展之后下面就可以定义Xml内容对应的Java对象了比如
DataNoArgsConstructorAllArgsConstructorJacksonXmlRootElement(localName User)public class User { JacksonXmlProperty(localName name) private String name; JacksonXmlProperty(localName age) private Integer age;}其中Data、NoArgsConstructor、AllArgsConstructor是lombok简化代码的注解主要用于生成get、set以及构造函数。JacksonXmlRootElement、JacksonXmlProperty注解是用来维护对象属性在xml中的对应关系。
上述配置的User对象其可以映射的Xml样例如下后续可以使用上述xml来请求接口
User nameaaaa/name age10/age/User第三步创建接收xml请求的接口
完成了要转换的对象之后可以编写一个接口来接收xml并返回xml比如
Controllerpublic class UserController { PostMapping(value /user, consumes MediaType.APPLICATION_XML_VALUE, produces MediaType.APPLICATION_XML_VALUE) ResponseBody public User create(RequestBody User user) { user.setName(didispace.com : user.getName()); user.setAge(user.getAge() 100); return user; }}最后启动Spring Boot应用通过POSTMAN等请求工具尝试一下这个接口可以看到请求Xml并且返回了经过处理后的Xml内容。 案例代码
可以通过下面两个仓库中查阅chapter3-1-8目录
GithubGitee
以下专题教程也许您会有兴趣
Spring Boot基础教程Spring Cloud基础教程
