欢迎您访问新疆栾骏商贸有限公司,公司主营电子五金轴承产品批发业务!
全国咨询热线: 400-8878-609

新闻资讯

技术学院

RESTful API返回xml格式数据 Spring Boot实现方法

作者:畫卷琴夢2025-11-13 00:00:00
答案是添加jackson-dataformat-xml依赖并使用@XmlRootElement等JAXB注解配置实体类,Spring Boot将根据Accept: application/xml自动返回XML格式数据。

在Spring Boot中实现RESTful API返回XML格式数据,核心是确保请求响应内容类型为application/xml,并正确配置对象到XML的序列化支持。只要满足这两个条件,Spring会自动处理JSON与XML之间的内容协商。

添加Jackson XML依赖

Spring Boot默认使用Jackson处理JSON,若要支持XML,需引入jackson-dataformat-xml依赖:

  • 对于Maven项目,在pom.xml中加入:


  com.fasterxml.jackson.dataformat
  jackson-dataformat-xml

  • 如果是Gradle项目,在build.gradle中添加:

implementation 'com.fasterxml.jackson.dataformat:jackson-dataformat-xml'

创建可序列化的实体类

确保返回的对象使用JAXB注解或依赖Jackson的默认XML映射规则。推荐使用JAXB注解明确控制XML结构:

@XmlRootElement(name = "user")
public class User {
  private Long id;
  private String name;

  @XmlElement
  public Long getId() { return id; }

  @XmlElement
  public String getName() { return name; }
}

注意:@XmlRootElement标记根元素名称,@XmlElement确保字段被序列化。

控制器方法无需特殊处理

Spring Boot会根据客户端请求头中的Accept: application/xml自动选择返回XML格式。控制器保持常规写法即可:

@RestController
public class UserController {

  @GetMapping("/user/{id}")
  public User getUser(@PathVariable Long id) {
    return new User(id, "张三");
  }
}

当客户端发送请求并设置Accept: application/xml时,Spring会自动将User对象转为XML输出:



  1
  张三

验证XML返回结果

使用curl测试API是否能正确返回XML:

curl -H "Accept: application/xml" http://localhost:8080/user/1

确保响应头Content-Type: application/xml,且响应体为合法XML结构。

基本上就这些。只要添加XML依赖、实体类可序列化、客户端请求指定XML格式,Spring Boot会自动完成其余工作。不复杂但容易忽略JAXB注解或依赖缺失问题。