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

大墨君_1599

大墨君_1599

2025-11-13

888人浏览

原创

答案是添加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中加入:


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

jm-jsjkxyjs02-zlm-405
jm-jsjkxyjs02-zlm-405

使用约定式提交(Conventional Commits)生成标准化的 Git 提交信息。适用于以下场景: (1) 暂存更改时需要提交信息; (2) 审查 diff 时希望获得结构化摘要; (3) 编写 PR 描述或变更日志(changelog)条目; (4) 用户明确要求“为本次更改编写提交信息”。 该功能会分析已暂存/未暂存的 diff,并生成按类型(type)划分范围的提交信息。

下载

@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注解或依赖缺失问题。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

2025.08.06

2811

22

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

2026.01.26

497

25

spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.05

691

5

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

2023.10.12

1455

7

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

2025.08.19

5426

10

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

2025.12.22

436

5

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

2025.12.24

680

18

Spring Boot企业级开发与MyBatis Plus实战
Spring Boot企业级开发与MyBatis Plus实战

本专题面向 Java 后端开发者,系统讲解如何基于 Spring Boot 与 MyBatis Plus 构建高效、规范的企业级应用。内容涵盖项目架构设计、数据访问层封装、通用 CRUD 实现、分页与条件查询、代码生成器以及常见性能优化方案。通过完整实战案例,帮助开发者提升后端开发效率,减少重复代码,快速交付稳定可维护的业务系统。

2026.02.11

405

24

Kotlin协程编程与Spring Boot集成实践
Kotlin协程编程与Spring Boot集成实践

本专题围绕 Kotlin 协程机制展开,深入讲解挂起函数、协程作用域、结构化并发与异常处理机制,并结合 Spring Boot 展示协程在后端开发中的实际应用。内容涵盖异步接口设计、数据库调用优化、线程资源管理以及性能调优策略,帮助开发者构建更加简洁高效的 Kotlin 后端服务架构。

2026.02.12

391

18

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21.3万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习