前言
最近因为FastJson
最近几年的安全漏洞频发,所以后续的项目准备切换到Gson
中,而前面的项目也开始准备逐步切换到Gson
。
而本文就是因此而产生,本文将会围绕一系列实际的需求来展示如何使用Gson
解决实际开发上遇到的问题。
Gson之旅
如同前言所说的,以下的章节都是本人遇到的实际场景后如何使用Gson
的记录。
初识Gson
Gson
是一个Google
开源出来针在Java
对象和JSON
数据之间进行相互映射的Java
类库。而且使用方式很简单。以maven
项目为例,只需要添加以下配置即可使用。
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.8.6</version>
</dependency>
Java对象转JSON
而且Gson
的API
使用起来也很简单,例如Java对象转成JSON字符串,只需要调用Gson
的toJson
方法即可,示例如下
Gson gson = new Gson();
Student student = new Student();
student.setId(1L);
student.setName("测试用户");
student.setSex(false);
System.out.println(gson.toJson(student));
输出结果
{"id":1,"name":"测试用户","sex":false}
JSON转Java对象
而将JSON字符串转成Java对象也很简单,只需要调用Gson
的fromJson
方法即可,示例如下
Gson gson = new Gson();
String jsonStr ="{'id':1,'name':'测试用户','sex':false}";
Student student = gson.fromJson(jsonStr,Student.class);
输出结果
Student(id=1, name=测试用户, sex=false, birthday=null)
这里需要注意以下两点
-
fromJson
方法需要传入的是==JSON格式的字符串==和对应==Java对象的类型==才行。 -
Gson
是可以识别使用==单引号==的JSON
字符串,而实际上==JSON格式规范里面是需要使用双引号==。
演示的Student类源码
@Data
是lombok
框架的注解,可以自动生成对应的getter/setter
和toString
方法。
@Data
public class Student implements Serializable {
/**
* 学生ID
*/
private Long id;
/**
* 学生名称
*/
private String name;
/**
* 学生性别
*/
private Boolean sex;
/**
* 出生年月日
*/
private Date birthday;
}
日期格式化
于是就开始了Gson
的使用,很快我就遇到第一个问题了。使用Gson
处理第三方接口传过来的JSON
字符串时,可以正确将yyyy-MM-dd HH:mm:ss
格式(例如2020-01-30 11:30:00
)的值转为对应的Date
对象。
可是Java对象转为JSON时却发现Date
对象的值转为Thu Jan 30 11:30:00 CST 2020
,也就是直接调用了Date
的toString
方法。而我期待的值则是2020-01-30 11:30:00
。通过查阅用户手册得知,可以使用GsonBuilder
来构建一个自定义日期格式化的Gson
实例,如下所示
Gson gson = new GsonBuilder().setDateFormat("yyyy-MM-dd HH:mm:ss").create();
Student student = new Student();
student.setName("测试用户");
student.setId(1L);
student.setSex(false);
student.setBirthday(new Date());
String jsonStr = gson.toJson(student);
System.out.println(gson.toJson(student));
输出结果
{"id":1,"name":"测试用户","sex":false,"birthday":"2020-06-07 18:45:10"}
而针对JSON转Java对象,常规的日期格式字符(如yyyy-MM-dd
和yyyy-MM-dd HH:mm:ss
),GSON都可以正常识别。
显示null值
Gson
在将Java对象转为JSON时,会隐藏为值为null
的属性,但是其实显示所有值为null
的属性更加便于我们进行调试,而且只要简单地设置一下即可。
Gson gson = new GsonBuilder().serializeNulls().create();
Student student = new Student();
student.setId(1L);
System.out.println(gson.toJson(student));
输出结果
{"id":1,"name":null,"sex":null,"birthday":null}
打印优化
Gson
在将Java对象转成JSON时,默认会进行压缩处理,例如这样
{"id":1,"name":"测试用户","sex":false}
而这个时候只需要简单地设置一下即可让Gson
输出一个展开的JSON
Gson gson = new GsonBuilder().setPrettyPrinting().create();
Student student = new Student();
student.setId(1L);
student.setName("测试用户");
student.setSex(false);
System.out.println(gson.toJson(student));
输出结果
{
"id": 1,
"name": "测试用户",
"sex": false
}
属性别名
有些时候和第三方系统进行对接时,对方的提供的JSON部分属性是某些单词的缩写或者很难理解(遇过有拼音缩写,英语缩写,单词拼写错误),这个时候如果希望自己这边的Java对象的属性更好理解,可以选择使用Gson
的别名功能,示例如下:
@Data
public class Teacher implements Serializable {
/**
* 教师姓名
*/
@SerializedName("name")
private String teacherName;
/**
* 教师性别
*/
@SerializedName("sex")
private Boolean teacherSex;
}
@SerializedName
注解可以的value
属性可以设置单个别名,而alternate
则是用于设置多个别名。
处理泛型
有时候我们会遇到接收一个JSON数组的情况,而且此时如果将其转为一个List
对象时,就会遇到类型转换的问题,以上面Student
类为例,下面将演示如何将JSON数组转成List<Student>
Gson gson = new Gson();
String jsonStr = "[{'name':'测试用户'},{'id':2}]";
// 获取实际要转的类型
Type type =new TypeToken<List<Student>>(){}.getType();
List<Student> list = gson.fromJson(jsonStr,type);
System.out.println(list);
输出结果
[Student(id=null, name=测试用户, sex=null, birthday=null), Student(id=2, name=null, sex=null, birthday=null)]
需要注意这里的Type
是java.lang.reflect.Type
总结
-
Gson
使用toJson
来讲Java对象转为JSON,而fromJson
则是将JSON转为Java对象 - 如果默认设置不能满足你的需求,可以选择使用
GsonBuilder
来构建一个自定义的Gson
对象来进行JSON和Java对象的互相转换。
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。