Android Gson使用详解

已于 2024-04-28 12:42:39 修改
阅读量986 收藏 29
点赞数 10
分类专栏： 程序员 文章标签： android java 开发语言
于 2024-04-28 12:42:38 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/2401_84123150/article/details/138274297
版权

/**

  • 作者：chenZY
  • 时间：2018/3/17 18:32
  • 描述：https://github.com/leavesC
    */
    public class User {

private String name;

private int age;

private boolean sex;

public User(String name, int age, boolean sex) {
this.name = name;
this.age = age;
this.sex = sex;
}

@Override
public String toString() {
return “User{” +
“name='” + name + ‘’’ +
“, age=” + age +
“, sex=” + sex +
‘}’;
}

}

序列化的方法很简单，调用 gson 对象的 toJson 方法，传入要序列化的对象

public static void main(String[] args) {
//序列化
User user = new User(“leavesC”, 24, true);
Gson gson = new Gson();
System.out.println();
System.out.println(gson.toJson(user));
}

反序化的方式也类似

public static void main(String[] args) {
//反序列化
String userJson = “{“name”:“leavesC”,“age”:24,“sex”:true}”;
Gson gson = new Gson();
User user = gson.fromJson(userJson, User.class);
System.out.println();
System.out.println(user);
}

二、属性重命名

继续使用上一节声明的 User 类，根据 User 类声明的各个属性名，移动端的开发者希望接口返回的数据格式即是如下这样的

{“name”:“leavesC”,“age”:24,“sex”:true}

如果没有和服务器端沟通好或者是 API 改版了，接口返回的数据格式可能是这样的

{“Name”:“leavesC”,“age”:24,“sex”:true}

{“userName”:“leavesC”,“age”:24,“sex”:true}

如果继续使用上一节介绍的方法，那无疑会解析出错 例如

public static void main(String[] args) {
//反序列化
String userJson = “{“userName”:“leavesC”,“age”:24,“sex”:true}”;
Gson gson = new Gson();
User user = gson.fromJson(userJson, User.class);
System.out.println();
System.out.println(user);
}

name 属性值解析不到，所以为 null

此时为了兼顾多种格式的数据，就需要使用 SerializedName 注解 根据 SerializedName 的声明来看，SerializedName 包含两个属性值，一个是字符串，一个是字符串数组，而字符串数组含有默认值

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.METHOD})
public @interface SerializedName {
String value();

String[] alternate() default {};
}

SerializedName 的作用是为了在序列化或反序列化时，指导 Gson 如果将原有的属性名和其它特殊情况下的属性名联系起来

例如，修改 User 类，为 name 声明 SerializedName 注解，注解值为 userName

/**

  • 作者：chenZY
  • 时间：2018/3/17 18:32
  • 描述：https://github.com/leavesC
    */
    public class User {

@SerializedName(“userName”)
private String name;

private int age;

private boolean sex;

}

在序列时，Json 格式就会相应改变

public static void main(String[] args) {
//序列化
User user = new User(“leavesC”, 24, true);
Gson gson = new Gson();
System.out.println();
System.out.println(gson.toJson(user));
}

在反序列化时也一样，能够解析到正确的属性值

public static void main(String[] args) {
//反序列化
String userJson = “{“userName”:“leavesC”,“age”:24,“sex”:true}”;
Gson gson = new Gson();
User user = gson.fromJson(userJson, User.class);
System.out.println();
System.out.println(user);
}

还有个问题没解决，为了应对多种属性名不一致的情况，难道我们要声明多个 User 类吗？这显然是不现实的，所以还需要为 User 类设置多个备选属性名，这就需要用到 SerializedName 注解的另一个属性值 alternate 了。

/**

  • 作者：chenZY
  • 时间：2018/3/17 18:32
  • 描述：https://github.com/leavesC
    */
    public class User {

@SerializedName(value = “userName”, alternate = {“user_name”, “Name”})
private String name;

private int age;

private boolean sex;

}

以下几种情况都能够被正确的反序列化

