Android中Gson的使用

Android中Gson的使用

1 简介

Gson是一个Java库，作用是将Java对象转换成它对应的JSON表示。
开源的JSON解析库有好几个，例如Jackson就是一个很有名的XML/JSON解析库。Gson与这些库的不同之处，表现在它的两个重要设计目标：

• 即使你无法修改源代码，你也能通过Gson对代码中的类做解析和变换。
• 充分支持Java泛型。

在学习过程中我们能发现，第一点很好理解，并且也简化了对Gson的使用；而第二点对泛型的支持，则是掌握Gson框架的一个难点。

下图是Gson的设计目标：

image

其中功能性是难点，也比较不好理解，先重点掌握Gson的基本使用方式即可。

2 快速上手

Gson的基本使用是非常简单的。
首先在Android Studio项目中添加对Gson库的依赖：

compile 'com.google.code.gson:gson:2.6.2'

3 简单回顾Json

在正式开始使用Gson之前，先来简单回顾一下JSON的基础知识。
JSON是一种轻量级的数据交换格式，它主要有两种结构：
键值对的集合，对应于其它编程语言中的对象(例如Java)、struct(例如C)、Hash(例如Ruby)、字典(例如Python)等。
无序的值列表，对应于编程语言中的数据结构：数组、矢量、列表等。
注意JSON使用的这两种数据结构的简洁性，它们是不同编程语言之间通用的，这赋予了JSON连接不同编程语言的能力。
JSON中主要有5种数据形式：

• number，例如10
• string，例如“abcd”
• value，value可以是上面的number和String，也可以是下面的object和array，value的概念赋予了JSON嵌套表示的能力。value还包括三个特殊值：true，false和null。
• array，形如 [value, value, ... value] 的列表形式。
• object，形如 {string:value, string:value, ... string:value} 的键值对形式。

4 使用Gson

Gson库的关键类就是Gson，使用起来很简单，直接实例化 new Gson() 即可。它也可以通过GsonBuilder 类来实例化，进行一些初始化设置，初学时无需深入了解。
Gson实例是无状态的。所以多个JSON序列化和反序列操作完全可以重用一个Gson对象。

4.1 基本序列化方法

序列化是指将Java对象转换成JSON字符串，使用Gson.toJson(...)方法来进行序列化操作。举几个基本的序列化例子：

• number:

Gson gson = new Gson();
gson.toJson(1);            // ==> 1
gson.toJson(new Long(10)); // ==> 10

• string:

gson.toJson("abcd");       // ==> "abcd"

• value:

gson.toJson(true);         // ==> true

• object:

class BagOfPrimitives {
    private int value1 = 1;
    private String value2 = "abc";
    private transient int value3 = 3;
    BagOfPrimitives() {
    // no-args constructor
    }
}
// Serialization
BagOfPrimitives obj = new BagOfPrimitives();
Gson gson = new Gson();
String json = gson.toJson(obj);  
// ==> json is {"value1":1,"value2":"abc"}

• array:

Gson gson = new Gson();
int[] ints = {1, 2, 3, 4, 5};
String[] strings = {"abc", "def", "ghi"};
// Serialization
gson.toJson(ints);     // ==> [1,2,3,4,5]
gson.toJson(strings);  // ==> ["abc", "def", "ghi"]

4.2 基本反序列化方法

反序列化是指将JSON字符串传换成Java对象，使用Gson.fromJson(...)方法来进行反序列化操作。反序列化和序列化不同的一点是，你需要告诉Gson目标对象的类型是什么。举几个基本的反序列化例子：

• number:

int one = gson.fromJson("1", int.class);
Long one = gson.fromJson("1", Long.class);

• string:

String str = gson.fromJson("\"abc\"", String.class);

• value:

Boolean f = gson.fromJson("false", Boolean.class);

• object:

class BagOfPrimitives {
    private int value1 = 1;
    private String value2 = "abc";
    private transient int value3 = 3;
    BagOfPrimitives() {
    // no-args constructor
    }
}
String json = "{"value1":1,"value2":"abc"}";  
BagOfPrimitives obj2 = gson.fromJson(json, BagOfPrimitives.class);

• array:

int[] ints = {1, 2, 3, 4, 5};
int[] ints2 = gson.fromJson("[1,2,3,4,5]", int[].class); 
// ==> ints2 和 ints 相同。

4.3 序列化和反序列化中的注意点

