Spring Boot学习笔记（一）Json数据封装与统一数据返回格式

最新推荐文章于 2023-06-09 09:01:56 发布
最新推荐文章于 2023-06-09 09:01:56 发布
阅读量3.7k 收藏 17
点赞数 22
分类专栏： SpringBoot 文章标签： 1024程序员节 spring boot java restful json
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Rex__404/article/details/108338968
版权

前言

在我们日常开发过程中，接口与接口之间，前后端之间数据的传输都使用 JSON 格式。本文介绍Sping Boot中

一、JSON简介

文章开始之前，我们先简单回顾一下JSON的概念
参考自官方JSON中文说明以及JSON维基百科

（1）名称：

JSON（JavaScript Object Notation，JavaScript对象表示法，读作/ˈdʒeɪsən/）

（2）与XML对比：

JSON是一种轻量级的资料交换语言，而XML是一个完整的标记语言，这使得XML在程序判读上需要比较多的功夫。XML利用标记语言的特性提供了绝佳的延展性（如XPath），在数据存储，扩展及高级检索方面相较JSON更具优势，而JSON则由于比XML更加小巧，以及浏览器的内建快速解析支持，使得其更适用于网络数据传输领域。

（3）语法：

  1. 数据在名称/值对中：json数据是由键值对构成的， 键用引号(单双都行)引起来，也可以不使用引号
  2. 数据由逗号分隔：多个键值对由逗号分隔
  3. 花括号保存对象：使用{}定义json 格式
  4. 方括号保存数组：[ ]
  5. 值的取值类型：
    1. 数字（整数或浮点数）
    2. 字符串（在双引号中）
    3. 逻辑值（true 或 false）
    4. 数组（在方括号中） {“persons”:[{},{}]}
    5. 对象（在花括号中） {“address”:{“province”：“广东”…}}
    6. null

（4）JSON解析器：

常见的解析器：Gson（Google的JSON处理框架），fastjson（阿里巴巴的JSON处理框架），jackson(Spring Boot默认JSON处理框架)

二、Spring Boot默认对JSON的处理

（1）创建Spring Boot工程并在pom.xml加入依赖如下

 <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
 </dependencies>

这里我们只需关注spring-boot-starter-web 依赖
在IDEA中，对着spring-boot-starter-web依赖按住CTRL+鼠标左键
在这里插入图片描述
可以看到spring-boot-starter-web封装了一个spring-boot-starter-json依赖
在这里插入图片描述
我们再点进去，可以看到jackson的各项依赖已经被封装好
在这里插入图片描述

（2）创建实体类命名为Person.java

public class Person {
    private String name;
    private Integer age;
    private Integer phoneNumber;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public Integer getPhoneNumber() {
        return phoneNumber;
    }

    public void setPhoneNumber(Integer phoneNumber) {
        this.phoneNumber = phoneNumber;
    }
    public Person(String name,Integer age,Integer phoneNumber){
        this.name = name;
        this.age = age;
        this.phoneNumber = phoneNumber;
    }
}

（3）创建Controller类命名为PersonController.java

import com.rex.springbootjson.entity.Person;
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

public class PersonController {
    @RequestMapping("/person")
    public Person getPerson(){
        return new Person("张三",18,123);
    }
    @RequestMapping("/list")
    public List<Person> getPersonList() {
        List<Person> personList = new ArrayList<>();
        Person user1 = new Person("李四",18,123);
        Person user2 = new Person("王五",15,321);
        personList.add(user1);
        personList.add(user2);
        return personList;
    }
    @RequestMapping("/map")
    public Map<String, Object> getPersonMap() {
        Map<String, Object> map = new HashMap<>(3);
        Person person = new Person("王五",24,321);
        map.put("成员信息", person);
        map.put("住址", null);
        map.put("学历", "本科");
        return map;
    }
}

这里我们重点关注@RestController注解
CTRL+鼠标左键点开@RestController注解，可见其封装了@Controller注解。而@RestController与@Controller的主要区别是：
1. @RestController是将json/xml返回到前端页面
2. @Controller是将HTML页面返回到前端页面
而另一个注解@ResponseBody的作用简而言之就是将对象转化为JSON格式
具体详解可以参考@ResponseBody详解
在这里插入图片描述

（4）启动Spring Boot项目

  1. 访问http://localhost:8080/person
    在这里插入图片描述
  2. 访问http://localhost:8080/list，返回List类型的JSON
    在这里插入图片描述

3.访问http://localhost:8080/map ，返回map类型的JSON
在这里插入图片描述

三、 jackson 中对null的处理

