Spring Boot中扩展XML请求与响应的支持详解

前言

在之前的所有spring boot教程中，我们都只提到和用到了针对html和json格式的请求与响应处理。那么对于xml格式的请求要如何快速的在controller中包装成对象，以及如何以xml的格式返回一个对象呢？

什么是xml文件格式

我们要给对方传输一段数据，数据内容是“too young,too simple,sometimes naive”，要将这段话按照属性拆分为三个数据的话，就是，年龄too young，阅历too simple，结果sometimes naive。我们都知道程序不像人，可以体会字面意思，并自动拆分出数据，因此，我们需要帮助程序做拆分，因此出现了各种各样的数据格式以及拆分方式。比如，可以是这样的数据为“too young,too simple,sometimes naive”然后按照逗号拆分，第一部分为年龄，第二部分为阅历，第三部分为结果。也可以是这样的数据为“too_young* too_simple*sometimes_naive”从数据开头开始截取前面十一个字符，去掉号并把下划线替换为空格作为第一部分，再截取接下来的十一个字符同样去掉并替换下划线为空格作为第二部分，最后把剩下的字符同样去号体会空格作为第三部分。这两种方式都可以用来容纳数据并能够被解析，但是不直观，通用性也不好，而且如果出现超过限定字数的字符串就容纳不了，也可能出现数据本身就下划线字符导致需要做转义。基于这种情况，出现了xml这种数据格式， 上面的数据用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格式数据的消息转换实现：

@configuration
public 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，比如：

@controller
public 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目录：

• github
• gitee
• 本地下载

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对的支持。