Spring Boot中如何扩展XML请求和响应的支持

开发 开发工具
在之前的所有Spring Boot教程中,我们都只提到和用到了针对HTML和JSON格式的请求与响应处理。

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

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

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

[[249818]]

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

  1. public interface HttpMessageConverter<T> { 
  2.  
  3.     boolean canRead(Class<?> clazz, @Nullable MediaType mediaType); 
  4.  
  5.     boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType); 
  6.  
  7.     List<MediaType> getSupportedMediaTypes(); 
  8.  
  9.     T read(Class<? extends T> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException; 
  10.  
  11.     void write(T t, @Nullable MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException; 
  12.  

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

扩展实现

***步:引入Xml消息转换器

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

  1. @Configuration 
  2. public class MessageConverterConfig1 extends WebMvcConfigurerAdapter { 
  3.     @Override 
  4.     public void configureMessageConverters(List<HttpMessageConverter<?>> converters) { 
  5.         Jackson2ObjectMapperBuilder builder = Jackson2ObjectMapperBuilder.xml(); 
  6.         builder.indentOutput(true); 
  7.         converters.add(new MappingJackson2XmlHttpMessageConverter(builder.build())); 
  8.     } 

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

  1. <dependency> 
  2.     <groupId>com.fasterxml.jackson.dataformat</groupId> 
  3.     <artifactId>jackson-dataformat-xml</artifactId> 
  4. </dependency> 

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

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

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

  1. @Data 
  2. @NoArgsConstructor 
  3. @AllArgsConstructor 
  4. @JacksonXmlRootElement(localName = "User"
  5. public class User { 
  6.  
  7.     @JacksonXmlProperty(localName = "name"
  8.     private String name
  9.     @JacksonXmlProperty(localName = "age"
  10.     private Integer age; 
  11.  

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

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

  1. <User
  2.     <name>aaaa</name
  3.     <age>10</age> 
  4. </User

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

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

  1. @Controller 
  2. public class UserController { 
  3.  
  4.     @PostMapping(value = "/user",  
  5.         consumes = MediaType.APPLICATION_XML_VALUE,  
  6.         produces = MediaType.APPLICATION_XML_VALUE) 
  7.     @ResponseBody 
  8.     public User create(@RequestBody User user) { 
  9.         user.setName("didispace.com : " + user.getName()); 
  10.         user.setAge(user.getAge() + 100); 
  11.         return user
  12.     } 
  13.  

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

 

案例代码

可以通过下面两个仓库中查阅chapter3-1-8目录:

Github

Gitee

【本文为51CTO专栏作者“翟永超”的原创稿件,转载请通过51CTO联系作者获取授权】

 

戳这里,看该作者更多好文

责任编辑:武晓燕 来源: 51CTO专栏
相关推荐

2024-07-31 15:57:41

2024-10-15 10:28:43

2024-01-07 16:46:19

FiberHTTPWeb

2015-09-29 14:01:45

SPDY网络协议响应头网络协议

2021-12-13 07:50:14

cURL响应时间

2021-08-11 05:00:48

Spring 日志手段

2017-04-28 08:32:40

Spring BootDubbo Activ使用

2020-01-02 16:30:02

Spring BootJava异步请求

2023-09-19 22:41:30

控制器HTTP

2017-05-09 10:34:21

Spring BootDubbo Activ扩展

2023-03-01 13:54:53

Springpostion​继承

2009-12-09 09:55:39

ibmdwSpring

2024-09-25 08:10:00

Spring后端

2024-07-14 22:18:33

2024-05-30 08:51:28

Spring数据分布式

2024-04-18 09:34:28

Reactor项目异步编程

2021-05-17 07:28:23

Spring可扩展性项目

2022-11-10 07:53:54

Spring参数校验

2024-08-01 09:10:03

2023-12-05 07:48:23

SpringBoot
点赞
收藏

51CTO技术栈公众号