展开菜单
首页 精品内容 本月促销 装机必备 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软件 更多
      讯飞智作 网页版
      讯飞智作 网页版

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

      火山引擎 网页版
      火山引擎 网页版

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

      Aperty macOS版
      Aperty macOS版

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

      立刻MV 网页版
      立刻MV 网页版

      立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

      蛙蛙写作 网页版
      蛙蛙写作 网页版

      蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

      超级简历WonderCV 网页版
      超级简历WonderCV 网页版

      超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

      音述AI 网页版
      音述AI 网页版

      音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

      AionClaw macOS版
      AionClaw macOS版

      AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

      Loomy macOS版
      Loomy macOS版

      Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。

      AirBuddy 3 macOS版
      AirBuddy 3 macOS版

      AirBuddy 3 是面向 macOS 的蓝牙外设增强工具,可集中查看 AirPods、Beats 与苹果设备电量,提供快速连接、播放控制、电量提醒、桌面小组件和多台 Mac 外设接力等功能。

      AirServer macOS版
      AirServer macOS版

      AirServer macOS版可把 Mac 转换为无线投屏接收端,通过 AirPlay 或 Google Cast 接收手机、平板和电脑画面,并支持多设备同时连接、高清镜像及会话录制,适合家庭娱乐、课堂教学、会议演示和应用展示。

      AnyDesk macOS版
      AnyDesk macOS版

      AnyDesk macOS版是一款适用于远程办公、设备维护和客户支持的远程桌面工具,可连接并操作异地计算机,支持文件传输、无人值守访问、会话权限控制及跨平台协作。

      WINDOWS 更多
      讯飞智作 网页版
      讯飞智作 网页版

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

      火山引擎 网页版
      火山引擎 网页版

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

      PixTV 网页版
      PixTV 网页版

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

      讯飞绘文 网页版
      讯飞绘文 网页版

      讯飞绘文网页版是科大讯飞推出的AI图文创作与内容运营工具,覆盖热点选题、文章生成、稿件校对、智能配图、排版发布和数据复盘等环节,适合自媒体创作者及内容团队在线使用。

      Maya(Autodesk Maya) Windows版
      Maya(Autodesk Maya) Windows版

      Autodesk Maya 是面向影视、电视、动画和游戏行业的专业三维制作软件,集多边形与 NURBS 建模、角色绑定、关键帧和动作捕捉动画、Bifrost 特效模拟、材质开发及 Arnold 渲染于一体,

      Aperty Windows版
      Aperty Windows版

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

      立刻MV 网页版
      立刻MV 网页版

      立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

      蛙蛙写作 网页版
      蛙蛙写作 网页版

      蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

      超级简历WonderCV 网页版
      超级简历WonderCV 网页版

      超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

      音述AI 网页版
      音述AI 网页版

      音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

      AionClaw Windows版
      AionClaw Windows版

      AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

      Loomy Windows版
      Loomy Windows版

      Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。

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

      Copyright ©2018-2026