• 对象的字段可以并推荐使用private。
• 无需使用注解指定哪些字段被包括在序列化和反序列化操作中。当前类，和它所有父类的所有字段都是默认包括的。
• 如果字段使用transient修饰，它被默认忽略，不包含在序列化和反序列化操作中。
• Gson可以正确处理null值。
• 序列化时，值为null的字段会被跳过。
• 反序列化时，JSON中缺失的项，其对象对应的字段会被设为null。
• 内部类、匿名类等隐含的外部类的字段会被忽略，不包含在序列化和反序列化中。

5 Gson的进阶使用

5.1 修改字段名

从上面的例子可以看出来，在序列化和反序列化时，字段名直接用来作为键值对中的key。有时，对象和它的JSON表示命名并不完全一致，这时就需要修改字段名，有两种方法：
使用@SerializeName注解自定义字段名；
使用FieldNamingPolicy来规定基本的命名策略；
例如：

private class SomeObject {
  @SerializedName("custom_naming") 
  private final String someField;

  private final String someOtherField;

  public SomeObject(String a, String b) {
    this.someField = a;
    this.someOtherField = b;
  }
}

SomeObject someObject = new SomeObject("first", "second");
Gson gson = new GsonBuilder().setFieldNamingPolicy(FieldNamingPolicy.UPPER_CAMEL_CASE).create();
String jsonRepresentation = gson.toJson(someObject);
System.out.println(jsonRepresentation);

结果将是

{"custom_naming":"first","SomeOtherField":"second"}

5.2 嵌套类(例如内部类)的情况

对于静态内部类，Gson可以直接处理。
对于非静态内部类，Gson不能自动反序列化，因为即使是非静态内部类的无参构造器，也需要一个外部类的引用，这在反序列化期间是做不到的。要解决这个问题，你要么将内部类声明为静态，要么提供一个自定义的InstanceCreator。例如：

public class A { 
  public String a; 

  class B { 

    public String b; 

    public B() {
    // No args constructor for B
    }
  } 
}

注意：默认情况下，B类不能用Gson序列化。

Gson不能讲{"b"："abc"}反序列化成B的对象，除非将B定义成静态的。另一个解决方法是写一个自定义的InstanceCreator：

public class InstanceCreatorForB implements InstanceCreator {
  private final A a;
  public InstanceCreatorForB(A a)  {
    this.a = a;
  }
  public A.B createInstance(Type type) {
    return a.new B();
  }
}

这是可行的，但不推荐这样来用。

5.3 集合的情况

Gson对集合的处理方式比较丑陋，这是由于Java泛型机制决定的，没有更好的解决办法：

Gson gson = new Gson();
Collection ints = Lists.immutableList(1,2,3,4,5);

// Serialization
String json = gson.toJson(ints);  // ==> json is [1,2,3,4,5]

// Deserialization
Type collectionType = new TypeToken>(){}.getType();
Collection ints2 = gson.fromJson(json, collectionType);
// ==> ints2 和 ints 相同。

如果集合中存储的是任意类型的对象，Gson可以序列化它，但不能做反序列化，这是因为用户无法指明集合中每一个对象的类型。在反序列化时，集合必须是一个明确的类型。如果遵循良好的Java编程规范，这基本不会造成什么问题。

5.4 泛型的处理

泛型的处理和上面集合的处理类似，因为集合定义中使用的就是泛型。
当你调用toJson(obj)方法时，Gson使用obj.getClass()来获取类属性信息，来序列化它。类似的，通常你可以将MyClass.class对象传递给fromJson(json, MyClass.class)方法，来反序列化。如果对象不包含泛型，这种方法是可行的，但是，如果对象是一个泛型类型，由于Java的类型擦除(Type Erasure)机制，该泛型的信息会丢失，例如：

class Foo {
  T value;
}
Gson gson = new Gson();
Foo foo = new Foo();
gson.toJson(foo); // 可能无法正确序列化foo.value。

gson.fromJson(json, foo.getClass()); // 不会将 foo.value 正确反序列化成Bar对象

要解决这一问题，你需要指明你的泛型类型的类型参数(parameterized type)，使用集合的例子中看到过的TypeToken类：

Type fooType = new TypeToken>() {}.getType();
gson.toJson(foo, fooType);

gson.fromJson(json, fooType);

初步使用Gson时，可以不必深究这一泛型处理的实现原理，知道怎么做即可。