由上图,地址一栏出现了null值，实际项目开发中难免会遇到一些 null 值出现，我们转 json 时，是不希望有这些 null 出现的，比如我们期望所有的 null 在转 json 时都变成 “” 这种空字符串，此时我们需要新建一个JSON配置类

  1. 创建JsonConfig.java文件，加入如下代码
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 JsonConfig {
    @Bean
    @Primary
    @ConditionalOnMissingBean(ObjectMapper.class)
    public ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) {
        ObjectMapper objectMapper = builder.createXmlMapper(false).build();
        objectMapper.getSerializerProvider().setNullValueSerializer(new JsonSerializer<Object>() {
            @Override
            public void serialize(Object o, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
                jsonGenerator.writeString("");
            }
        });
        return objectMapper;
    }
}
  1. 重启Spring Boot项目，重新访问http://localhost:8080/map
    在这里插入图片描述
    可以看到null值已经被处理

四、统一数据返回格式

1.为什么要做统一数据返回格式

在以前后端分离为主流的开发环境下，前后端开发人员需要通过API交互，但为了前端人员能够快速做逻辑展示与页面交互处理，每一次RESTful请求都应该包含以下几个信息：

名称描述
状态码标识请求成功与否，如[1：成功； -1：失败]
错误码定义明确错误码，更好的应对业务异常；请求成功该值可为空
错误消息与错误码相对应，更具体的描述异常信息
resultBody通常是Bean对象对应的JSON数据，通常为了应对不同返回值类型，将其声明为泛型类型

这里总结下我们常用的状态码以及表示的含义：

code区间类型含义
1**100-199信息 服务器接收到请求，需要请求者继续执行操作
2**200-299成功 请求被成功接收并处理
3**300-399重定向 需要进一步的操作以完成请求
4**400-499客户端错误 请求包含语法错误或无法完成请求
5**500-599服务器错误 服务器在处理的时候发生错误

2.统一的JSON结构的配置

在config文件夹下创建UnifiedReturnConfig文件

package com.rex.springbootjson.config;

import com.rex.springbootjson.entity.CommonResult;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

@EnableWebMvc
@Configuration
public class UnifiedReturnConfig {

    @RestControllerAdvice("com.rex.springbootjson.Controller")
    static class CommonResultResponseAdvice implements ResponseBodyAdvice<Object> {
        @Override
        public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
            return true;
        }

        @Override
        public Object beforeBodyWrite(Object body, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
            if (body instanceof CommonResult){
                return body;
            }

            return new CommonResult<Object>(body);
        }
    }
}

在entity文件下创建实体类CommmonResult,添加如下代码

package com.rex.springbootjson.entity;



public final class CommonResult<T> {

    private int status = 1;

    private String errorCode = "";

    private String errorMsg = "";

    private T resultBody;

    public CommonResult() {
    }

    public int getStatus() {
        return status;
    }

    public void setStatus(int status) {
        this.status = status;
    }

    public String getErrorCode() {
        return errorCode;
    }

    public void setErrorCode(String errorCode) {
        this.errorCode = errorCode;
    }

    public String getErrorMsg() {
        return errorMsg;
    }

    public void setErrorMsg(String errorMsg) {
        this.errorMsg = errorMsg;
    }

    public T getResultBody() {
        return resultBody;
    }

    public void setResultBody(T resultBody) {
        this.resultBody = resultBody;
    }

    public CommonResult(T resultBody) {
        this.resultBody = resultBody;
    }
}

3.在controller类下PersonController添加如下代码

 @RequestMapping("/CommonResult")
    public CommonResult<Object> getUserList() {
        List<Person> personList2 = new ArrayList<>();
        Person user1 = new Person("李四",18,123);
        Person user2 = new Person("王五",15,321);
        personList2.add(user1);
        personList2.add(user2);
        return new CommonResult<Object>(personList2);
    }

好的，我们的统一返回格式已经大功告成，接下来测试。

3.测试接口

访问http://localhost:8080/CommonResult
返回结果如下

{"status":1,
"errorCode":"",
"errorMsg":"",
"resultBody":[{"name":"李四","age":18,"phoneNumber":123},{"name":"王五","age":15,"phoneNumber":321}]}

下面我们随便访问一个不存在的接口，如http://localhost:8080/aaa,(这里用浏览器可能直接Whitelabel Error Page)用接口测试工具可以返回如下结果

{"timestamp":1603540190184,
"status":404,"error":
"Not Found",
"message":"","path":"/aaa"}

总结

本文仅是对Spring Boot的json处理及统一返回做一个实例，是本人在学习过程中的总结与实践。

