Spring Boot中如何实现XML请求和响应的支持

springboot接口都默认支持json格式数据的请求返回，那么对于XML格式的请求要如何快速的在Controller中包装成对象，以及如何以XML的格式返回一个对象呢？我们先要知道Spring Boot中处理HTTP请求的实现是采用的Spring MVC。而在Spring MVC中有一个消息转换器这个概念，它主要负责处理各种不同格式的请求数据进行处理，并包转换成对象。

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

那么springboot如何实现呢？

第一步：导入依赖：

在Spring Boot只需要加入jackson-dataformat-xml依赖，Spring Boot就会自动引入MappingJackson2XmlHttpMessageConverter的实现：

<dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-xml</artifactId>
</dependency>

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

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

使用注解实现对象与mxl的映射，比如：

@Data     //lombok插件，自动生成get，set方法
@NoArgsConstructor //lombok插件，生成无参构造方法
@AllArgsConstructor  //lombok插件，生成有参构造方法
@JacksonXmlRootElement(localName = "User") //映射xml的根标签名称为User;
public class User {

    @JacksonXmlProperty(localName = "name")
    //映射每一个属性为一个标签，可指定生成的标签名
    private String name;
    @JacksonXmlProperty(localName = "age")
    private Integer age;

}

注意：@JacksonXmlRootElement、@JacksonXmlProperty注解是用来维护对象属性在xml中的对应关系。

上述配置的User对象，其可以映射的Xml样例如下（后续可以使用上述xml来请求接口）：

<User>
    <name>asdf</name>
    <age>100</age>
</User>

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

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

@RestController
public class UserController {

    @PostMapping(value = "/user", consumes = MediaType.APPLICATION_XML_VALUE, produces = MediaType.APPLICATION_XML_VALUE)
    //注意；consumes注解用于标识，该方法接受xml参数，并反序列化为对应的对象；
     //  produces注解用于标识，该方法的返回值为xml参数，将返回的对象序列化为xml，
    public User create(@RequestBody User user) {
        user.setName("didispace.com : " + user.getName());
        user.setAge(user.getAge() + 100);
        return user;
    }

}

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

在这里插入图片描述
扩展：
　　 @JacksonXmlElementWrapper：可用于指定List等集合类，外围标签名；
　　 @JacksonXmlProperty：指定包装标签名，或者指定标签内部属性名；
　　 @JacksonXmlRootElement：指定生成xml根标签的名字；
　　 @JacksonXmlText：指定当前这个值，没有xml标签包裹。