RESTful API返回xml格式数据 Spring Boot实现方法_石家庄创泽智能科技有限公司

新闻中心 NEWS CENTER

您当前位置：首页 > 新闻中心 > 网络学院

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

2025-11-13

浏览次数：次

返回列表

答案是添加jackson-dataformat-xml依赖并使用@XmlRootElement等JAXB注解配置实体类，Spring Boot将根据Accept: application/xml自动返回XML格式数据。

restful api返回xml格式数据 spring boot实现方法

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

添加Jackson XML依赖

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

对于M*en项目，在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格式。控制器保持常规写法即可：

Perplexity

Perplexity是一个ChatGPT和谷歌结合的超级工具，可以让你在浏览互联网时提出问题或获得即时摘要

302 查看详情 Perplexity

@RestController
public class UserController {

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