Gson

---

maven依赖

<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.4</version>
</dependency>

---

常用API

创建Gson

// 1. 普通方式创建Gson 对象
Gson gson = new Gson();

// 2. 通过GsonBuilder 创建Gson 对象（用于处理一些复杂情况）
GsonBuilder builder = new GsonBuilder();
Gson gson = builder.create();

序列化

String toJson(Object obj)

// 序列化
User user = new User("张三", 23, "zs@example.com");
String jsonStr = gson.toJson(user);
System.out.println(jsonStr);

// 控制台结果  {"name":"张三","age":23,"emailAddress":"zs@example.com"}

反序列化

T fromJson(String json, Class clazz)

 // 反序列化
 String jsonStr = "{'name':'张三','age':23,'emailAddress':'zs@example.com'}";
 User user = gson.fromJson(jsonStr, User.class);
 System.out.println(user);

控制台结果 User [name=张三, age=23, emailAddress=zs@example.com]

---

常用注解

@SerializedName注解 【属性重命名】

从上面POJO的生成与解析可以看出json的字段和值是的名称和类型是一一对应的，但也有一定容错机制，但有时候也会出现一些不和谐的情况。例：
期望的json格式

 {"name":"张三","age":23,"emailAddress":"zs@example.com"}

实际

{"name":张三","age":23,"email_address":"zs@example.com"}

这对于使用PHP作为后台开发语言时很常见的情况，php和js在命名时一般采用下划线风格，而Java中一般采用的驼峰法，让后台的哥们改吧 前端和后台都不爽，但要自己使用下划线风格时我会感到不适应，怎么办?难到没有两全齐美的方法么?

我们知道Gson在序列化和反序列化时需要使用反射，说到反射就不得不想到注解,一般各类库都将注解放到annotations包下，打开源码在com.google.gson包下果然有一个annotations，里面有一个SerializedName的注解类，这应该就是我们要找的。

那么对于json中email_address这个属性对应POJO的属性则变成：

@SerializedName("email_address")
public String emailAddress;

这样的话，很好的保留了前端、后台、Android/java各自的命名习惯。

你以为这样就完了么?

如果接中设计不严谨或者其它地方可以重用该类，其它字段都一样，就emailAddress 字段不一样，比如有下面三种情况那怎么?重新写一个?

{"name":"怪盗kidou","age":24,"emailAddress":"ikidou@example.com"}

{"name":"怪盗kidou","age":24,"email_address":"ikidou@example.com"}

{"name":"怪盗kidou","age":24,"email":"ikidou@example.com"}

为POJO字段提供备选属性名
SerializedName注解提供了两个属性，上面用到了其中一个，别外还有一个属性alternate，接收一个String数组。
注：alternate需要2.4版本

@SerializedName(value = "emailAddress", alternate = {"email", "email_address"})
public String emailAddress;

当上面的三个属性(email_address、email、emailAddress)都中出现任意一个时均可以得到正确的结果。

@Expose注解

字段过滤Gson中比较常用的技巧，特别是在Android中，在处理业务逻辑时可能需要在设置的POJO中加入一些字段，但显然在序列化的过程中是不需要的，并且如果序列化还可能带来一个问题就是 循环引用 ，那么在用Gson序列化之前为不防止这样的事件情发生，你不得不作另外的处理。

以一个商品分类Category 为例。

{
  "id": 1,
  "name": "电脑",
  "children": [
    {
      "id": 100,
      "name": "笔记本"
    },
    {
      "id": 101,
      "name": "台式机"
    }
  ]
}

一个大分类，可以有很多小分类，那么显然我们在设计Category类时Category本身既可以是大分类，也可以是小分类。

public class Category {
    public int id;
    public String name;
    public List<Category> children;
}

但是为了处理业务，我们还需要在子分类中保存父分类，最终会变成下面的情况

public class Category {
    public int id;
    public String name;
    public List<Category> children;
    //因业务需要增加，但并不需要序列化
    public Category parent; 
}

但是上面的parent字段是因业务需要增加的，那么在序列化是并不需要，所以在序列化时就必须将其排除，那么在Gson中如何排除符合条件的字段呢?下面提供4种方法，大家可根据需要自行选择合适的方式。

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

注：根据上面可以得出，所有值为true的属性都是可以不写的（默认值是true）。

@Expose提供了两个属性，且都有默认值（默认值是true），开发者可以根据需要设置不同的值。
@Expose 注解从名字上就可以看出是暴露的意思，所以该注解是用于对外暴露字段的。可是我们以前用Gson的时候也没有@Expose 注解还不是正确的序列化为JSON了么?是的，所以该注解在使用new Gson() 时是不会发生作用。毕竟最常用的API要最简单，所以该注解必须和GsonBuilder配合使用。

使用方法： 简单说来就是需要导出的字段上加上@Expose 注解，不导出的字段不加。【注意】不导出的不加。

拿上面的例子来说就是

public class Category {
    @Expose public int id;
    @Expose public String name;
    @Expose public List<Category> children;
    //不需要序列化,所以不加 @Expose 注解，
    //等价于 @Expose(deserialize = false,serialize = false)
    public Category parent; 
}

在使用Gson时也不能只是简单的new Gson()了。

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

---

使用GsonBuilder导出null值、格式化输出、日期时间

一般情况下Gson类提供的 API已经能满足大部分的使用场景，但我们需要更多更特殊、更强大的功能时，这时候就引入一个新的类 GsonBuilder。

GsonBuilder从名上也能知道是用于构建Gson实例的一个类，要想改变Gson默认的设置必须使用该类配置Gson。

GsonBuilder用法

Gson gson = new GsonBuilder()
               //各种配置
               .create(); //生成配置好的Gson

Gson在默认情况下是不会导出值null的键的，如：

public class User {
    //省略其它
    public String name;
    public int age;
    public String email;
}
Gson gson = new Gson();
User user = new User("张三", 23);
System.out.println(gson.toJson(user)); //{"name":"张三","age":23}

可以看出，email字段是没有在json中出现的，当我们在调试是、需要导出完整的json串时或API接中要求没有值必须用Null时，就会比较有用。

使用方法：

Gson gson = new GsonBuilder()
        .serializeNulls()
        .create();
User user = new User("张三", 23);
System.out.println(gson.toJson(user)); //{"name":"张三","age":23,"email":null}

格式化输出、日期时间及其它：

这些都比较简单就不一一分开写了。

Gson gson = new GsonBuilder()
        //序列化null
        .serializeNulls()
        // 设置日期时间格式，另有2个重载方法
        // 在序列化和反序化时均生效
        .setDateFormat("yyyy-MM-dd")
        // 禁此序列化内部类
        .disableInnerClassSerialization()
        //生成不可执行的Json（多了 )]}' 这4个字符）
        .generateNonExecutableJson()
        //禁止转义html标签
        .disableHtmlEscaping()
        //格式化输出
        .setPrettyPrinting()
        .create();

---

TypeAdapter的使用

内容比较多，这里提供两篇不错的文章，读者可自行学习
https://www.jianshu.com/p/8cc857583ff4

https://www.jianshu.com/p/3108f1e44155