Rex~
关注
专栏目录
SpringBoot秒杀系统实战02-优雅代码编写之封装json输出
程序鹏
04-29 253
搭建起了SpringBoot环境之后，那么就可以开启项目了，我们需要考虑优雅代码编写。我们知道MVC模式Controller类里面一般有两大返回值： rest api的json输出 页面 一般来说，服务端和客户端要做一个接口的约定。一般封装的json数据代表意义： { "code":0 //50010...
SpringBoot返回统一封装格式的JSON数据
ergouy's blog
06-19 1985
最近做了一个springboot项目，了解了下controller层统一格式返回数据，做一些必要的笔记，一来是对自己学习的知识的巩固，二来对有同样问题的人有参考作用 文章目录一 概要二 @RestController注解三 常用数据类型转为 JSON 格式3.1 创建 User 实体类3.2 创建 Controller 类3.3 测试不同数据类型返回的 JSON3.4 Jackson 中对 null 的处理四 使用 fastjson 封装统一返回的数据结构4.1 使用 fastjson4.1.1 Ja.
spring 统一再处理接口返回的json数据
01-14
最近公司项目出现这样一个问题，公司的项目部署在政务云服务器，而政务云服务器所在网络是电信提供的，如果用户通过手机的非电信4G网络访问项目资源，比如MP4等，则会被电信拦截，导致访问极慢无法正常提供服务。为了解决这个问题需要用cdn服务来提供资源，以前的资源都是存在服务器上，因此需要做最小的调整切换cdn服务。 解决方案： 在spring框架下，可以利用ResponseBodyAdvice接口，实现该接口则能够在声明了ResponseBody注解的controller返回json数据前，统一对json数据做处理，将资源地址的url统一替换为cdn资源url。
通过映射关系 动态转义为统一格式的数据 （支持 JSON 和 XML ）
weixin_33963594的博客
02-22 341
　 　在很多的时候 我们都会 需要 将不同格式的数据 转换为 统一的数据格式 　 比如 将Json 源数据 { "b": [ { "c": "reference", "a": "atliwen", "t": "Sayings of the Century", ...
Spring Boot返回Json数据及数据封装
qq_53791649的博客
11-30 462
在项目开发中，接口与接口之间，前后端之间数据的传输都使用 Json 格式，在 Spring Boot 中，接口 返回 Json 格式的数据很简单，在 Controller 中使用 @RestController 注解即可返回 Json 格式的数据. @ResponseBody 注解是将返回 的数据结构转换为 Json 格式。所以在默认情况下，使用了 @RestController 注解即可将返回的数据 结构转换成 Json 格式. ...
Spring Boot 返回 JSON 数据及数据封装
m0_47073109的博客
08-26 931
Spring Boot 返回 JSON 数据及数据封装 在项目开发中,接口与接口之间,前后端之间的数据传输都使用JSON格式,总结Spring Boot 是怎么返回 JSON 数据的,核心内容如下: @RestController 注解 常用数据类型转为 JSON 格式 使用 fastjson 封装统一返回的数据结构 @RestController 注解 在Spring Boot中,接口返回JSON格式的数据很简单,在Controller中使用@RestController注释即可返回JSON格式的
SpringBoot 用 @ControllerAdvice 和 BasicErrorController 处理异常并返回结构一致的 JSON
O_o
05-25 3120
主要介绍 Filter 抛出异常和 Controller 抛出异常的全局处理. 以及用 FastJson 作为 HttpMessageConverter.
Spring Boot 学习笔记完整教程.pdf
06-07
- **返回 JSON 数据**：Spring Boot 支持 RESTful 服务的创建，可以方便地通过 Controller 返回 JSON 格式的数据。 - **使用其他 JSON 转换框架**：虽然 Spring Boot 默认使用 Jackson 进行 JSON 数据转换，但开发者...
Spring Boot学习笔记
IT小浣熊的博客
12-23 683
Spring Boot 引言 Spring Boot由Pivotal团队提供，目的是简化Spring应用的初始搭建以及开发过程，是一个微框架，一个约定大于配置的框架。 springboot(微框架) = springmvc(控制器) + spring(项目管理) Spring Boot 特点 创建独立的Spring应用程序 嵌入Tomcat，无需部署WAR文件 简化Maven配置 自动配置Spr...
Spring Boot 2 基础篇学习笔记
hjseo_seg的博客
06-12 1297
Spring Boot 2 运维实用篇学习笔记实用篇学习要求环境要求学习资料基础篇Java基础语法 Spring与SpringMVC 知道Spring是用来管理bean，能够基于Restful实现页面请求交互功能 Mybatis与Mybatis-Plus 基于Mybatis和MybatisPlus能够开发出包含基础CRUD功能的标准Dao模块 数据库MySQL 能够读懂基础CRUD功能的SQL语句 服务器 知道服务器与web工程的关系，熟悉web服务器的基础配置 maven 知道maven的依赖关系，知道什
Spring Boot 教学 学习 讲义笔记 【入门到精通一篇就够了】（上）
Likme1的博客
10-17 2068
Spring Boot 基于 Spring 开发，Spirng Boot 本身并不提供 Spring 框架的核心特性以及扩展功能，只是用于快速、敏捷地开发新一代基于 Spring 框架的应用程序。
springBoot + Mybatis 实现查询树形结构
热门推荐
Treasure的博客
06-30 1万+
查询树形节点 Web 案例 创建数据库表 DROP TABLE IF EXISTS `sys_dept`; CREATE TABLE `sys_dept` ( `dept_id` bigint(20) NOT NULL AUTO_INCREMENT, `parent_id` bigint(20) NULL DEFAULT NULL COMMENT '上级部门ID，一级部门为0...
基于SpringBoot+Mybatis Plus实现的树型结构
MarsVVV的博客
07-28 2635
数据库设计 POJO package com.example.demo.pojo; import com.baomidou.mybatisplus.annotation.TableField; import lombok.Data; import java.util.ArrayList; import java.util.List; /** * @author yjw * @date 2020/7/28 */ @Data public class Tree { private
springboot + mybatis plus + mysql 树形结构查询
蜀道难，难于上青天。
07-21 4458
springboot + mybatis plus + mysql 树形结构查询 背景 实际开发过程中经常需要查询节点树,根据指定节点获取子节点列表,以下记录了获取节点树的操作,以备不时之需。 使用场景 可以用于系统部门组织机构、商品分类、城市关系等带有层级关系的数据结构； 设计思路 递归模型 即根节点、枝干节点、叶子节点，数据模型如下： id code name parent_code 1 10000 电脑 0 2 20000 手机 0 3 10001 联想笔记本 10000
spring boot 接受一对多数据库数据 返回前端树状json格式
最新发布
weixin_42948205的博客
06-09 279
通过后端访问数据库中一对多数据表文件 将其解析成json树状结构返回给前端
第2课:SpringBoot学习笔记之返回json数据及数据封装
FeilxChioa的博客
06-28 243
一.注解@RestController @RestController是SpringBoot新增加的一个注解，点开以后会发现里面包含了原来的@Controller和@ResponseBody注解。 @ResponseBody注解是将返回的数据结构转换为 Json 格式。所以使用了 @RestController 注解即可将返回的数据结构转换成 Json 格式。 Spring Boot 中默认使用的 Json 解析技术框架是 jackson。 二.Spring Boot 的jackson默认对Json
Springboot项目操作数据库返回JSON接口
pgcdnameming的博客
09-29 2556
一、Springboot项目目录创建 首先我们新建一个springboot项目 不会的同学可以看我上一篇博客 此处跳过 首先看一下我的项目目录 我们进行必要的包创建 此处新建了四个包三个类 注意我们的UserDao类需要改成接口 按照我的目录结构进行创建就可以 二、sql表创建 我们选择一个数据库 新建user表 表结构如下 表名为user 三、编写代码操作sql 3.1 首先进行配置文件配置 引入必要pom依赖 <!--mybatis相关依赖 --> <
用springboot+mybatis-plus写接口返回json数据
qq_25015861的博客
12-02 5661
MyBatis-Plus 是一个 Mybatis 增强版工具，在 MyBatis 上扩充了其他功能没有改变其基本功能，为了简化开发提交效率而存在，mybatis-plus用起来真是方便。 我们来看看如何用springboot+mybatis-plus写接口返回json数据吧！ 数据库Student表 CREATE TABLE `student` ( `id` int(20) NOT NULL AUTO_INCREMENT COMMENT '学号', `name` varchar(255) NOT N
springboot怎样构造树形结构数据并查询？
一往无前的博客
11-16 5368
因为项目需要，页面上需要树形结构的数据进行展示（类似下图这样），因此需要后端返回相应格式的数据。 不说废话，直接开干！！！ 我这里用的是springboot+mybatis-puls+mysql，示例的接口是查询一级权限以及二级权限、三级权限整个权限树… 下面是导入的maven依赖 <!--数据库连接--> <dependency> <groupId>com.alibaba</groupId>
评论 17
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值