0

0

Spring Boot 中正确返回嵌套 JSON 结构的实践方法

花韻仙語

花韻仙語

发布时间:2026-01-01 14:02:02

|

711人浏览过

|

来源于php中文网

原创

Spring Boot 中正确返回嵌套 JSON 结构的实践方法

本文详解如何在 spring boot 中规范返回符合 `{ "code": "...", "msg": "...", "data": { "data": [...] } }` 嵌套格式的 json 响应,避免因 map 直接嵌套导致结构错位,并推荐使用类型安全的 pojo 方式替代动态 map 构建。

在 Spring Boot 中,@ResponseBody 默认借助 Jackson 将返回对象序列化为 JSON。但直接使用 Map 容易引发结构歧义——如原代码中 map.put("data", info.getList()) 会将列表直接赋给顶层 "data" 字段,导致输出为 "data": [],而非期望的 "data": { "data": [] }。根本原因在于:JSON 对象(Object)与数组(Array)语义不同,而 Map 的 value 是扁平化的,无法天然表达“data 字段下再嵌套一个 data 字段”的层级关系

要精准生成目标结构,推荐采用 强类型 POJO 封装,而非动态 Map 拼接。以下是完整实现方案:

✅ 正确做法:定义分层响应实体类

首先创建统一响应结构类(推荐泛型化以提升复用性):

Pi智能演示文档
Pi智能演示文档

领先的AI PPT生成工具

下载
public class ApiResponse {
    private String code;
    private String msg;
    private DataWrapper data; // 关键:用独立类封装内层 "data" 对象

    public static  ApiResponse success(T data) {
        ApiResponse res = new ApiResponse<>();
        res.code = "200";
        res.msg = "success";
        res.data = new DataWrapper<>(data);
        return res;
    }

    // getter / setter 省略,或使用 Lombok @Data
}

// 专门承载内层 { "data": [...] } 的包装类
public class DataWrapper {
    private T data;

    public DataWrapper(T data) {
        this.data = data;
    }

    // getter / setter
    public T getData() { return data; }
    public void setData(T data) { this.data = data; }
}

✅ Controller 层改造(简洁、类型安全)

@RestController // 替代 @Controller + @ResponseBody
@RequestMapping("/index/property")
public class PropertyController {

    @Autowired
    private PropertyService propertyService;

    @GetMapping("/list") // 使用语义更清晰的注解
    public ApiResponse> getPropertyList(
            @RequestParam(defaultValue = "1") int pageNumber,
            @RequestParam(defaultValue = "5") int pageSize) {

        PageHelper.startPage(pageNumber, pageSize, true);
        List propertyList = propertyService.queryList();
        PageInfo pageInfo = new PageInfo<>(propertyList);

        return ApiResponse.success(pageInfo.getList());
    }
}
? 提示:@RestController = @Controller + @ResponseBody,语义更明确;@GetMapping 是 @RequestMapping(method = GET) 的快捷写法,增强可读性。

⚠️ 注意事项与最佳实践

  • 避免 Map 链式拼装:Map 虽灵活,但易出错、不可校验、缺乏 IDE 支持,仅适合极简原型;
  • 统一响应结构:生产环境建议全局定义 ApiResponse,配合全局异常处理器(@ControllerAdvice)统一处理错误码与消息;
  • Jackson 序列化控制:若需忽略空字段,可在类上加 @JsonInclude(JsonInclude.Include.NON_NULL);
  • 性能考量:POJO 方式比反射构建 Map 更高效,且利于 JVM JIT 优化。

通过上述方式,最终返回的 JSON 将严格符合预期格式:

{
  "code": "200",
  "msg": "success",
  "data": {
    "data": [
      { "id": 1, "name": "A" },
      { "id": 2, "name": "B" }
    ]
  }
}

这不仅解决了当前嵌套结构问题,更为后续接口标准化、前端解耦和团队协作奠定了坚实基础。

相关专题

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

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

98

2025.08.06

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

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

135

2023.09.05

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

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

384

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

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

64

2025.08.19

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

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

11

2025.12.22

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

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

101

2025.12.24

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

403

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

528

2023.08.23

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

7

2025.12.31

热门下载

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

精品课程

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

共101课时 | 8.1万人学习

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

共39课时 | 3.1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

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