Android框架-Google官方Gson解析(1)

最新推荐文章于 2024-06-08 15:47:53 发布

2401_84901213

最新推荐文章于 2024-06-08 15:47:53 发布

阅读量891

点赞数 19

分类专栏：程序员文章标签： android java 网络

本文链接：https://blog.csdn.net/2401_84901213/article/details/138727177

版权

程序员专栏收录该内容

60 篇文章 0 订阅

订阅专栏

Gson 库中的注解：有五种注解

![](https://img-blog.csdnimg.cn/img_convert/ecb083a6eb98c44f5471e6db37a8ec25.webp?x-oss-process=image/format,png)

1、首先着重的先说明重命名注解: SerializedName

**注解的作用：**转换 key 关键字，json 转换成对象是，json 字段的 key 默认必须和声明类的字段名称一样。但是如果服务器返回的数据中 key 是关键字，这该怎么办？例如 key 是 case、switch 等，我们在声明类的时候是不能用这些字段的。或许你会让服务端那边改动，那服务端可能要改动非常的大，但是实际情况是不太愿意去改的。而这时候重命名注解就派上用场了。

还有就是如果服务端返回的 json 的 key 太冗余、或是不直观，这是就可以简化一下，代码看起来比较的优雅。

#####替换关键字的 key：

public class AnnotationTest { public class Person { private int per_id; private String name; private String sex; @SerializedName(“case”) private int case_num; public Person(int per_id, String name, String sex, int case_num) { super(); this.per_id = per_id; this.name = name; this.sex = sex; this.case_num = case_num; } @Override public String toString() { return “Person–>[per_id=” + per_id + “, name=” + name + “, sex=” + sex + “, case_num=” + case_num + “]”; } } public static void main(String[] args) { Gson gson = new Gson(); String json_str = “{“per_id”:1,“name”:“layne”,“sex”:“man”,“case”:18}”; Person person = gson.fromJson(json_str, Person.class); System.out.println(“服务端发送的情况：”+json_str); System.out.println(“移动端转换的情况：”+person); } }

#####运行结果：

![](https://img-blog.csdnimg.cn/img_convert/eaf1ff1498e39f4b6d92ab33bc4d702a.webp?x-oss-process=image/format,png)

替换冗余、难看的 key：

public class AnnotationTest1 { public class Person { private int per_id; private String name; private String sex; @SerializedName(“home_light_state”) private boolean state; public Person(int per_id, String name, String sex, boolean state) { super(); this.per_id = per_id; this.name = name; this.sex = sex; this.state = state; } @Override public String toString() { return “Person [per_id=” + per_id + “, name=” + name + “, sex=” + sex + “, state=” + state + “]”; } } public static void main(String[] args) { Gson gson = new Gson(); String json_str = “{“per_id”:1,“name”:“layne”,“sex”:“man”,“home_light_state”:true}”; Person person = gson.fromJson(json_str, Person.class); System.out.println(“服务端发送的情况：”+json_str); System.out.println(“移动端转换的情况：”+person); } }

#####运行结果：

![](https://img-blog.csdnimg.cn/img_convert/599c38e63f02bbc33bf2ff26fb8e49e6.webp?x-oss-process=image/format,png)

**注解作用2:**结合 alternate 提供多种备用字段key来解析,@SerializedName(value = “state”, alternate = { “plus”, “all” })

如果 json 中有 plus 就会解析成 state，如果有 all 也会解析成 state,当然
state 依旧不变的。
**注意1:**value 中的值不能出现在 alternate 中；
**注意2:**alternate 的备选字段会后面的替换前面的。

#####实例代码：

public class AnnotationTest2 { public class Person { private int per_id; private String name; private String sex; @SerializedName(value = “state”, alternate = { “plus”, “all” }) private String state; public Person(int per_id, String name, String sex, String state) { super(); this.per_id = per_id; this.name = name; this.sex = sex; this.state = state; } @Override public String toString() { return “Person [per_id=” + per_id + “, name=” + name + “, sex=” + sex + “, state=” + state + “]”; } } public static void main(String[] args) { Gson gson = new Gson(); String json_str = “{“per_id”:1,“name”:“layne”,“sex”:“man”,“all”:“广东广州”}”; Person person = gson.fromJson(json_str, Person.class); System.out.println(“服务端发送：”+json_str); System.out.println(“转换成:” + person); System.out.println(““); String json_str1 = “{“per_id”:1,“name”:“layne”,“sex”:“man”,“plus”:“广东广州”}”; Person person1 = gson.fromJson(json_str1, Person.class); System.out.println(“服务端发送：”+json_str1); System.out.println(“转换成:” + person1); System.out.println(””); //all在state之后，所以all会解析成state，值则是all的原先的值 String json_str2 = “{“per_id”:1,“name”:“layne”,“sex”:“man”,“state”:“state广东广州”,“all”:“all广东广州”}”; Person person2 = gson.fromJson(json_str2, Person.class); System.out.println(“服务端发送：”+json_str2); System.out.println(“转换成:” + person2); System.out.println(““); //state在最后，不用解析，解析后的值也是state原先的 String json_str3 = “{“per_id”:1,“name”:“layne”,“sex”:“man”,“plus”:“plus广东广州”,“state”:“all广东广州”}”; Person person3 = gson.fromJson(json_str3, Person.class); System.out.println(“服务端发送：”+json_str3); System.out.println(“转换成:” + person3); System.out.println(””); } }

#####运行结果：

![](https://img-blog.csdnimg.cn/img_convert/13a24bfd8ad2060239824e13689e399f.webp?x-oss-process=image/format,png)

2、过滤注解：Expose

源码:默认既可序列化又可反序列化

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

可以排除不需要序列化的字段,需要配合 GsonBuilder 使用

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

不添加 @Expose 注解的字段将不会解析，分为以下几种情况:
**1、**不添加 @Expose 注解等同于 @Expose(deserialize = false,serialize = false) 不做任何解析
2、@Expose(deserialize = true,serialize = false) 只解析用用，也就是反序列化可以，序列化不可以
3、@Expose(deserialize = false,serialize = true) 序列化可以，反序列化不行
4、@Expose(deserialize = true,serialize = true) 既可以序列化，也可以反序列化

#####实例代码：
不添加 @Expose 注解等同于 @Expose(deserialize = false,serialize = false) 不做任何解析

public class ExposeTest { public static class Person { private int per_id; private String name; private String sex; private boolean state; public Person(int per_id, String name, String sex, boolean state) { this.per_id = per_id; this.name = name; this.sex = sex; this.state = state; } @Override public String toString() { return “Person–>[per_id=” + per_id + “, name=” + name + “, sex=” + sex + “, state=” + state + “]”; } } public static void main(String[] args) { String json_str = “{“per_id”:1,“name”:“layne”,“sex”:“man”,“state”:true}”; Gson gson = new GsonBuilder().excludeFieldsWithoutExposeAnnotation() .create(); Person person = gson.fromJson(json_str, Person.class); System.out.println(“反序列化：” + person); Person person1 = new Person(2, “layne”, “man”, true); String json_str1 = gson.toJson(person1); System.out.println(“序列化：”+json_str1); } }

#####运行结果：

![](https://img-blog.csdnimg.cn/img_convert/2e4a2b533ce8326149b6b4052aef1325.webp?x-oss-process=image/format,png)

其余三种情况请查看原文

3、版本控制注解：Since、Util

Since 注解：Gson 实例配置 GsonBuilder.setVersion(n) 使用，当 n>=v 时，才会序列化解析

#####实例代码：

public class SinceTest { public static class Person { @Since(2) private int per_id; @Since(2) private String name; @Since(2) private String sex; @Since(2) private boolean state; public Person(int per_id, String name, String sex, boolean state) { this.per_id = per_id; this.name = name; this.sex = sex; this.state = state; } @Override public String toString() { return “Person–>[per_id=” + per_id + “, name=” + name + “, sex=” + sex + “, state=” + state + “]”; } } public static void main(String[] args) { String json_str = “{“per_id”:1,“name”:“layne”,“sex”:“man”,“state”:true}”; Gson gson = new GsonBuilder().setVersion(1)//版本为1 .create(); Person person = gson.fromJson(json_str, Person.class); System.out.println(“反序列化v=1：” + person); Person person1 = new Person(2, “layne”, “man”, true); String json_str1 = gson.toJson(person1); System.out.println(“序列化v=1：”+json_str1); System.out.println(“=“); Gson gson1 = new GsonBuilder().setVersion(2)//版本为2 .create(); Person person2 = gson1.fromJson(json_str, Person.class); System.out.println(“反序列化v=2：” + person2); Person person3 = new Person(2, “layne”, “man”, true); String json_str2 = gson1.toJson(person3); System.out.println(“序列化v=2：”+json_str2); System.out.println(”=”); Gson gson2 = new GsonBuilder().setVersion(3)//版本为3 .create(); Person person4 = gson2.fromJson(json_str, Person.class); System.out.println(“反序列化v=3：” + person4); Person person5 = new Person(2, “layne”, “man”, true); String json_str3 = gson2.toJson(person5); System.out.println(“序列化v=3：”+json_str3); } }

#####运行结果：

![](https://img-blog.csdnimg.cn/img_convert/eafa67a3dff6d24ed0b41750b92274d1.webp?x-oss-process=image/format,png)

Util 注解：Gson 实例配置 GsonBuilder.setVersion(n) 使用，当 n < v 时，才会序列化解析

#####实例代码：

public class UtilTest { public static class Person { @Until(2) private int per_id; @Until(2) private String name; @Until(2) private String sex; @Until(2) private boolean state; public Person(int per_id, String name, String sex, boolean state) { this.per_id = per_id; this.name = name; this.sex = sex; this.state = state; } @Override public String toString() { return “Person–>[per_id=” + per_id + “, name=” + name + “, sex=” + sex + “, state=” + state + “]”; } } public static void main(String[] args) { String json_str = “{“per_id”:1,“name”:“layne”,“sex”:“man”,“state”:true}”; Gson gson = new GsonBuilder().setVersion(1)// 版本为1 .create(); Person person = gson.fromJson(json_str, Person.class); System.out.println(“反序列化v=1：” + person); Person person1 = new Person(2, “layne”, “man”, true); String json_str1 = gson.toJson(person1); System.out.println(“序列化v=1：” + json_str1); System.out.println(“=“); Gson gson1 = new GsonBuilder().setVersion(2)// 版本为2 .create(); Person person2 = gson1.fromJson(json_str, Person.class); System.out.println(“反序列化v=2：” + person2); Person person3 = new Person(2, “layne”, “man”, true); String json_str2 = gson1.toJson(person3); System.out.println(“序列化v=2：” + json_str2); System.out.println(”=”); Gson gson2 = new GsonBuilder().setVersion(3)// 版本为3 .create(); Person person4 = gson2.fromJson(json_str, Person.class); System.out.println(“反序列化v=3：” + person4); Person person5 = new Person(2, “layne”, “man”, true); String json_str3 = gson2.toJson(person5); System.out.println(“序列化v=3：” + json_str3); } }

#####运行结果：

![](https://img-blog.csdnimg.cn/img_convert/c3bd9d5f04d6001aeeb5e52364a030c7.webp?x-oss-process=image/format,png)

Gson 还有一种更高级的手法进行序列化和反序列化，那就是 TypeAdapter ，就是就是对象 json 之间的互相转换接替了T 泛型类的序列化和反序列化的逻辑，大家如果有兴趣可以去看一下源码，2.1版本之前后的用法是不一样的，2.1版本之前可以自定义 adapter，在2.1版本之后更推荐直接插入泛型就使用。在这里演示泛型的

代码演示：

public class TypeAdapterTest { public static class Person { private int per_id; private String name; private String sex; private boolean state; public Person(int per_id, String name, String sex, boolean state) { this.per_id = per_id; this.name = name; this.sex = sex; this.state = state; } @Override public String toString() { return “Person–>[per_id=” + per_id + “, name=” + name + “, sex=” + sex + “, state=” + state + “]”; } } public static void main(String[] args) throws Exception { Gson gson = new Gson(); TypeAdapter personTypeAdapter = gson.getAdapter(Person.class); Person person = new Person(1, “layne”, “man”, true); String json_str = personTypeAdapter.toJson(person); System.out.println(“序列化结果:” + json_str); Person person1 = personTypeAdapter.fromJson(json_str); System.out.println(“反序列化结果:” + person1); } }

#####运行结果：

![](https://img-blog.csdnimg.cn/img_convert/1a4f08330071bec58a423465d55ce9f3.webp?x-oss-process=image/format,png)

接下来就是容错机制

为什么要容错了？
在 javaBean 中编号 per_id 声明的事 int 类，如果服务端返回的是""空字符串，那么客户端该怎么办？崩溃吗？
这时候就需要容错机制啦，容错的实现方式：

创建 Gson 的方式
使用 JsonReader
自定义 TypeAdapter
使用注解 JsonAdapter,其实也是自定义 Adapter

方式1和2可以归为一类由框架实现,基本 json 大格式规范,键值对不标准,多引号的问题等等,而不报错停止解析,但是功能相对较弱，能解决 bug

方式1：Gson 的创建方式

gson = new GsonBuilder() .setLenient()// json宽松 .create();

方式2：使用 JsonReader

JsonReader jsonReader = gson.newJsonReader(value.charStream()); jsonReader.setLenient(true);

方式 3和4也可以归为一类,都属于自定义 adapter,但是方式3与 gson 绑定,方式4使用注解和字段绑定

代码示例：（这种方式比较倾向于整体）

public class FaultToleranceTest { public static class Person { private int per_id; private String name; private String sex; private boolean state; public Person() { } public Person(int per_id, String name, String sex, boolean state) { this.per_id = per_id; this.name = name; this.sex = sex; this.state = state; } @Override public String toString() { return “Person–>[per_id=” + per_id + “, name=” + name + “, sex=” + sex + “, state=” + state + “]”; } } public static class PersonTypeAdapter extends TypeAdapter { @Override public Person read(JsonReader in) throws IOException { Person person = new Person(); in.beginObject(); while (in.hasNext()) { switch (in.nextName()) { case “per_id”: try { String str = in.nextString(); person.per_id = Integer.valueOf(str); } catch (Exception e) { } break; case “name”: person.name = in.nextString(); break; case “sex”: person.sex = in.nextString(); break; case “state”: person.state = in.nextBoolean(); break; } } in.endObject(); return person; } @Override public void write(JsonWriter out, Person person) throws IOException { out.beginObject(); out.name(“per_id”).value(person.per_id); out.name(“name”).value(person.name); out.name(“sex”).value(person.sex); out.name(“state”).value(person.state); out.endObject(); } } public static void main(String[] args) { Gson gson = new Gson(); String json_str = “{“per_id”:”“,“name”:“layne”,“sex”:“man”,“state”:true}”; System.out.println(“服务端发送:” + json_str); try { Person person = gson.fromJson(json_str, Person.class); System.out.println(“默认Gson解析:” + person); } catch (JsonParseException e) {// java.lang.NumberFormatException: // empty String System.out.println(“默认Gson解析异常:” + e); } Gson gson2 = new GsonBuilder().registerTypeAdapter(Person.class, new PersonTypeAdapter()).create(); try { Person person2 = gson2.fromJson(json_str, Person.class); System.out.println(“自定义PersonTypeAdapter解析:” + person2); } catch (JsonParseException e) {// java.lang.NumberFormatException: // empty String System.out.println(“自定义PersonTypeAdapter解析异常:” + e); } try { PersonTypeAdapter personTypeAdapter = new PersonTypeAdapter(); Person person3 = personTypeAdapter.fromJson(json_str); System.out.println(“自定义PersonTypeAdapter解析2:” + person3); } catch (Exception e) { System.out.println(“自定义PersonTypeAdapter解析异常2:” + e); } } }

#####运行结果：

![](https://img-blog.csdnimg.cn/img_convert/c1ced6dafe8431ccbf3c84ee8c7fe0b6.webp?x-oss-process=image/format,png)

3. 自定义 TypeAdapter

上面的方式是倾向于整体的，下面是注解的方式，比较倾向于字段

代码演示：

public class FaultToleranceTest1 { public static class Person { @JsonAdapter(IntegerTypeAdapter.class) private int per_id; private String name; private String sex; private boolean state; public Person() { } public Person(int per_id, String name, String sex, boolean state) { this.per_id = per_id; this.name = name; this.sex = sex; this.state = state; } @Override public String toString() { return “Person–>[per_id=” + per_id + “, name=” + name + “, sex=” + sex + “, state=” + state + “]”; } } public static class Person1 { private int per_id; private String name; private String sex; private boolean state; public Person1() { } public Person1(int per_id, String name, String sex, boolean state) { this.per_id = per_id; this.name = name; this.sex = sex; this.state = state; } @Override public String toString() { return “Person1–>[per_id=” + per_id + “, name=” + name + “, sex=” + sex + “, state=” + state + “]”; } } public static class IntegerTypeAdapter extends TypeAdapter { @Override public void write(JsonWriter out, Integer value) throws IOException { out.value(value); } @Override public Integer read(JsonReader in) throws IOException { int i = 0; try { String str = in.nextString(); i = Integer.valueOf(str); } catch (Exception e) { } return i; } } public static void main(String[] args) { Gson gson = new Gson(); String json_str = “{“per_id”:”“,“name”:“layne”,“sex”:“man”,“state”:true}”; System.out.println(“服务器发送：” + json_str); try { Person1 person1 = gson.fromJson(json_str, Person1.class); System.out.println(“gson解析:” + person1); } catch (Exception e) { System.out.println(“gson解析异常:” + e); } try { Person person = gson.fromJson(json_str, Person.class); System.out.println(“JsonAdapter注解解析:” + person); } catch (JsonParseException e) {// java.lang.NumberFormatException: // empty String System.out.println(“JsonAdapter注解异常:” + e); } } }

#####运行结果：

![](https://img-blog.csdnimg.cn/img_convert/a04a7f1e188ecee9501c06122adc14ae.webp?x-oss-process=image/format,png)

# 最后

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

因此我收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点！不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！
95%以上Android开发知识点！不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门**

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

2401_84901213

关注

19
点赞
踩
19

收藏

觉得还不错? 一键收藏
0
评论
Android框架-Google官方Gson解析(1)

上面的方式是倾向于整体的，下面是注解的方式，比较倾向于字段System.out.println(“服务器发送：” + json_str);System.out.println(“gson解析:” + person1);} catch (Exception e) { System.out.println(“gson解析异常:” + e);System.out.println(“JsonAdapter注解解析:” + person);
复制链接

扫一扫