Spring Boot 中 REST 接口怎么返回 JSON

陌杰同学_5526

陌杰同学_5526

2026-10-10

304人浏览

原创

spring boot返回json的核心是:用@restcontroller注解、写好含getter的实体类、确保字段可序列化;默认集成jackson自动转换,支持null处理、统一result封装及json/xml多格式响应。

spring boot 中 rest 接口怎么返回 json

Spring Boot 返回 JSON 非常简单,核心就三点:用对注解、写好实体类、确保字段可序列化。

用 @RestController 直接返回对象

这是最常用也最直接的方式。只要 Controller 类加上 @RestController,方法返回任意 Java 对象(如 User、List),Spring Boot 就会自动用 Jackson 把它转成 JSON 响应给前端。

  • 不需要手动调用 JSON 工具类,也不用写 response.getWriter().write(...)
  • 底层已默认集成 jackson-databind,无需额外配置就能工作
  • 如果返回 null,JSON 中对应字段就是 null;若想跳过 null 字段,可在实体类上加 @JsonInclude(JsonInclude.Include.NON_NULL)

字段要能被 Jackson 读取

Jackson 默认靠 getter 方法提取字段值,所以实体类必须满足基本要求:

Java Maven Secondary Analysis
Java Maven Secondary Analysis

分析ZIP压缩包或GitLab仓库中的Java Maven项目,确定二次开发范围、类数量、模块分布及生产相关指标。

下载
  • 所有需要输出的字段,必须有 public 的 getter 方法(如 getName())
  • 推荐使用 Lombok 的 @Data 或 @Getter/@Setter 自动生成,避免手写遗漏
  • 不要把接口类型(如 ReportHeader)直接当字段用——Jackson 不知道该实例化哪个实现类,会报 HttpMessageNotWritableException;应改用具体实现类或 DTO

统一响应格式更规范

实际项目中,前端通常期望固定结构,比如:{"code":200,"message":"OK","data":{...}}。这时建议封装一个泛型结果类:

  • 定义 Result<t></t> 类,含 code、message、data 三个字段
  • 搭配枚举 ResultCode 管理状态码和提示语,避免硬编码
  • Controller 中统一返回 Result.success(user),而不是裸对象,前后端协作更稳

按需支持多种格式(JSON / XML)

如果接口还要兼容 XML,只需引入 jackson-dataformat-xml 依赖,再在方法上指定 produces:

  • @GetMapping(path = "/user", produces = MediaType.APPLICATION_JSON_VALUE) → 返回 JSON
  • @GetMapping(path = "/user", produces = MediaType.APPLICATION_XML_VALUE) → 返回 XML
  • 浏览器访问时,也可通过 Accept 请求头自动协商格式(需开启 content-negotiation)

相关专题

更多
spring boot框架优点
spring boot框架优点

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

2023.09.05

591

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

4606

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

640

18

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

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

2026.02.11

385

24

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

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

2026.02.12

351

18

Spring Boot 项目开发与实战
Spring Boot 项目开发与实战

以 Spring Boot 为核心,讲解项目的快速初始化(Spring Initializr)、自动配置与 Starter 依赖原理、配置文件(application.yml)多环境管理、RESTful API 接口开发与参数校验、MyBatis / MyBatis-Plus / Spring Data JPA 数据持久层整合、Redis 缓存集成、统一异常处理与全局响应封装、Swagger / Knife4j 接口文档生成,以及 Ma

2026.04.17

326

21

Java Spring Boot多租户架构设计与数据隔离实战
Java Spring Boot多租户架构设计与数据隔离实战

本专题聚焦 Java 企业级系统中的多租户架构设计,讲解数据隔离策略、租户路由机制、数据库分库分表方案以及权限控制模型。通过真实 SaaS 系统案例,帮助开发者构建可扩展的多租户应用架构。

2026.06.29

356

13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习