public static void main(String[] args) {
//反序列化
Gson gson = new Gson();
String userJson = “{“userName”:“leavesC”,“age”:24,“sex”:true}”;
User user = gson.fromJson(userJson, User.class);
System.out.println();
System.out.println(user);

userJson = “{“user_name”:“leavesC”,“age”:24,“sex”:true}”;
user = gson.fromJson(userJson, User.class);
System.out.println();
System.out.println(user);

userJson = “{“Name”:“leavesC”,“age”:24,“sex”:true}”;
user = gson.fromJson(userJson, User.class);
System.out.println();
System.out.println(user);
}

三、字段过滤

有时候并不是所有的字段都需要进行系列化和反序列化，因此需要对某些字段进行排除，有四种方法可以来实现这种需求。

3.1、基于@Expose注解

Expose 注解包含两个属性值，且均声明了默认值。Expose 的含义即为“暴露”，即用于对外暴露字段，serialize 用于指定是否进行序列化，deserialize 用于指定是否进行反序列化。如果字段不声明 Expose 注解，则意味着不进行序列化和反序列化操作，相当于两个属性值均为 false 。此外，Expose 注解需要和 GsonBuilder 构建的 Gson 对象一起使用才能生效。

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface Expose {
boolean serialize() default true;

boolean deserialize() default true;
}

Expose 注解的注解值声明情况有四种

@Expose(serialize = true, deserialize = true) //序列化和反序列化都生效
@Expose(serialize = false, deserialize = true) //序列化时不生效，反序列化时生效
@Expose(serialize = true, deserialize = false) //序列化时生效，反序列化时不生效
@Expose(serialize = false, deserialize = false) //序列化和反序列化都不生效，和不写注解一样

现在来看个例子，修改 User 类

/**

  • 作者：chenZY
  • 时间：2018/3/17 18:32
  • 描述：https://github.com/leavesC
    */
    public class User {

@Expose(serialize = true, deserialize = true) //序列化和反序列化都生效
private String a;

@Expose(serialize = false, deserialize = true) //序列化时不生效，反序列化时生效
private String b;

@Expose(serialize = true, deserialize = false) //序列化时生效，反序列化时不生效
private String c;

@Expose(serialize = false, deserialize = false) //序列化和反序列化都不生效，和不写注解一样
private String d;

private String e;

public User(String a, String b, String c, String d, String e) {
this.a = a;
this.b = b;
this.c = c;
this.d = d;
this.e = e;
}

@Override
public String toString() {
return “User{” +
“a='” + a + ‘’’ +
“, b='” + b + ‘’’ +
“, c='” + c + ‘’’ +
“, d='” + d + ‘’’ +
“, e='” + e + ‘’’ +
‘}’;
}

}

按照如上的注解值，只有声明了 Expose 注解且 serialize 值为 true 的字段才能被序列化，只有声明了 Expose 注解且 deserialize 值为 true 的字段才能被反序列化

public static void main(String[] args) {
Gson gson = new GsonBuilder().excludeFieldsWithoutExposeAnnotation().create();
User user = new User(“A”, “B”, “C”, “D”, “E”);
System.out.println();
System.out.println(gson.toJson(user));

String json = “{“a”:“A”,“b”:“B”,“c”:“C”,“d”:“D”,“e”:“E”}”;
user = gson.fromJson(json, User.class);
System.out.println();
System.out.println(user.toString());
}

3.2、基于版本

Gson 提供了 @Since 和 @Until 两个注解基于版本对字段进行过滤，@Since 和 @Until 都包含一个 Double 属性值，用于设置版本号。Since 的意思是“自……开始”，Until 的意思是“到……为止”，一样要和 GsonBuilder 配合使用。

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.TYPE})
public @interface Since {
double value();
}

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.TYPE})
public @interface Until {
double value();
}

当版本( GsonBuilder 设置的版本) 大于或等于 Since 属性值或小于 Until 属性值时字段会进行序列化和反序列化操作，而没有声明注解的字段都会加入序列化和反序列操作

现在来看个例子，修改 User 类

/**

  • 作者：chenZY
  • 时间：2018/3/17 18:32
  • 描述：https://github.com/leavesC
    */
    public class User {

@Since(1.4)
private String a;

@Since(1.6)
private String b;

@Since(1.8)
private String c;

@Until(1.6)
private String d;

@Until(2.0)
private String e;

public User(String a, String b, String c, String d, String e) {
this.a = a;
this.b = b;
this.c = c;
this.d = d;
this.e = e;
}

@Override
public String toString() {
return “User{” +
“a='” + a + ‘’’ +
“, b='” + b + ‘’’ +
“, c='” + c + ‘’’ +
“, d='” + d + ‘’’ +
“, e='” + e + ‘’’ +
‘}’;
}

}

