第008课：Spring Boot 返回JSON数据格式封装

在软件开发过程中，数据之间的交互运用最广泛的格式是JSON,那JSON是什么呢？给我们带来哪些方便呢？

JSON(JavaScript Object Notation, JS 对象简谱) 是一种轻量级的数据交换格式。它基于 ECMAScript (欧洲计算机协会制定的js规范)的一个子集，采用完全独立于编程语言的文本格式来存储和表示数据。简洁和清晰的层次结构使得 JSON 成为理想的数据交换语言。易于人阅读和编写，同时也易于机器解析和生成，并有效地提升网络传输效率。

对，JSON就是这么棒，那在Spring Boot 项目中我们应该如何使用它呢？

答案：只需要在控制器类上加@RestController注解即可。

1. Spring Boot 默认对Json的处理

常用的数据结构有类对象、List对象、Map对象，对于此类数据，比如在做前后端分离的项目中，我们需要将封装好的数据返回给前端，那Spring Boot 默认对Json的处理是如何实现的呢？

下面一步步来实现：

1.1 创建 User 实体类

我们首先需要创建一个用户对象，包含了用户ID（id）、用户名（username）、用户密码（password），此处省略N行代码。

1.2 创建Controller类

然后我们创建一个 Controller，在控制器类上我们需要加上注解@RestController,用于返回JSON格式。

package com.bowen.controller;

import com.bowen.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;

/**
 * 
springboot-study
 * 
json Controller
 * @author : zhang.bw
 * @date : 2020-07-17 21:37
 **/
@RestController
@RequestMapping("/json")
public class JsonController {

    @RequestMapping("/user")
    public User getUser() {
        return new User(1, "猿码天地", "公众号【猿码天地】");
    }

    @RequestMapping("/list")
    public List getUserList() {
        List userList = new ArrayList<>();

        User user1 = new User(1, "猿码天地001", "公众号1【猿码天地】");
        User user2 = new User(2, "猿码天地002", "公众号2【猿码天地】");
        userList.add(user1);
        userList.add(user2);
        return userList;
    }

    @RequestMapping("/map")
    public Map getMap() {
        Map map = new HashMap<>();

        User user = new User(1, "猿码天地", null);
        map.put("作者信息", user);
        map.put("博客地址", "https://blog.csdn.net/zbw125");
        map.put("CSDN地址", "https://blog.csdn.net/zbw125");
        map.put("粉丝数量", 100000);
        return map;
    }
}

1.3 测试json格式返回

分别返回一个 User 对象、一个 List 集合和一个 Map 集合，具体测试结果如下所示：

在浏览器中输入：localhost:8080/json/user 返回 json 如下：

{"id":1,"password":"公众号【猿码天地】","username":"猿码天地"}

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

[{"id":1,"password":"公众号1【猿码天地】","username":"猿码天地001"},{"id":2,"password":"公众号2【猿码天地】","username":"猿码天地002"}]

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

{"作者信息":{"id":1,"password":"","username":"猿码天地"},"粉丝数量":100000,"博客地址":"https://blog.csdn.net/zbw125","微信公众号":"猿码天地"}

从测试结果来看，无论我们返回什么样的数据格式，在浏览器发送请求后，都会返回我们想要的JSON格式，前端攻城狮们拿到这些JSON数据后，就可以任由发挥了。

1.4 jackson 中对null的处理

在开发过程中，如果JSON格式中的数据有null怎么办，不要怕，我们新建一个配置类，可以将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