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

畫卷琴夢
发布: 2025-11-13 20:30:03
原创
752人浏览过
答案是添加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依赖:

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

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

  • 如果是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格式。控制器保持常规写法即可:

腾讯智影-AI数字人
腾讯智影-AI数字人

基于AI数字人能力,实现7*24小时AI数字人直播带货,低成本实现直播业务快速增增,全天智能在线直播

腾讯智影-AI数字人 73
查看详情 腾讯智影-AI数字人

@RestController
public class UserController {

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

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

<?xml version="1.0" encoding="UTF-8"?>
<user>
  <id>1</id>
  <name>张三</name>
</user>

验证XML返回结果

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

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

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

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

以上就是RESTful API返回xml格式数据 Spring Boot实现方法的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
热门推荐
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号