Android Gson基本用法學習

Posted on by

Gson是谷歌官方推出的支持 JSON -- Java Object 相互轉換的 Java序列化/反序列化 庫，之前由於沒有用過，所以學習一下。

1. 導入Android Studio工程

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

2. 簡單的 Java Object 序列化/反序列化

序列化

假如有一個User類，擁有 name, email, age, isDeveloper 四個屬性，如下：

User userObject = new User(  
    "Norman", 
    "[email protected]", 
    26, 
    true
);

使用Gson將它序列化：

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

得到的結果如下：

{
	"isDeveloper":true,
	"name":"Norman",
	"age":26,
	"email":"[email protected]"
}

反序列化

先定義一段JSON字符串

String userJson = "{'isDeveloper':false,'name':'xiaoqiang','age':26,'email':'[email protected]'}";

Gson反序列化

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

debug一下，查看結果

反序列化成功！

3. 嵌套 Java Object 的序列化/反序列化

也就是說，一個類裡面還包含有其它類。比如User類裡面還有個用戶地址UserAddress類，JSON結構如下：

{
    "age": 26,
    "email": "[email protected]",
    "isDeveloper": true,
    "name": "chenrenxiang",

    "userAddress": {
        "city": "Magdeburg",
        "country": "Germany",
        "houseNumber": "42A",
        "street": "Main Street"
    }
}

那麼這種Java Object該如何序列化/反序列化呢？和上面一樣。也就是說和 2 裡面介紹的方法一樣

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

序列化

序列化和前面介紹的方法是一樣的

反序列化

那就有些不同瞭，不然也不用分開寫。

1 Array的反序列化

先假設有一個name數組，定義JSON格式如下：

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

然後使用Gson去反序列化它：

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

得到的nameArray如下：

其實這和 2 裡面介紹的反序列化方法仍然是一樣的。可以看到，Gson的反序列化都是調用 Gson.fromJson(...)方法，傳入JSON字符串，以及這段JSON字符串對應的Object類型。

2 List的反序列化

String userJson = "[{'isDeveloper':false,'name':'xiaoqiang','age':26,'email':'[email protected]'},{'isDeveloper':true,'name':'xiaoqiang123','age':27,'email':'[email protected]'}]";

Gson gson = new Gson();
Type userListType = new TypeToken<ArrayList<User>>(){}.getType();

List<User> userList = gson.fromJson(userJson, userListType);

對於List，反序列化時必須提供它的Type，通過Gson提供的TypeToken<T>.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);

debug一下，得到結果如下：

可見，當某個變量值為null時，Gson在序列化的時候直接把這個變量忽略瞭。

再來看下反序列化， 先定義一段JSON字符串，隻給它一個變量值name，用User類來反序列化它，看得到的結果會是什麼。

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

對於JSON字符串裡沒有的變量，Gson在反序列化時會給它一個默認值，int類型默認為0，bool類型默認為false，String類型默認為null。

有人不禁要問瞭，如果JSON字符串裡某個變量的值為null，反序列化後的結果會是什麼呢？我測試過瞭，和沒有的結果是一樣的。

7. 控制序列化/反序列化 的變量名稱

仍然以User對象為例，目前User對象裡有四個變量name， age， email， isDeveloper。假如，某一天，JSON字符串的變量名name變成瞭fullName，無需緊張，我們不用把User類裡的變量name改為fullName，然後把它的get和set方法都改瞭，然後把用到get/set方法的地方全改過來。隻需要用Gson提供的註解方法@SerializedName就行瞭，如下：

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

這樣雖然JSON字符串裡的變量名為fullName，但是反序列化後fullName的值會映射給name。同樣，把一個User對象序列化，變量name會自動轉換為fullName。

然而現實遠比想象中復雜，這個JSON有時候傳的是fullName，有時候傳的是name，這時該怎麼辦呢？ 不用擔心，@SerializedName 接受兩個參數，value 和 alternate ，顧名思義，alternate 是備選變量名，比如下面這段代碼：

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

如果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; // 隻參與序列化
}

使用這個方法，可以非常靈活地控制對象的某個/某些變量參不參與序列化/反序列化。

然而！ 要使用這個註解來控制序列化/反序列化，就不能使用默認的Gson對象，新建Gson對象的方法如下：

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

註意：使用以上方式構建的Gson，在序列化/反序列化對象時，會排除所有沒有添加@Expose註解的字段。

另一個選擇，transient關鍵字 ，使用這個關鍵字，可以直接讓變量不參與序列化/反序列化，如下：

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

當然，使用默認的Gson對象就可以。

以上所述是小編給大傢介紹的Android Gson基本用法，希望對大傢有所幫助。在此也非常感謝大傢對WalkonNet網站的支持！

推薦閱讀：