SpringBoot怎么返回Json数据格式

这篇文章主要介绍“SpringBoot怎么返回JSON数据格式”的相关知识，小编通过实际案例向大家展示操作过程，操作方法简单快捷，实用性强，希望这篇“springBoot怎么返回json数据格式”文章能帮助大家解决问题。

一、@RestController 注解

在 Spring Boot 中的 Controller 中使用 @RestController 注解即可返回 JSON 格式的数据。

• @RestController 注解包含了 @Controller 和 @ResponseBody 注解。

• @ResponseBody 注解是将返回的数据结构转换为 JSON 格式。

@Target({ElementType.TYPE})@Retention(RetentionPolicy.RUNTIME)@Documented@Controller@ResponseBodypublic @interface RestController {    String value() default "";}

二、Jackson

在 Spring Boot 中默认使用的 JSON 解析技术框架是 Jackson。

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

<dependency>    <groupId>org.springframework.boot</groupId>    <artifactId>spring-boot-starter-json</artifactId>    <version>2.0.3.RELEASE</version>    <scope>compile</scope></dependency>

再次点进去上面提到的 spring-boot-starter-json 依赖，可以看到如下代码：

<dependency>    <groupId>com.fasterxml.jackson.core</groupId>    <artifactId>jackson-databind</artifactId>    <version>2.9.6</version>    <scope>compile</scope></dependency><dependency>    <groupId>com.fasterxml.jackson.datatype</groupId>    <artifactId>jackson-datatype-jdk8</artifactId>    <version>2.9.6</version>    <scope>compile</scope></dependency><dependency>    <groupId>com.fasterxml.jackson.datatype</groupId>    <artifactId>jackson-datatype-jsr310</artifactId>    <version>2.9.6</version>    <scope>compile</scope></dependency><dependency>    <groupId>com.fasterxml.jackson.module</groupId>    <artifactId>jackson-module-parameter-names</artifactId>    <version>2.9.6</version>    <scope>compile</scope></dependency>

到此为止，可以知道 Spring Boot 中默认使用的 JSON 解析框架是 Jackson。

1、对象、List、Map 转换为Json格式

创建实体类：

public class User {    private Long id;    private String username;    private String passWord;    }

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<User> getUserList() {        List<User> 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<String, Object> getMap() {        Map<String, Object> 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;@Configurationpublic class JacksonConfig {    @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;    }}// 修改一下上面返回 Map 的接口，将几个值改成 null 测试一下：@RequestMapping("/map")public Map<String, Object> getMap() {    Map<String, Object> 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 可以考虑，它也比较方便。

fastjson 的依赖

<dependency>    <groupId>com.alibaba</groupId>    <artifactId>fastjson</artifactId>    <version>1.2.35</version></dependency>

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;@Configurationpublic class fastJsonConfig extends WebMvcConfigurationSupport {    @Override    public void configureMessageConverters(List<HttpMessageConverter<?>> 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<MediaType> 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<T> {    private T data;    private String code;    private String msg;        public JsonResult() {        this.code = "0";        this.msg = "操作成功！";    }        public JsonResult(String code, String msg) {        this.code = code;        this.msg = msg;    }        public JsonResult(T data) {        this.data = data;        this.code = "0";        this.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<User> getUser() {        User user = new User(1, "倪升武", "123456");        return new JsonResult<>(user);        // {"code":"0","data":{"id":1,"password":"123456","username":"倪升武"},"msg":"操作成功！"}    }    @RequestMapping("/list")    public JsonResult<List> getUserList() {        List<User> 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<Map> getMap() {        Map<String, Object> 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":"操作成功！"}    }}

关于“SpringBoot怎么返回Json数据格式”的内容就介绍到这里了，感谢大家的阅读。如果想了解更多行业相关的知识，可以关注编程网精选频道，小编每天都会为大家更新不同的知识点。