通晓SpringBoot系列之xml形式参量传递与返还

2023-10-03 16:12:30

从xml传输到json传输的奇妙缘由

近来为支持使用微信公众号来登陆个人网站，意外发现微信的回调协议竟为xml格式。回想以前对于参数传输用json比较多，换成xml后，程序似乎没有想象中那么顺畅。因此，特此记录一下。

深入领略SpringBoot参量传递与返还

用注解解惑参数解析的秘密

在SpringBoot，我们可以利用@RequestBody注释来获取JSON请求的类对象。对于xml的请求参数获取，我们同样可以用该注解，但是需搭配XML实体类一起使用。

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement(name = "root")
public class XMLRequest {

    @XmlElement(name = "name")
    private String name;

    @XmlElement(name = "age")
    private int age;

}

配合以上代码，只需在接收请求的方法上加上@RequestBody注释，就能完成xml类实体的自动接收：

@PostMapping("/xml/receive")
public void receive(@RequestBody XMLRequest request) {
    System.out.println("姓名: " + request.getName());
    System.out.println("年龄: " + request.getAge());
}

轻松实现返回值以xml形式呈现

值得注意的是，SpringBoot不仅仅提供xml数据接收的支持，它也支持将数据以xml格式返回。

SpringBoot支持Rest风格的Controller，我们可通过定义一个jackson的xml序列化类以XML形式返回数据，用法如下：

import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;

@JacksonXmlRootElement(localName = "root")
public class XMLResponse {

    @JacksonXmlProperty(localName = "name")
    private String name;

    @JacksonXmlProperty(localName = "age")
    private int age;

}

@GetMapping("/xml/return")
public XMLResponse returnXML() {
    XMLResponse response = new XMLResponse();
    response.setName("zhangsan");
    response.setAge(20);
    return response;
}