在之前的所有Spring Boot教程中,咱们都只提到和用到了针对HTML和JSON格局的申请与响应解决。那么对于XML格局的申请要如何疾速的在Controller中包装成对象,以及如何以XML的格局返回一个对象呢?
实现原理:音讯转换器(Message Converter)
在扩大上述问题之前,咱们先要晓得Spring Boot中解决HTTP申请的实现是采纳的Spring MVC。而在Spring MVC中有一个音讯转换器这个概念,它次要负责解决各种不同格局的申请数据进行解决,并包转换成对象,以提供更好的编程体验。
在Spring MVC中定义了HttpMessageConverter
接口,形象了音讯转换器对类型的判断、对读写的判断与操作,具体可见如下定义:
public interface HttpMessageConverter<T> { boolean canRead(Class<?> clazz, @Nullable MediaType mediaType); boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType); List<MediaType> 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(List<HttpMessageConverter<?>> converters) { Jackson2ObjectMapperBuilder builder = Jackson2ObjectMapperBuilder.xml(); builder.indentOutput(true); converters.add(new MappingJackson2XmlHttpMessageConverter(builder.build())); }}
在Spring Boot利用不必像下面这么麻烦,只须要退出jackson-dataformat-xml
依赖,Spring Boot就会主动引入MappingJackson2XmlHttpMessageConverter
的实现:
<dependency> <groupId>com.fasterxml.jackson.dataformat</groupId> <artifactId>jackson-dataformat-xml</artifactId></dependency>
同时,为了配置Xml数据与保护对象属性的关系所要应用的注解也在上述依赖中,所以这个依赖也是必须的。
第二步:定义对象与Xml的关系
做好了根底扩大之后,上面就能够定义Xml内容对应的Java对象了,比方:
@Data@NoArgsConstructor@AllArgsConstructor@JacksonXmlRootElement(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> <name>aaaa</name> <age>10</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内容。
本系列教程《Spring Boot 2.x基础教程》点击中转!。学习过程中如遇艰难,倡议退出Spring技术交换群,参加交换与探讨,更好的学习与提高!
代码示例
本文的相干例子能够查看上面仓库中的chapter2-8
目录:
- Github:https://github.com/dyc87112/SpringBoot-Learning/
- Gitee:https://gitee.com/didispace/SpringBoot-Learning/
如果您感觉本文不错,欢送Star
反对,您的关注是我保持的能源!
欢送关注我的公众号:程序猿DD,分享其余中央看不到的常识与思考