原文链接:Gson Advanced — Custom Instance Creator
原文出自:Norman Peitek
译者:無名無
之前几篇文章我们介绍了如何使用 Gson 来自定义(反)序列化,目的是减少 JSON 以及优化传递。本文将介绍如何自定义反序列化实例创建。
有一种情况是,客户端的 Model 中包含了一种特殊类型的变量,这就##需要我们在反序列中进行创建。
Gson 对象实例创建
默认情况下,Gson 创建的是无参的 Java model 实例,然后通过反射设置属性,如果你的 Model 只作为简单的数据存储,这种情况并不需要我们考虑自定义。
但是,如果你的 Model 中包含有默认或者动态设置的属性,你必须避开 Gson 使用反射。幸运的是,Gson 帮我们考虑到了,可以使用 InstanceCreators 来解决。
看个例子:
{
"age": 26,
"email": "norman@fs.io",
"isDeveloper": true,
"name": "Norman"
}
首先,需要一个对应的 Java model 用来映射 JSON,但此 model 中包含一个 Context,这个 Context 要用来存储 Java object 到数据库中,并不能被 JSON 匹配到,这就需要我们来创建。
public class UserContext {
private String name;
private String email;
private boolean isDeveloper;
private int age;
// additional attribute, which is not part of the data model
private Context context;
public UserContext(Context context) {
this.context = context;
}
}
如果你还是用原来的方式来反序列化,那么得到的 Context 肯定是null。你需要在映射之前的构造函数中来创建 Context,这是就需要用到 InstanceCreators。
和自定义序列化很相似,需要设置一个 Adapter:
String userSimpleJson = ...; // the JSON from the server, see above
GsonBuilder gsonBuilder = new GsonBuilder();
gsonBuilder.registerTypeAdapter(
UserContext.class,
new UserContextInstanceCreator(getApplicationContext())
);
Gson customGson = gsonBuilder.create();
UserContext customObject = customGson.fromJson(userSimpleJson, UserContext.class);
还是 registerTypeAdapter() 方法来添加,不同的是第二个参数需要传递 InstanceCreator 实现类。
private class UserContextInstanceCreator implements InstanceCreator<UserContext> {
private Context context;
public UserContextInstanceCreator(Context context) {
this.context = context;
}
@Override
public UserContext createInstance(Type type) {
// create new object with our additional property
UserContext userContext = new UserContext(context);
// return it to gson for further usage
return userContext;
}
}
可以看到 UserContextInstanceCreator 实现了 InstanceCreator ,重写 createInstance 方法,但是 UserContextInstanceCreator(Context context) 构造函数需要我们自己传递 Context参数,
所以要这样使用 new UserContextInstanceCreator(getApplicationContext()),这样才能保证每个 UserContext 中含有 Context 实例。
当然你还可以根据自己的需求自由的传递另一些参数。
目标
学习什么是自定义 InstanceCreators 创建实例。
练习代码已上传 Github https://github.com/whiskeyfei/Gson-Review 可自行查看。
Gson 系列文章翻译回顾
1、Gson - Java-JSON 序列化和反序列化入门
2、Gson - 映射嵌套对象
3、Gson - Arrays 和 Lists 映射对象
4、Gson - Map 结构映射
5、Gson - Set 集合映射
6、Gson - 空值映射
7、Gson Model Annotations - 如何使用 @SerializedName 更改字段的命名
8、Gson Model Annotations - @SerializedName 匹配多个反序列化名称
9、Gson Builder - 基础和命名规则
10、Gson Builder - 序列化空值
11、Gson Builder - 忽略策略
12、Gson Builder - Gson Lenient 属性
13、Gson Builder - 特殊类型 Floats & Doubles
17、Gson Builder - 如何使用 @Expose 忽略字段
19、Gson Advanced - 映射枚举类型
20、Gson Advanced - 映射循环引用
21、Gson Advanced - 泛型
22、Gson Advanced - 简单自定义序列化 (Part 1)
24、Gson Advanced - 自定义反序列化基础
25、Gson Advanced - 自定义对象实例创建
26、Gson Advanced - 通过 @JsonAdapter 自定义(反)序列化过程
32、Practical Gson - 如何解析多态对象
学习讨论
刚刚建了一个 Android 开源库分享学习群,有兴趣的小伙伴可以加入一起学习。
群二维码
网友评论