Android Gson基本用法学习
目录
- 1. 导入android studio工程
- 2. 简单的 java object 序列化/反序列化
- 序列化
- 反序列化
- 3. 嵌套 java object 的序列化/反序列化
- 4. array 和 list 的序列化/反序列化
- 序列化
- 反序列化
- 1 array的反序列化
- 2 list的反序列化
- 5. map 和 set 的序列化/反序列化
- 7. 控制序列化/反序列化 的变量名称
- 8. 序列化/反序列化过程中忽略某些变量
gson是谷歌官方推出的支持 json -- java object 相互转换的 java序列化/反序列化 库，之前由于没有用过，所以学习一下。
1. 导入android studio工程
dependencies {
implementation 'com.google.code.gson:gson:2.8.4'
}
2. 简单的 java object 序列化/反序列化
序列化
假如有一个user类，拥有 name, email, age, isdeveloper 四个属性，如下：
user userobject = new user(
"norman",
"norman@futurestud.io",
26,
true
);
使用gson将它序列化：
gson gson = new gson(); string userjson = gson.tojson(userobject);
得到的结果如下：
{
"isdeveloper":true,
"name":"norman",
"age":26,
"email":"norman@futurestud.io"
}
反序列化
先定义一段json字符串
string userjson = "{'isdeveloper':false,'name':'xiaoqiang','age':26,'email':'578570174@qq.com'}";
gson反序列化
user user = gson.fromjson(userjson, user.class);
debug一下，查看结果
反序列化成功！
3. 嵌套 java object 的序列化/反序列化
也就是说，一个类里面还包含有其它类。比如user类里面还有个用户地址useraddress类，json结构如下：
{
"age": 26,
"email": "578570174@qq.com",
"isdeveloper": true,
"name": "chenrenxiang",
"useraddress": {
"city": "magdeburg",
"country": "germany",
"housenumber": "42a",
"street": "main street"
}
}
那么这种java object该如何序列化/反序列化呢？和上面一样。也就是说和 2 里面介绍的方法一样
4. array 和 list 的序列化/反序列化
序列化
序列化和前面介绍的方法是一样的
反序列化
那就有些不同了，不然也不用分开写。
1 array的反序列化
先假设有一个name数组，定义json格式如下：
string namesjson = "['xiaoqiang','chenrenxiang','hahaha']";
然后使用gson去反序列化它：
gson gson = new gson(); string[] namearray = gson.fromjson(namesjson, string[].class);
得到的namearray如下：
其实这和 2 里面介绍的反序列化方法仍然是一样的。可以看到，gson的反序列化都是调用 gson.fromjson(...)方法，传入json字符串，以及这段json字符串对应的object类型。
2 list的反序列化
string userjson = "[{'isdeveloper':false,'name':'xiaoqiang','age':26,'email':'578570174@qq.com'},{'isdeveloper':true,'name':'xiaoqiang123','age':27,'email':'578570174@gmail.com'}]";
gson gson = new gson();
type userlisttype = new typetoken<arraylist<user>>(){}.gettype();
list<user> userlist = gson.fromjson(userjson, userlisttype);
对于list，反序列化时必须提供它的type，通过gson提供的typetoken<t>.gettype()方法可以定义当前list的type。反序列化后结果如下：
那么，如果一个java object里包含list类型的变量，该如何反序列化这个object呢？答案是，和 2 一样就行了，无需为其内部的list提供type。
5. map 和 set 的序列化/反序列化
map我平时用的较多，set用的就很少了，它们的序列化/反序列化方法和list都是一样的，反序列化的时候需要提供type
6. 变量值为null时的序列化/反序列化
仍然以user类为例，如果一个user对象，里面的某个值为null，那么其序列化出来后的结果会是什么样的呢？
先看序列化，我们先初始化一个user对象，并把其中的email变量赋值为null，再用gson来序列化它，如下：
user user = new user(true, "chenrenxiang", 27, null);
gson gson = new gson();
string userjson = gson.tojson(user);
debug一下，得到结果如下：
可见，当某个变量值为null时，gson在序列化的时候直接把这个变量忽略了。
再来看下反序列化， 先定义一段json字符串，只给它一个变量值name，用user类来反序列化它，看得到的结果会是什么。
string userjson = "{'name':'xiaoqiang'}";
gson gson = new gson();
user user = gson.fromjson(userjson, user.class);
对于json字符串里没有的变量，gson在反序列化时会给它一个默认值，int类型默认为0，bool类型默认为false，string类型默认为null。
有人不禁要问了，如果json字符串里某个变量的值为null，反序列化后的结果会是什么呢？我测试过了，和没有的结果是一样的。
7. 控制序列化/反序列化 的变量名称
仍然以user对象为例，目前user对象里有四个变量name， age， email， isdeveloper。假如，某一天，json字符串的变量名name变成了fullname，无需紧张，我们不用把user类里的变量name改为fullname，然后把它的get和set方法都改了，然后把用到get/set方法的地方全改过来。只需要用gson提供的注解方法@serializedname就行了，如下：
public class user {
private boolean isdeveloper;
@serializedname("fullname")
private string name;
private int age;
private string email;
...
}
这样虽然json字符串里的变量名为fullname，但是反序列化后fullname的值会映射给name。同样，把一个user对象序列化，变量name会自动转换为fullname。
然而现实远比想象中复杂，这个json有时候传的是fullname，有时候传的是name，这时该怎么办呢？ 不用担心，@serializedname 接受两个参数，value 和 alternate ，顾名思义，alternate 是备选变量名，比如下面这段代码：
public class user {
private boolean isdeveloper;
@serializedname(value = "name", alternate = "fullname")
private string name;
private int age;
private string email;
...
}
如果json传的是name，那么就用name的值，如果传的是fullname，那么就用fullname的值。需要注意的是，alternate只是反序列化json的一个备选变量名，它不会影响序列化，user对象序列化后，会使用value定义的名称为变量名。
又想到有一个问题，在定义了value和alternate的情况下，假如json同时传来了name和fullname，user的name变量会接受哪个值呢？ 经过测试，它会都接受。这样也是很合理的，因为gson会对json中的变量一个一个地去解析，既然它可以接受name，也可以接受fullname，那么当同时传来这两个变量时，它就会分别把它们解析出来，并把值赋给user对象中的name变量。那么，name变量的值就会是后解析的那个json变量的值，因为它会把前一个值覆盖掉。
8. 序列化/反序列化过程中忽略某些变量
也许会出现这样的需求，在将某个对象序列化时，对象中的某些变量是不需要的。有可能在反序列化某个json字符串时，某些变量的值也是不需要的。这时就可以使用gson提供的@expose注解方法。使用方法如下：
public class user {
@expose()
string name; // 参与序列化/反序列化
@expose(serialize = false, deserialize = false)
string email; // 不参与序列化，也不参与反序列化
@expose(serialize = false)
int age; // 只参与反序列化
@expose(deserialize = false)
boolean isdeveloper; // 只参与序列化
}
使用这个方法，可以非常灵活地控制对象的某个/某些变量参不参与序列化/反序列化。
然而！ 要使用这个注解来控制序列化/反序列化，就不能使用默认的gson对象，新建gson对象的方法如下：
gsonbuilder builder = new gsonbuilder(); builder.excludefieldswithoutexposeannotation(); gson gson = builder.create();
注意：使用以上方式构建的gson，在序列化/反序列化对象时，会排除所有没有添加
@expose注解的字段。
另一个选择，transient关键字 ，使用这个关键字，可以直接让变量不参与序列化/反序列化，如下：
public class user {
string name;
string email;
int age;
boolean transient isdeveloper; //不参与序列化/反序列化
}
当然，使用默认的gson对象就可以。
版权声明：34楼发布
