展开菜单
首页 精品内容 本月促销 装机必备 Windows PDF教程 macOS软件 IOS软件 Android AI 专题
全部分类

当前位置:

首页 > 编程开发 > SpringBoot怎么返回Json数据格式

SpringBoot怎么返回Json数据格式

一、@RestController注解在SpringBoot中的Controller中使用@RestController注解即可返回JSON格式的数据。@RestController注解包含了@Controller和@ResponseBody注解。@ResponseBody注解是将返回的数据结构转换为JSON格式。@Target({ElementType.TYPE})@Retention(RetentionPolicy.RUNTIME)@Documented@Controller@ResponseBody

本文目录

      一、@RestController 注解

      在 Spring Boot 中的 Controller 中使用 @RestController 注解即可返回 JSON 格式的数据。

      • @RestController 注解包含了 @Controller 和 @ResponseBody 注解。

      • @ResponseBody 注解是将返回的数据结构转换为 JSON 格式。

      @Target({ElementType.TYPE})
      @Retention(RetentionPolicy.RUNTIME)
      @Documented
      @Controller
      @ResponseBody
      public @interface RestController {
          String value() default "";
      }

      二、Jackson

      在 Spring Boot 中默认使用的 JSON 解析技术框架是 Jackson。

      点开 pom.xml 中的 spring-boot-starter-web 依赖,可以看到 spring-boot-starter-json 依赖:

      
          org.springframework.boot
          spring-boot-starter-json
          2.0.3.RELEASE
          compile
      

      再次点进去上面提到的 spring-boot-starter-json 依赖,可以看到如下代码:

      
          com.fasterxml.jackson.core
          jackson-databind
          2.9.6
          compile
      
      
          com.fasterxml.jackson.datatype
          jackson-datatype-jdk8
          2.9.6
          compile
      
      
          com.fasterxml.jackson.datatype
          jackson-datatype-jsr310
          2.9.6
          compile
      
      
          com.fasterxml.jackson.module
          jackson-module-parameter-names
          2.9.6
          compile
      

      到此为止,可以知道 Spring Boot 中默认使用的 JSON 解析框架是 Jackson。

      1、对象、List、Map 转换为Json格式

      创建实体类:

      public class User {
          private Long id;
          private String username;
          private String password;
          /* 省略get、set和带参构造方法 */
      }

      Controller 层

      import com.itcodai.course02.entity.User;
      import org.springframework.web.bind.annotation.RequestMapping;
      import org.springframework.web.bind.annotation.RestController;
      import java.util.ArrayList;
      import java.util.HashMap;
      import java.util.List;
      import java.util.Map;
      
      @RestController
      @RequestMapping("/json")
      public class JsonController {
      
          @RequestMapping("/user")
          public User getUser() {
              return new User(1, "倪升武", "123456");
              //返回 {"id":1,"username":"倪升武","password":"123456"}
          }
      
          @RequestMapping("/list")
          public List getUserList() {
              List userList = new ArrayList<>();
              User user1 = new User(1, "倪升武", "123456");
              User user2 = new User(2, "达人课", "123456");
              userList.add(user1);
              userList.add(user2);
              return userList;
              //返回 [{"id":1,"username":"倪升武","password":"123456"},{"id":2,"username":"达人课","password":"123456"}]
      
          }
      
          @RequestMapping("/map")
          public Map getMap() {
              Map map = new HashMap<>(3);
              User user = new User(1, "倪升武", "123456");
              map.put("作者信息", user);
              map.put("博客地址", "http://blog.itcodai.com");
              map.put("CSDN地址", "http://blog.csdn.net/eson_15");
              map.put("粉丝数量", 4153);
              return map;
              //返回 {"作者信息":{"id":1,"username":"倪升武","password":"123456"},"CSDN地址":"http://blog.csdn.net/eson_15","粉丝数量":4153,"博客地址":"http://blog.itcodai.com"}
      
          }
      }

      2、Jackson 的配置类

      在转 JSON 格式的时候将所有的 null 转换为 “” 的配置

      import com.fasterxml.jackson.core.JsonGenerator;
      import com.fasterxml.jackson.databind.JsonSerializer;
      import com.fasterxml.jackson.databind.ObjectMapper;
      import com.fasterxml.jackson.databind.SerializerProvider;
      import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
      import org.springframework.context.annotation.Bean;
      import org.springframework.context.annotation.Configuration;
      import org.springframework.context.annotation.Primary;
      import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;
      
      import java.io.IOException;
      
      @Configuration
      public class JacksonConfig {
          @Bean
          @Primary
          @ConditionalOnMissingBean(ObjectMapper.class)
          public ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) {
              ObjectMapper objectMapper = builder.createXmlMapper(false).build();
              objectMapper.getSerializerProvider().setNullValueSerializer(new JsonSerializer() {
                  @Override
                  public void serialize(Object o, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
                      jsonGenerator.writeString("");
                  }
              });
              return objectMapper;
          }
      }
      
      // 修改一下上面返回 Map 的接口,将几个值改成 null 测试一下:
      
      @RequestMapping("/map")
      public Map getMap() {
          Map map = new HashMap<>(3);
          User user = new User(1, "倪升武", null);
          map.put("作者信息", user);
          map.put("博客地址", "http://blog.itcodai.com");
          map.put("CSDN地址", null);
          map.put("粉丝数量", 4153);
          return map;
      	// 返回 {"作者信息":{"id":1,"username":"倪升武","password":""},"CSDN地址":"","粉丝数量":4153,"博客地址":"http://blog.itcodai.com"}
      	// 可以看到 Jackson 已经将所有 null 字段转成空字符串了。
      }

      三、Fastjson

      Fastjson 是阿里巴巴开源的。

      Jackson 和 fastjson 有哪些区别?

      从扩展上来看,fastjson 没有 Jackson 灵活,从速度或者上手难度来看,fastjson 可以考虑,它也比较方便。

      SpringBoot怎么返回Json数据格式

      fastjson 的依赖

      
          com.alibaba
          fastjson
          1.2.35
      

      Fastjson 配置类

      使用 fastjson 时,对 null 的处理和 Jackson 有些不同,需要继承 WebMvcConfigurationSupport 类,然后覆盖 configureMessageConverters 方法。

      在方法中,我们可以选择要实现 null 转换的场景,代码如下:

      import com.alibaba.fastjson.serializer.SerializerFeature;
      import com.alibaba.fastjson.support.config.FastJsonConfig;
      import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter;
      import org.springframework.context.annotation.Configuration;
      import org.springframework.http.MediaType;
      import org.springframework.http.converter.HttpMessageConverter;
      import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
      
      import java.nio.charset.Charset;
      import java.util.ArrayList;
      import java.util.List;
      
      @Configuration
      public class fastJsonConfig extends WebMvcConfigurationSupport {
      
          @Override
          public void configureMessageConverters(List> converters) {
              FastJsonHttpMessageConverter converter = new FastJsonHttpMessageConverter();
              FastJsonConfig config = new FastJsonConfig();
              config.setDateFormat("yyyy-MM-dd");
              config.setSerializerFeatures(
                      // 保留 Map 空的字段
                      SerializerFeature.WriteMapNullValue,
                      // 将 String 类型的 null 转成""
                      SerializerFeature.WriteNullStringAsEmpty,
                      // 将 Number 类型的 null 转成 0
                      SerializerFeature.WriteNullNumberAsZero,
                      // 将 List 类型的 null 转成 []
                      SerializerFeature.WriteNullListAsEmpty,
                      // 将 Boolean 类型的 null 转成 false
                      SerializerFeature.WriteNullBooleanAsFalse,
                      // 生成的JSON格式化
                      SerializerFeature.PrettyFormat,
                      // 避免循环引用
                      SerializerFeature.DisableCircularReferenceDetect);
      
              converter.setFastJsonConfig(config);
              converter.setDefaultCharset(Charset.forName("UTF-8"));
              List mediaTypeList = new ArrayList<>();
              // 解决中文乱码问题,相当于在 Controller 上的 @RequestMapping 中加了个属性 produces = "application/json"
              mediaTypeList.add(MediaType.APPLICATION_JSON);
              converter.setSupportedMediaTypes(mediaTypeList);
              converters.add(converter);
          }
      }

      四、封装返回的数据格式

      除了要封装数据之外,我们往往需要在返回的 JSON 中添加一些其他信息,比如返回状态码 Code,返回 Msg 给调用者,调用者可以根据 Code 或者 Msg 进行一些逻辑判断。

      统一的 JSON 结构中属性包括数据、状态码、提示信息即可。

      public class JsonResult {
      
          private T data;
          private String code;
          private String msg;
      
          /**
           * 若没有数据返回,默认状态码为 0,提示信息为“操作成功!”
           */
          public JsonResult() {
              this.code = "0";
              this.msg = "操作成功!";
          }
      
          /**
           * 若没有数据返回,可以人为指定状态码和提示信息
           * @param code
           * @param msg
           */
          public JsonResult(String code, String msg) {
              this.code = code;
              this.msg = msg;
          }
      
          /**
           * 有数据返回时,状态码为 0,默认提示信息为“操作成功!”
           * @param data
           */
          public JsonResult(T data) {
              this.data = data;
              this.code = "0";
              this.msg = "操作成功!";
          }
      
          /**
           * 有数据返回,状态码为 0,人为指定提示信息
           * @param data
           * @param msg
           */
          public JsonResult(T data, String msg) {
              this.data = data;
              this.code = "0";
              this.msg = msg;
          }
          // 省略 get 和 set 方法
      }

      修改 Controller 中的返回值类型,测试

      @RestController
      @RequestMapping("/jsonresult")
      public class JsonResultController {
      
          @RequestMapping("/user")
          public JsonResult getUser() {
              User user = new User(1, "倪升武", "123456");
              return new JsonResult<>(user);
              // {"code":"0","data":{"id":1,"password":"123456","username":"倪升武"},"msg":"操作成功!"}
      
          }
      
          @RequestMapping("/list")
          public JsonResult getUserList() {
              List userList = new ArrayList<>();
              User user1 = new User(1, "倪升武", "123456");
              User user2 = new User(2, "达人课", "123456");
              userList.add(user1);
              userList.add(user2);
              return new JsonResult<>(userList, "获取用户列表成功");
              // {"code":"0","data":[{"id":1,"password":"123456","username":"倪升武"},{"id":2,"password":"123456","username":"达人课"}],"msg":"获取用户列表成功"}
      
          }
      
          @RequestMapping("/map")
          public JsonResult getMap() {
              Map map = new HashMap<>(3);
              User user = new User(1, "倪升武", null);
              map.put("作者信息", user);
              map.put("博客地址", "http://blog.itcodai.com");
              map.put("CSDN地址", null);
              map.put("粉丝数量", 4153);
              return new JsonResult<>(map);
              // {"code":"0","data":{"作者信息":{"id":1,"password":"","username":"倪升武"},"CSDN地址":null,"粉丝数量":4153,"博客地址":"http://blog.itcodai.com"},"msg":"操作成功!"}
      
          }
      }
      本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
      作者最新文章
      编程开发 JSON
      相关文章 更多
      精品专题 更多
      装机必备

      正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

      Windows

      正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

      PDF教程

      正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

      macOS软件

      正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

      IOS软件

      正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

      AI

      正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

      Mac软件 更多
      IntelliJ IDEA macOS版
      IntelliJ IDEA macOS版

      IntelliJ IDEA 是 JetBrains 推出的专业集成开发环境,重点服务于 Java、Kotlin 与 JVM 项目开发。软件集成代码补全、静态检查、重构、调试、测试、版本控制及构建工具,并可借助插件扩展语言和框架支持。

      PyCharm macOS版
      PyCharm macOS版

      JetBrains PyCharm 是面向 Python 开发者的集成开发环境,提供智能补全、代码检查、重构、调试、测试、版本控制及虚拟环境管理功能。Mac 版兼容 Intel 与 Apple 芯片,核心功能可免费使用。

      WebStorm macOS版
      WebStorm macOS版

      JetBrains WebStorm 是面向 JavaScript、TypeScript 和现代 Web 技术的专业集成开发环境,可智能理解项目结构,提供代码补全、重构、错误检查、运行调试、测试及 Git 工具。

      After Effects macOS版
      After Effects macOS版

      Adobe After Effects 是面向动态图形、影视特效与视频合成的专业创作软件。它提供关键帧动画、遮罩抠像、运动跟踪、三维空间、文字动画和表达式等工具,并可与 Premiere Pro、Photoshop、Illustrator

      Audition macOS版
      Audition macOS版

      Adobe Audition 是面向播客、影视后期、音乐制作及内容创作者的专业音频工作站,提供波形精修、多轨录制与混音、频谱编辑、降噪修复、响度匹配和效果处理工具,并可与 Adobe Premiere 协同完成视频声音制作。

      Bridge macOS版
      Bridge macOS版

      Adobe Bridge 是面向摄影师、设计师及内容团队的免费数字资产管理工具,可集中预览照片、视频和 Adobe 项目文件,并利用评级、标签、关键词、元数据、筛选与收藏集完成分类检索。它还支持批量重命名、格式导出、相机导入及 Camera

      Illustrator macOS版
      Illustrator macOS版

      Adobe Illustrator 是 Adobe 推出的专业矢量图形设计软件,适合在 Mac 上制作标志、图标、插画、包装、信息图及印刷版面。它以路径和锚点构建可无损缩放的图形,并提供钢笔、形状、文字、图像描摹、渐变、画板及生成式功能。

      InDesign macOS版
      InDesign macOS版

      Adobe InDesign 是面向印刷品与数字出版物的专业版面设计软件,可在 Mac 上制作书籍、杂志、宣传册、海报、报告及交互式文档。它提供精细的文字样式、网格、母版、长文档管理和印前输出能力。

      Lightroom Classic macOS版
      Lightroom Classic macOS版

      Adobe Lightroom Classic 是面向桌面摄影工作流的照片管理与后期处理软件,可将原始照片保存在本地硬盘,通过目录、关键词、评分和收藏夹高效整理图库,并提供 RAW 冲印、蒙版、镜头校正、批量同步及多格式导出等功能。

      Media Encoder macOS版
      Media Encoder macOS版

      Adobe Media Encoder 是 Adobe 推出的专业音视频编码与转码工具,可通过队列、预设和监视文件夹批量完成格式转换、代理文件创建及多平台成片输出,并与 Premiere Pro、After Effects 等软件紧密协作。

      Photoshop macOS版
      Photoshop macOS版

      Adobe Photoshop 是面向摄影师、设计师和内容创作者的专业图像处理软件,提供图层、蒙版、选区、修复、调色、文字排版、智能对象及生成式编辑等能力。Mac 版支持 Intel 与 Apple Silicon 处理器。

      Premiere Pro macOS版
      Premiere Pro macOS版

      Adobe Premiere Pro 是面向专业视频制作的非线性剪辑软件,提供多轨时间线、调色、音频处理、字幕、代理工作流和多格式输出能力,并可与 After Effects、Audition、Photoshop 及 Frame.io 协同

      WINDOWS 更多
      IntelliJ IDEA Windows版
      IntelliJ IDEA Windows版

      JetBrains IntelliJ IDEA 是以 Java、Kotlin 和 JVM 项目为核心的专业集成开发环境,提供智能补全、代码检查、安全重构、调试、测试、版本控制及构建工具集成。统一发行版的核心功能可免费用于商业和非商业项目,

      PhpStorm Windows版
      PhpStorm Windows版

      PhpStorm 是 JetBrains 面向 PHP 与现代 Web 开发打造的专业集成开发环境,提供代码补全、静态检查、重构、调试、测试、数据库、版本控制及前端语言支持。Windows 用户可直接下载安装程序,

      PyCharm Windows版
      PyCharm Windows版

      PyCharm 是 JetBrains 推出的 Python 集成开发环境,提供智能代码补全、错误检查、重构、调试、测试、Git、终端及 Jupyter Notebook 支持。统一版安装后可体验 30 天 Pro 功能,

      WebStorm Windows版
      WebStorm Windows版

      WebStorm 是 JetBrains 面向 JavaScript、TypeScript 和现代 Web 技术打造的集成开发环境。它提供项目级代码分析、智能补全、安全重构、导航搜索,并集成调试、测试、终端、Git 与常用前端工具,

      Photoshop Windows版
      Photoshop Windows版

      Adobe Photoshop 是面向摄影师、设计师和内容创作者的专业图像处理工具,可在 Windows 上完成照片修饰、选区抠图、图层合成、文字排版、绘画及生成式编辑。软件采用订阅授权,由 Creative Cloud 管理安装、更新与许

      InDesign Windows版
      InDesign Windows版

      Adobe InDesign 是面向印刷与数字出版的专业页面排版工具,可制作书籍、杂志、宣传册、海报、交互式 PDF 和电子书。它提供精细的文字样式、多页面管理、印前检查及多格式输出能力,并能与 Photoshop、Illustrator

      Illustrator Windows版
      Illustrator Windows版

      Adobe Illustrator 是用于绘制矢量图形、插画、图标、徽标和版式的专业设计工具。它以路径和锚点为核心,作品放大后仍能保持清晰,并提供画板、文字、渐变、图像描摹及精确变换等功能,适合品牌视觉、印刷物料、数字界面和商业插画创作。

      Bridge Windows版
      Bridge Windows版

      Adobe Bridge 是 Adobe 推出的创意资产管理工具,可集中预览、分类和查找照片、视频、PDF及多种设计文件,并支持元数据、关键词、评级、批量重命名和格式导出。它可与 Photoshop、Illustrator 等应用衔接,

      Lightroom Classic Windows版
      Lightroom Classic Windows版

      Adobe Lightroom Classic 是面向 Windows 桌面摄影工作流的照片管理与无损编辑工具,可通过目录集中整理大型图库,并完成 RAW 显影、局部蒙版、批量调整、打印和多格式导出。它强调本地文件管理与精细控制,

      Acrobat Pro Windows版
      Acrobat Pro Windows版

      Adobe Acrobat Pro 是面向专业 PDF 工作的综合解决方案,可在 Windows 中创建、编辑、转换、比较、整理和保护文档,并支持表单、电子签名、扫描件文字识别及敏感信息永久遮盖。订阅还包含网页、移动服务和云端协作能力,

      After Effects Windows版
      After Effects Windows版

      Adobe After Effects 是面向动态图形、动画与影视视觉特效制作的专业工具,可完成关键帧动画、图层合成、遮罩跟踪、抠像、文字动画和二维三维元素整合。Windows 版通过 Adobe Creative Cloud 安装及更新,

      Media Encoder Windows版
      Media Encoder Windows版

      Adobe Media Encoder 是 Adobe 面向视频与音频制作流程提供的专业编码和转码工具,可批量处理媒体文件、创建代理、套用输出预设并监控文件夹自动执行任务。它与 Premiere、After Effects、Audition

      网站备案号:苏ICP备2026018738号-1 联系邮箱:bd@zhengruan.com

      Copyright ©2018-2026