public static void main(String[] args) {
Gson gson = new GsonBuilder().setVersion(1.6).create();
User user = new User(“A”, “B”, “C”, “D”, “E”);
System.out.println();
System.out.println(gson.toJson(user));

String json = “{“a”:“A”,“b”:“B”,“c”:“C”,“d”:“D”,“e”:“E”}”;
user = gson.fromJson(json, User.class);
System.out.println();
System.out.println(user.toString());
}

3.3、基于访问修饰符

访问修饰符由 java.lang.reflect.Modifier 提供 int 类型的定义，而 GsonBuilder 对象的 excludeFieldsWithModifiers方法接收一个 int 类型可变参数，指定不进行序列化和反序列化操作的访问修饰符字段 看个例子

/**

  • 作者：chenZY
  • 时间：2018/3/17 18:32
  • 描述：https://github.com/leavesC
    */
    public class ModifierSample {

public String publicField = “public”;

protected String protectedField = “protected”;

private String privateField = “private”;

String defaultField = “default”;

final String finalField = “final”;

static String staticField = “static”;

}

public static void main(String[] args) {
Gson gson = new GsonBuilder().excludeFieldsWithModifiers(Modifier.PRIVATE, Modifier.STATIC).create();
ModifierSample modifierSample = new ModifierSample();
System.out.println(gson.toJson(modifierSample));
}

3.4、基于策略

GsonBuilder 类包含 setExclusionStrategies(ExclusionStrategy... strategies)方法用于传入不定长参数的策略方法，用于直接排除指定字段名或者指定字段类型 看个例子

/**

  • 作者：chenZY
  • 时间：2018/3/17 18:32
  • 描述：https://github.com/leavesC
    */
    public class Strategies {

private String stringField;

private int intField;

private double doubleField;

public Strategies(String stringField, int intField, double doubleField) {
this.stringField = stringField;
this.intField = intField;
this.doubleField = doubleField;
}

@Override
public String toString() {
return “Strategies{” +
“stringField='” + stringField + ‘’’ +
“, intField=” + intField +
“, doubleField=” + doubleField +
‘}’;
}

}

public static void main(String[] args) {
Gson gson = new GsonBuilder().setExclusionStrategies(new ExclusionStrategy() {
@Override
public boolean shouldSkipField(FieldAttributes fieldAttributes) {
//排除指定字段名
return fieldAttributes.getName().equals(“intField”);
}

@Override
public boolean shouldSkipClass(Class<?> aClass) {
//排除指定字段类型
return aClass.getName().equals(double.class.getName());
}
}).create();

Strategies strategies = new Strategies(“stringField”, 111, 11.22);
System.out.println();
System.out.println(gson.toJson(strategies));

String json = “{“stringField”:“stringField”,“intField”:111,“doubleField”:11.22}”;
strategies = gson.fromJson(json, Strategies.class);
System.out.println();
System.out.println(strategies);
}

字段名为 “intField” 和字段类型为 double 的字段都会被排除掉

setExclusionStrategies 方法在序列化和反序列化时都会生效，如果只是想指定其中一种情况下的排除策略或分别指定排除策略，可以改为使用以下两个方法

addSerializationExclusionStrategy(ExclusionStrategy strategy);

addDeserializationExclusionStrategy(ExclusionStrategy strategy);

四、个性化配置

4.1、输出 null

对于 Gson 而言，在序列化时如果某个属性值为 null 的话，那么在序列化时该字段不会参与进来，如果想要显示输出该字段的话，可以通过 GsonBuilder 进行配置

/**

  • 作者：chenZY
  • 时间：2018/3/17 18:32
  • 描述：https://github.com/leavesC
    */
    public class Strategies {

private String stringField;

private int intField;

private double doubleField;

}

public static void main(String[] args) {
Gson gson = new GsonBuilder()
.serializeNulls() //输出null
.create();
Strategies strategies = new Strategies(null, 24, 22.333);
System.out.println();
System.out.println(gson.toJson(strategies));
}

