SpringBoot(二) — 返回JSON数据

什么是jsON

​ JSON（javascript Object Notation）是一种轻量级的数据交换格式。它是一种在各个编程语言中流通的数据格式，负责不同编程语言中的数据传递和交互。

相当于全球通用语—英语，中国56个民族不同地区的通用语言-普通话

json的基本语法格式如下:

• json是一种纯字符数据，不属于编程语言
• json的语法与js中object的语法几乎一致
• json数据中的键值对可以使用编程语言中所谓的关键字
• json的数据可以用花括号{}或中括号[]包裹，对应js中的object和array,示例{"name":"admin","age":18}或者["springBoot",3.1415,"json"]
• json数据以键值对形式存在，多个键值对之间用逗号,隔开，但数据结束后，不允许出现没有意义的逗号，键值对的键和值之间用冒号:连接，键值对的键部分，必须用双引号"包裹，单引号都不行；键值对的值部分，不允许出现函数function，undefined，NaN，但是可以有null

​ 在我们的项目开发中，接口与接口之间，前后端之间的数据传输都是使用的JSON格式

@RestController

​ 上文我们有提到 @RestController = @controller + @ResponseBody，而@ResponseBody注解的作用就是将返回的数据转换为JSON格式。因此在SpringBoot中 使用@RestController 注解即可将返回的数据结构转换成 JSON 格式。我们还是点进(Ctrl+左键)@RestController看看：

@Target({ElementType.TYPE, ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)@Documented@Mappingpublic @interface RequestMapping {    String name() default "";    //指定请求的实际地址    @AliasFor("path")    String[] value() default {};    @AliasFor("value")    String[] path() default {};    //指定请求的method类型， GET、POST、PUT、DELETE等    RequestMethod[] method() default {};    //指定request中必须包含某些参数值是，才让该方法处理。    String[] params() default {};    //指定request中必须包含某些指定的header值，才能让该方法处理请求。    String[] headers() default {};    //指定处理请求的提交内容类型（Content-Type），例如application/json, text/html;    String[] consumes() default {};    //指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回；    String[] produces() default {};}

如此，我们学到了更多@RestController的参数。

我们点开 pom.xml 中的 spring-boot-starter-WEB 依赖，可以找到spring-boot-starter-json依赖：

      org.springframework.boot      spring-boot-starter-json      2.7.9      compile

继续点开 spring-boot-starter-json 依赖：

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

我们发现出现了许多jackson，至此我们知道了Spring Boot 中默认使用的 JSON 解析框架是 Jackson。

不同数据类型返回的JSON

在我们平时的项目开发中，常用的数据结构有 类对象、List对象、Map对象。

创建People实体类

新建entity包与Controller同级，entity我们用来存放实体类。

导入lombok依赖：

     org.projectlombok     lombok     1.18.20

然后在File --> Settings --> Plugins，搜索 lombok 下载相关插件。

在entity中编写我们的实体类：

import lombok.AllArgsConstructor;import lombok.Data;@Data   // 为属性添加get,set方法@AllArgsConstructor // 提供一个全参构造器，此时不在默认含有无参构造器public class People {    private String Name;    private Integer age;    private String gender;    }

点击左下角structure,可以看到，使用了@Data 和@AllArgsConstructor，lombok依赖已经自动帮我们建立好了get,set等方法。

创建JsonController类

分别返回People对象，List，Map。

import com.pan.entity.People;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;@RestControllerpublic class JsonController {    @RequestMapping("/People")    public People getPeople() {        return new People("tom", 18, "男");    }    @RequestMapping("/list")    public List getPeopleList() {        List PeopleList = new ArrayList<>();        People People1 = new People("jack", 20, "男");        People People2 = new People("lucy", 23, "女");        PeopleList.add(People1);        PeopleList.add(People2);        return PeopleList;    }    @RequestMapping("/map")    public Map getMap() {        Map map = new HashMap<>(3);        People People = new People("jan", 25, "女");        map.put("人物信息", People);        map.put("家庭住址", "北京二环路");        map.put("代表作品", "《北京的天》");        map.put("书籍订阅", 4153);        return map;    }}

返回结果展示

在浏览器中输入：localhost:8080/people，返回 JSON 如下：

{"age":18,"gender":"男","name":"tom"}

在浏览器中输入：localhost:8080/list，返回 JSON 如下：

[{"age":20,"gender":"男","name":"jack"},{"age":23,"gender":"女","name":"lucy"}]

在浏览器中输入：localhost:8080/map，返回 JSON 如下：

{"人物信息":{"age":25,"gender":"女","name":"jan"},"代表作品":"《北京的天》","家庭住址":"北京二环路","书籍订阅":4153}

我们可以看到默认的 Jackson 框架将这三个常用的数据结构成功转成 JSON 格式。

补充一点

如何将String类型转换成json格式呢

我们知道@Controller如果遇到字符串会去寻找view的路径映射，而@RestController如果遇到字符串就会直接返回字符串。上面我们知道@RestController可以把数据结构转换成JSON类型。如果我们想把String返回成JSON，就需要小小的变形一下

引入依赖：

     com.alibaba     fastjson     1.2.9

重新编写我们的HelloController:

import com.alibaba.fastjson.JSON;import com.alibaba.fastjson.JSONObject;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;@RestControllerpublic class HelloController {    @RequestMapping("/hello")    public JSONObject Hello(){        String str = "{'result': 'success','msg': '登陆成功'}";        JSONObject jsonObject =  JSON.parseObject(str);        return jsonObject.getClass().getName();    }}

返回结果：

{"result":"success","msg":"登陆成功"}

Jackson 中对 null 的处理

在处理数据的过程中，我们难免会遇到一些 null 值。当我们转 JSON 时，不希望这些 null 出现，比如我们期望所有的 null 在转 JSON 时都变成““””这种空字符串

与controller包同级目录下我们创建一个config包用来存放我们的配置文件，并创建一个类JacksonConfig

JacksonConfig内容：

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;@Configurationpublic class JacksonConfig {    @Bean    @Primary    @ConditionalOnMissingBean(ObjectMapper.class)    public ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) {        ObjectMapper objectMapper = builder.createXmlMapper(false).build();        objectMapper.getSerializerProvider().setNullValueSerializer(new JsonSerializer