当前位置:

首页 > 编程开发 > 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
      相关文章 更多
      Java发送post请求发送json数据的实现方法与代码示例
      Java发送post请求发送json数据的实现方法与代码示例

      深入解析Java发送JSON格式POST请求的实现机制,对比原生API与第三方库的代码差异,提供可复制的代码示例,并探讨超时设置、编码处理及微服务场景下的例外情况。

      抖音官网入口网页
      抖音官网入口网页

      抖音官网入口的正确打开方式 如果你在寻找抖音网页版的入口,那么直接访问 https://www.douyin.com 就是了。这不仅是通往海量短视频世界的门户,更是一个功能越来越专业的媒体素材库和创作工具箱。为什么这么说?看看它最近在功能上的深度拓展就知道了。 简单一个网址背后,其实是一个日益精密的

      在小说搜搜找不到想看的小说怎么办?小说搜搜换源功能使用详解【必学】
      在小说搜搜找不到想看的小说怎么办?小说搜搜换源功能使用详解【必学】

      小说搜搜搜索不到结果?五种实用解决方法帮你搞定 在小说搜搜里搜不到想看的书?这事儿其实挺常见。问题多半出在书源上——要么是默认的书源还没来得及收录,要么是原先的源数据失效了,更新没跟上。别急,下面这五条解决路径,基本能覆盖绝大多数情况,操作起来也不复杂。 一、通过阅读页调出换源入口手动切换 这个方法

      蓝海搜书搜书攻略及入口指南免费分享
      蓝海搜书搜书攻略及入口指南免费分享

      蓝海搜书提供超三百万部小说资源,覆盖十余类题材;具备毫秒级搜索响应、四套主题引擎、跨端加密同步及全文索引等核心功能,入口为lanhaizw.com。 关于蓝海搜书的免费资源入口和核心功能,一直是许多读者关注的焦点。今天,我们就来深入拆解一下这个平台,看看它在资源、体验和功能上究竟有哪些门道。 官方入

      Java中JSONassert,JsonUnit和Jackson三方比对
      Java中JSONassert,JsonUnit和Jackson三方比对

      断言工具专为测试场景设计,支持宽松模式并精准定位差异;单元工具基于断言工具和杰克逊库封装,提供更友好的断言接口;杰克逊库作为主流处理库,可通过节点树模型自定义比对逻辑,适用于业务开发中精细控制差异的场景。

      百度编辑器从Json对象中取值,完成初次渲染,在编辑器内画表格
      百度编辑器从Json对象中取值,完成初次渲染,在编辑器内画表格

      通过AJAX异步请求服务器获取JSON格式的表格数据,解析JSON对象后遍历数据条目,动态拼接成包含表格标签的HTML字符串,最后调用编辑器实例的setContent()方法将HTML写入编辑器,完成表格在编辑器内的初次渲染。

      1024编程
      1024编程

      面向8-18岁青少年,采用计算机硕士以上师资,以Scratch、Python、C++、CSP-J/S和NOIP五个阶段系统化循序渐进推进,避免冗余理论,注重实战,紧密对标竞赛与升学需求,形成高效衔接、直通信息学奥赛的课程体系,着力培养计算思维,助力学生冲刺升学。

      能编程与会编程
      能编程与会编程

      能编程与会编程的区别在于前者仅是技术实现,后者包含情绪管理、坚持探索、主动负责、追求完善及知识体系构建等综合能力。编程之外的能力决定了解决问题的深度与广度。

      c++如何解析GeoJSON中的FeatureCollection地理要素集【实战】
      c++如何解析GeoJSON中的FeatureCollection地理要素集【实战】

      使用nlohmann/json库解析GeoJSONFeatureCollection,需逐层防御性访问features、geometry和properties,坐标数组维度不确定,需判断。坐标系和精度问题在解析层无法解决,应暴露原始坐标数组供上层处理。性能敏感时避免重复解析和深拷贝,可缓存并视口裁剪。

      Pandas如何解析JSON数据为表_利用json_normalize函数扁平化数据
      Pandas如何解析JSON数据为表_利用json_normalize函数扁平化数据

      pandas.json_normalize 这个函数,说起来挺有意思的——很多人以为它能一键把嵌套 JSON 拍扁成表格,结果往往发现列名变成了一串带点的“火车”(比如 profile.address.city),真正棘手的问题却一个都没解决。字段缺失怎么办?列表嵌套怎么炸开?多层结构怎么拆?答案其

      查看更多
      精品专题 更多
      装机必备
      装机必备

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

      Windows
      Windows

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

      PDF教程
      PDF教程

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

      Mac软件 更多
      讯飞智作 网页版
      讯飞智作 网页版
      Windows/ macOS/ Linux

      讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

      火山引擎 网页版
      火山引擎 网页版
      Windows/ macOS/ Linux

      火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

      Aperty macOS版
      Aperty macOS版
      macOS

      Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

      WINDOWS 更多
      讯飞智作 网页版
      讯飞智作 网页版
      Windows/ macOS/ Linux

      讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

      火山引擎 网页版
      火山引擎 网页版
      Windows/ macOS/ Linux

      火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

      PixTV 网页版
      PixTV 网页版
      Windows

      PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。

      为什么要购买正版软件?
      01 官方授权

      授权来源透明,订单与许可信息可随时查询。

      02 即时交付

      付款成功后自动发放激活信息,支持订单追踪。

      03 中文协助

      安装、激活、迁移与续费问题都有专人响应。

      04 长期可用

      提供升级提醒与授权管理,换机时也能轻松迁移。

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

      Copyright ©2018-2026