4.2、格式化输出Json

默认的序列化后的 Josn 字符串并不太直观，可以选择格式化输出

public static void main(String[] args) {
Gson gson = new GsonBuilder()
.serializeNulls() //输出null
.setPrettyPrinting()//格式化输出
.create();
Strategies strategies = new Strategies(null, 24, 22.333);
System.out.println();
System.out.println(gson.toJson(strategies));
}

4.3、格式化时间

Gson 也可以对时间值进行格式化

/**

最后

如果你看到了这里，觉得文章写得不错就给个赞呗？如果你觉得那里值得改进的，请给我留言。一定会认真查询，修正不足。谢谢。

最后针对Android程序员，我这边给大家整理了一些资料，包括不限于高级UI、性能优化、移动架构师、NDK、混合式开发（ReactNative+Weex）微信小程序、Flutter等全方面的Android进阶实践技术；希望能帮助到大家，也节省大家在网上搜索资料的时间来学习，也可以分享动态给身边好友一起学习！

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化学习资料的朋友，可以戳这里获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

时间

Gson 也可以对时间值进行格式化

/**

最后

如果你看到了这里，觉得文章写得不错就给个赞呗？如果你觉得那里值得改进的，请给我留言。一定会认真查询，修正不足。谢谢。

[外链图片转存中…(img-PBZSjAe6-1714279342163)]

最后针对Android程序员，我这边给大家整理了一些资料，包括不限于高级UI、性能优化、移动架构师、NDK、混合式开发（ReactNative+Weex）微信小程序、Flutter等全方面的Android进阶实践技术；希望能帮助到大家，也节省大家在网上搜索资料的时间来学习，也可以分享动态给身边好友一起学习！

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化学习资料的朋友，可以戳这里获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

2401_84123150
关注
  • 10
    点赞
  • 踩
  • 29
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
android gson教程,Android Gson使用详解
weixin_35994939的博客
05-31 2987
一、Gson的基本用法1.1、Gson对象在进行序列化与反序列操作前，需要先实例化一个com .google.gson.Gson对象，获取 Gson 对象的方法有两种//通过构造函数来获取Gsongson=newGson();//通过GsonBuilder来获取，可以进行多项特殊配置Gsongson=newGsonBuilder().create();1.2...
Android使用Kotlin利用Gson解析多层嵌套Json数据
11-22
Android使用Kotlin利用Gson解析多层嵌套Json数据
Android Gson总结
xiangxiongfly
02-26 3390
Gson是一个Java库，用于将Java对象序列化为JSON格式，或将JSON格式反序列化为Java对象。
Android序列化(四) 之 Gson
子云心的博客
03-18 6298
1 概述 Json（JavaScript Object Notation）是一种可读性和通用性都非常强的轻量级的数据交换格式，一开始是JavaScript中广泛使用，到了后面流传几乎所有语言都有相应的使用API，所以它已是行业公认的标准。与JavaScript等的动态类型语言一起使用时非常方便，只要将数据转换成字符串，便可以在函数之间轻松地传递字符串进行数据传递。但是在像C++、Java等的静态类型语言序列化数据时，Json的效率表现仅一般，而且还需要编写较多代码来访问数据和转化成类对象。 Gson是G
Android中Gson的使用
热门推荐
小书童的博客
11-15 1万+
Gson在android中的应用什么是Gson下载Json的生成Json的解析 什么是Gson Gson是一个Java库，可用于将Java对象转换为它们的Json 表示形式。它还可以用于将Json 字符串转换为等效的Java对象。Json 的解析和生成的方式很多，在 Android 平台上最常用的类库有 Gson 和 FastJson 两种，这里要介绍的是 Gson。 Gson 的 GitHub 主页点击这里：Gson 下载 Gradle: dependencies { implementation '
Android 中Banner的使用详解
01-04
<uses android:name=android.permission.INTERNET> <uses android:name=android.permission.ACCESS_NETWORK_STATE>  布局文件： <com.youth.banner.Banner android:id=@+id/banner_id android:layout_width=...
Android中gson、jsonobject解析JSON的方法详解
09-02
JSON即JavaScript Object Natation, 它是一种轻量级的数据交换格式, 与XML一样, 是广泛被采用的客户端和服务端交互...接下来由脚本之家小编给大家介绍Android中gson、jsonobject解析JSON的方法，感兴趣的朋友一起学习吧
详解Android原生json和fastjson的简单使用
01-05
android原生操作json数据 主要是两个类 JSONObject 操作对象 JONSArray操作json数组 对象转json //创建学生对象 Student student=new Student(); student.setAge(23); student.setClazz(六年级); student.set...
Android编程之json解析实例详解
01-04
本文实例分析了Android编程之json解析的方法。分享给大家供大家参考，具体如下： JSON的定义： 一种轻量级的数据交换格式，具有良好的可读和便于快速编写的特性。业内主流技术为其提供了完整的解决方案（有点类似于...
Android Studio最新好用的插件----Gson转Java实体类/Kotlin Data
安卓开发&音视频开发
07-04 7419
Android Studio Gson转Java实体类/Kotlin Data
Android Gson使用详解，android中级工程师面试题
m0_64383081的博客
12-15 459
例如，修改 User 类，为 name 声明 SerializedName 注解，注解值为 userName /** 作者：chenZY 时间：2018/3/17 18:32 描述：https://github.com/leavesC */ public class User { @SerializedName(“userName”) private String name; private int age; private boolean sex; } 在序列时，Json 格式就会相应改变 publi
android Gson 使用的四种方式
Chigo
07-31 2513
相对于较为传统的Json解析来说，google共享的开源Gson在解析速度和所使用的内存在有着明显的优势，虽然说阿里巴巴也提供了fastgson包，但是它跟Gson的处理速度大同小异，只是底层实现的原理不同，在这里就来学习一下怎么使用google的开源包Gson（在学习之间你应该下载好google gson包）Gson的解析非常简单，但是它的解析规则是必须有一个bean文件，这个bean文件的内容跟
【Android开发--新手必看篇】依赖框架Gson的使用
江川一梦的博客
09-23 5187
Android笔记 ​ ——Gson 【若对该知识点有更多想了解的，欢迎私信博主~~】 依赖框架：Gson 一：优势及作用 提供简单的toJson()和fromJson()方法，将java对象与JSON轻松转换 允许将现有的不可修改对象与JSON相互转换 Java泛型的支持 允许对象的自定义表示 支持任意复杂的对象 二：Gson的配置 分build.gradle中添加（注入依赖） dependencies { implementation 'com.google.code.gson:gson
Android—Gson原理解析
#请假条的博客
11-24 2780
JsonElement 抽象类 代表json串的某一个元素 某一个元素： JsonObject JsonArray JsonPrimitive（基本类型） JsonNull JsonElement的四个子类 JsonObject、JsonArray、JsonPrimitive、JsonNull JsonPrimitive 该类对Java的基本类型及其对应的对象类进行了封装。（短整长，单精双精，字符<表示为单字符字符串>，布尔） Gson对象的产生 通过new G.
Android开发之解析不同json数据，Gson
夏季的李子不酸的博客
10-08 1407
Android之不同json语句解析，包含了三种
Android框架-Google官方Gson解析，字节大牛耗时八个月又一力作
最新发布
m0_60635637的博客
03-16 934
上面的方式是倾向于整体的，下面是注解的方式，比较倾向于字段System.out.println(“服务器发送：” + json_str);System.out.println(“gson解析:” + person1);} catch (Exception e) { System.out.println(“gson解析异常:” + e);System.out.println(“JsonAdapter注解解析:” + person);
Android基础篇-GSON解析的学习
王涛的博客
09-13 755
阅读时如有疑问和错误欢迎评论提出或者加我企鹅1262135886 ,谢谢支持Gson 是 Google 提供的用来在 Java 对象和 JSON 数据之间进行映射的 Java 类库。可以将一个 JSON 字符串转成一个 Java 对象，或者反过来。 **准备工作** 下载GSON的jar包，为了大家学习方便这里提供下载地址 http://download.c
Android端gson使用
05-18
在Android端，可以通过以下步骤使用Gson： 1. 添加依赖 在你的app模块的build.gradle文件中添加以下依赖： ``` implementation 'com.google.code.gson:gson:2.8.6' ``` 2. 创建Java对象 创建一个Java对象并为其...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值