Gson基本使用

简介: Gson基本使用

世间的很多事物,追求时候的兴致总是要比享用的时候的兴致浓烈。——莎士比亚《威尼斯商人》

首先是GAV

<!-- https://mvnrepository.com/artifact/com.google.code.gson/gson -->
<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.8.6</version>
</dependency>

然后是API文档

最后是使用,这里直接分享一篇不错的博客啦,原文

Gson是谷歌官方推出的支持 JSON -- Java Object 相互转换的 Java序列化/反序列化 库,之前由于没有用过,所以学习一下。

1. 导入Android Studio工程

dependencies {
    implementation 'com.google.code.gson:gson:2.8.4'
}
123

2. 简单的 Java Object 序列化/反序列化

序列化

假如有一个User类,拥有 name, email, age, isDeveloper 四个属性,如下:

User userObject = new User(  
    "Norman", 
    "norman@futurestud.io", 
    26, 
    true
);
123456

使用Gson将它序列化:

Gson gson = new Gson();
String userJson = gson.toJson(userObject);
12

得到的结果如下:

{
  "isDeveloper":true,
  "name":"Norman",
  "age":26,
  "email":"norman@futurestud.io"
}
123456

反序列化

先定义一段JSON字符串

String userJson = "{'isDeveloper':false,'name':'xiaoqiang','age':26,'email':'578570174@qq.com'}";
1

Gson反序列化

User user = gson.fromJson(userJson, User.class);
1

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"
    }
}
12345678910111213

那么这种Java Object该如何序列化/反序列化呢?和上面一样。也就是说和 2 里面介绍的方法一样

4. Array 和 List 的序列化/反序列化

序列化

序列化和前面介绍的方法是一样的

反序列化

那就有些不同了,不然也不用分开写。

1 Array的反序列化

先假设有一个name数组,定义JSON格式如下:

String namesJson = "['xiaoqiang','chenrenxiang','hahaha']";
1

然后使用Gson去反序列化它:

Gson gson = new Gson();
String[] nameArray = gson.fromJson(namesJson, String[].class);
12

得到的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); 
123456

对于List,反序列化时必须提供它的Type,通过Gson提供的TypeToken.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);
123

debug一下,得到结果如下:

可见,当某个变量值为null时,Gson在序列化的时候直接把这个变量忽略了。

再来看下反序列化, 先定义一段JSON字符串,只给它一个变量值name,用User类来反序列化它,看得到的结果会是什么。

String userJson = "{'name':'xiaoqiang'}";
   Gson gson = new Gson();
   User user = gson.fromJson(userJson, User.class);
123


对于JSON字符串里没有的变量,Gson在反序列化时会给它一个默认值,int类型默认为0,bool类型默认为false,String类型默认为null。

有人不禁要问了,如果JSON字符串里某个变量的值为null,反序列化后的结果会是什么呢?我测试过了,和没有的结果是一样的。

7. 控制序列化/反序列化 的变量名称

仍然以User对象为例,目前User对象里有四个变量nameageemailisDeveloper。假如,某一天,JSON字符串的变量名name变成了fullName,无需紧张,我们不用把User类里的变量name改为fullName,然后把它的getset方法都改了,然后把用到get/set方法的地方全改过来。只需要用Gson提供的注解方法@SerializedName就行了,如下:

public class User {
    private boolean isDeveloper;
    @SerializedName("fullName")
    private String name;
    private int age;
    private String email;
    ...
}
12345678

这样虽然JSON字符串里的变量名为fullName,但是反序列化后fullName的值会映射给name。同样,把一个User对象序列化,变量name会自动转换为fullName

然而现实远比想象中复杂,这个JSON有时候传的是fullName,有时候传的是name,这时该怎么办呢? 不用担心,@SerializedName 接受两个参数,valuealternate ,顾名思义,alternate 是备选变量名,比如下面这段代码:


public class User {
    private boolean isDeveloper;
    @SerializedName(value = "name", alternate = "fullName")
    private String name;
    private int age;
    private String email;
    ...
}
12345678

如果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; // 只参与序列化
}
12345678910111213

使用这个方法,可以非常灵活地控制对象的某个/某些变量参不参与序列化/反序列化

然而! 要使用这个注解来控制序列化/反序列化,就不能使用默认的Gson对象,新建Gson对象的方法如下:

GsonBuilder builder = new GsonBuilder();  
builder.excludeFieldsWithoutExposeAnnotation();  
Gson gson = builder.create(); 
123

另一个选择transient关键字 ,使用这个关键字,可以直接让变量不参与序列化/反序列化,如下:

public class User {  
    String name;
    String email;
    int age;
    boolean transient isDeveloper; //不参与序列化/反序列化
}
123456

当然,使用默认的Gson对象就可以。

以上是这两天学到的Gson的基本用法,如果想进一步了解,可以参考Future Studio的 Gson教程

相关文章
|
Linux 关系型数据库 Oracle
|
7月前
|
存储 人工智能 测试技术
Nacos托管LangChain应用Prompts和配置,助力你的AI助手快速进化
AI 应用开发中,总有一些让人头疼的问题:敏感信息(比如 API-KEY)怎么安全存储?模型参数需要频繁调整怎么办?Prompt 模板改来改去,每次都得重启服务,太麻烦了!别急,今天我们就来聊聊如何用 Nacos 解决这些问题。
|
PHP 数据库 数据安全/隐私保护
PHP枫叶小说CMS源码 仿起点中文网源码
PHP枫叶小说CMS源码 仿起点中文网源码
1053 3
|
消息中间件 中间件 Java
RocketMQ实战教程之几种MQ优缺点以及选型
该文介绍了几种主流消息中间件,包括ActiveMQ、RabbitMQ、RocketMQ和Kafka。ActiveMQ和RabbitMQ是较老牌的选择,前者在中小企业中常见,后者因强大的并发能力和活跃社区而流行。RocketMQ是阿里巴巴的开源产品,适用于大规模分布式系统,尤其在数据可靠性方面进行了优化。Kafka最初设计用于大数据日志处理,强调高吞吐量。在选择MQ时,考虑因素包括性能、功能、开发语言、社区支持、学习难度、稳定性和集群功能。小型公司推荐使用RabbitMQ,而大型公司则可在RocketMQ和Kafka之间根据具体需求抉择。
|
算法 数据挖掘 大数据
探索数据挖掘中的特征选择算法
在数据挖掘领域,特征选择是一项至关重要的任务。本文将深入探讨几种常用的特征选择算法,并比较它们在不同数据集上的表现,旨在帮助数据分析师和研究人员更好地应用这些算法来提升模型性能。
|
开发工具 git
git fatal: 拒绝合并无关的历史
记录一个git的错误, 以备以后查看
935 0
|
存储 JSON Java
含有泛型的 JSON 反序列化问题
含有泛型的 JSON 反序列化问题
2210 0
含有泛型的 JSON 反序列化问题
|
资源调度 JavaScript 开发工具
从npm慢如蜗牛到飞驰如光:nrm加速你的Node.js开发
从npm慢如蜗牛到飞驰如光:nrm加速你的Node.js开发
589 0
|
缓存 安全 NoSQL
SpringSecurity实现前后端分离登录token认证详解
SpringSecurity实现前后端分离登录token认证详解
1024 1
|
Android开发
关于Android自定义View实现验证码输入框
在做校验验证的时候,经常需要手机接收短信,获取验证码,输入验证码,实现起来其实也不难,今天对输入框简单做了一个封装,通过自定义View来实现。
415 1
关于Android自定义View实现验证码输入框