在软件开发过程中,数据之间的交互运用最广泛的格式是JSON
,那JSON
是什么呢?给我们带来哪些方便呢?
JSON(JavaScript Object Notation, JS 对象简谱) 是一种轻量级的数据交换格式。它基于 ECMAScript (欧洲计算机协会制定的js规范)的一个子集,采用完全独立于编程语言的文本格式来存储和表示数据。简洁和清晰的层次结构使得 JSON 成为理想的数据交换语言。易于人阅读和编写,同时也易于机器解析和生成,并有效地提升网络传输效率。
对,JSON
就是这么棒,那在Spring Boot 项目中我们应该如何使用它呢?
答案:只需要在控制器类上加@RestController
注解即可。
常用的数据结构有类对象、List对象、Map对象,对于此类数据,比如在做前后端分离的项目中,我们需要将封装好的数据返回给前端,那Spring Boot 默认对Json的处理是如何实现的呢?
下面一步步来实现:
我们首先需要创建一个用户对象,包含了用户ID(id)、用户名(username)、用户密码(password),此处省略N行代码。
然后我们创建一个 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;
}
}
分别返回一个 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
数据后,就可以任由发挥了。
在开发过程中,如果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
然后我们修改一下上面返回 map 的接口,将几个值改成 null 测试一下:
@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("微信公众号", "猿码天地");
map.put("粉丝数量", null);
return map;
}
重启项目,再次输入:localhost:8080/json/map
,可以看到 jackson 已经将所有 null 字段转成了空字符串了。
{"作者信息":{"id":1,"username":"猿码天地","password":""},"粉丝数量":"","博客地址":"https://blog.csdn.net/zbw125","微信公众号":"猿码天地"}
调用方便性而言:
FastJSON提供了大量静态方法,调用简洁方便
Jackson须实例化类,调用相对繁琐,可通过封装成JSON工具类简化调用
性能而言:
FastJSON反序列化的性能略差,对于256k的json字符串,平均700ms
Jackson 的 data binding反序列化的性能稍好,对于256k的json字符串,平均600ms
两者的序列化性能基本相同,对于256k的json字符串,平均140ms
相对data binding方式(ObjectMapper.writeValueAsString()),Jackson的流输出方式(JsonGenerator.writeObject())性能稍好,平均130ms
总结如下:
选项 | fastJson | jackson |
---|---|---|
上手难易程度 | 容易 | 中等 |
高级特性支持 | 中等 | 丰富 |
官方文档、Example支持 | 中文 | 英文 |
处理json速度 | 略快 | 快 |
使用 fastJson 需要导入依赖,本课程使用 1.2.35 版本,依赖如下:
com.alibaba
fastjson
1.2.35
使用 fastJson 时,对 null 的处理和 jackson 有些不同,需要继承 WebMvcConfigurationSupport
类,然后覆盖 configureMessageConverters
方法,在方法中,我们可以选择对要实现 null 转换的场景,配置好即可。如下:
package com.bowen.config;
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;
/**
* springboot-study
* 使用阿里 FastJson 作为JSON MessageConverter
* @author : zhang.bw
* @date : 2020-07-17 21:37
**/
@Configuration
public class fastJsonConfig extends WebMvcConfigurationSupport {
/**
* 使用阿里 FastJson 作为JSON MessageConverter
* @param converters
*/
@Override
public void configureMessageConverters(List> converters) {
FastJsonHttpMessageConverter converter = new FastJsonHttpMessageConverter();
FastJsonConfig config = new FastJsonConfig();
config.setSerializerFeatures(
// 保留map空的字段
SerializerFeature.WriteMapNullValue,
// 将String类型的null转成""
SerializerFeature.WriteNullStringAsEmpty,
// 将Number类型的null转成0
SerializerFeature.WriteNullNumberAsZero,
// 将List类型的null转成[]
SerializerFeature.WriteNullListAsEmpty,
// 将Boolean类型的null转成false
SerializerFeature.WriteNullBooleanAsFalse,
// 避免循环引用
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);
}
}
以上是 Spring Boot 返回 json 的几个代表的例子,但是在实际项目中,除了要封装数据之外,我们往往需要在返回的 json 中添加一些其他信息,比如返回一些状态码 code ,返回一些 msg 给调用者,这样调用者可以根据 code 或者 msg 做一些逻辑判断。所以在实际项目中,我们需要封装一个统一的 json 返回结构存储返回信息。
由于封装的 json 数据的类型不确定,所以在定义统一的 json 结构时,我们需要用到泛型。统一的 json 结构中属性包括数据、状态码、提示信息即可,构造方法可以根据实际业务需求做相应的添加即可,一般来说,应该有默认的返回结构,也应该有用户指定的返回结构。如下:
package com.bowen.entity;
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;
}
public T getData() {
return data;
}
public void setData(T data) {
this.data = data;
}
public String getCode() {
return code;
}
public void setCode(String code) {
this.code = code;
}
public String getMsg() {
return msg;
}
public void setMsg(String msg) {
this.msg = msg;
}
}
由于 JsonResult 使用了泛型,所以所有的返回值类型都可以使用该统一结构,在具体的场景将泛型替换成具体的数据类型即可,非常方便,也便于维护。在实际项目中,还可以继续封装,比如状态码和提示信息可以定义一个枚举类型,以后我们只需要维护这个枚举类型中的数据即可。根据以上的 JsonResult,我们改写一下 Controller,如下:
package com.bowen.controller;
import com.bowen.entity.JsonResult;
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
* jsonresult Controller
* @author : zhang.bw
* @date : 2020-07-17 21:37
**/
@RestController
@RequestMapping("/jsonresult")
public class JsonResultController {
@RequestMapping("/user")
public JsonResult getUser() {
User user = new User(1, "猿码天地", "公众号【猿码天地】");
return new JsonResult<>(user);
}
@RequestMapping("/list")
public JsonResult 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 new JsonResult<>(userList, "获取用户列表成功");
}
@RequestMapping("/map")
public JsonResult
我们重新在浏览器中输入:localhost:8080/jsonresult/user
返回 json 如下:
{
"code":"0",
"data":{
"id":1,
"password":"公众号【猿码天地】",
"username":"猿码天地"
},
"msg":"操作成功!"
}
输入:localhost:8080/jsonresult/list
,返回 json 如下:
{
"code":"0",
"data":[
{
"id":1,
"password":"公众号1【猿码天地】",
"username":"猿码天地001"
},
{
"id":2,
"password":"公众号2【猿码天地】",
"username":"猿码天地002"
}
],
"msg":"获取用户列表成功"
}
输入:localhost:8080/jsonresult/map
,返回 json 如下:
{
"code":"0",
"data":{
"作者信息":{
"id":1,
"password":"",
"username":"猿码天地"
},
"CSDN地址":"https://blog.csdn.net/zbw125",
"粉丝数量":100000,
"博客地址":"https://blog.csdn.net/zbw125"
},
"msg":"操作成功!"
}
通过封装,我们不但将数据通过 json 传给前端或者其他接口,还带上了状态码和提示信息,这在实际项目场景中应用非常广泛。
本节课主要系统的讲解了Spring Boot 返回JSON数据格式封装,主要包括 Spring Boot 默认对Json的处理、使用阿里巴巴FastJson的设置、封装统一返回的数据结构等,并通过详细的例子进行演示,非常详细,相信通过这节课程的学习对springboot 集成 json 格式的理解更加深刻。
源码下载地址:关注公众号【猿码天地】并回复 springboot 获取
第006课:Spring Boot集成MyBatis
第007课:Spring Boot MyBatis Druid 多数据源配置
第004课:Spring Boot 项目属性配置
第005课:Spring Boot 中MVC支持
第003课:Spring Boot 快速体验 Web 开发
第001课:Spring Boot 课程概览
第002课:Spring Boot 开发环境搭建
你多学一样本事,就少说一句求人的话,现在的努力,是为了以后的不求别人,实力是最强的底气。记住,活着不是靠泪水博得同情,而是靠汗水赢得掌声。
——《写给程序员朋友》