在之前文章中，我們學習了使用 Gson 序列化和反序列化 Java 物件，到目前為止，我們總結了對映的過程。這篇文章開始我們將開始一個新的系列 GsonBuider,GsonBuider 用來自定義Gson。

 GsonBuider 基礎

在之前的文章中，我們經常使用這樣來生成一個 Gson 物件，Gson gson = new Gson();  這是標準的Gson生成方式，不過 Gson 提供了擴充套件，如果你有一些特殊的需求，你可以使用 GsonBuider 來自定義 Gson。

// previously
Gson gson = new Gson();

// now using GsonBuilder
GsonBuilder gsonBuilder = new GsonBuilder();
Gson gson = gsonBuilder.create();
 

使用 GsonBuilder.create() 方法就可以建立一個 Gson 例項，有了它就可以解析各種資料型別了。

命名規則

首先要介紹下 GsonBuilder 中命名規則，我們一直認為 Java model 中欄位名和 JSON 中欄位名應該保持一致，但是我們可以通過 @SerializedName 來幫我們解決這種欄位不一致的問題。

使用 @SerializedName 解決是一種方式，但是 Gson 也提供了一種自定義方式，使用 FieldNamingPolicy，我們根據例子來說明。

public class UserNaming {
   String Name;
   String email_of_developer;
   boolean isDeveloper;
   int _ageOfDeveloper;
}
 

可以看到，我們給不同型別的變數命名了不同的規則的欄位名，這樣做主要是為了之後自定義設定。

GsonBuilder gsonBuilder = new GsonBuilder();
gsonBuilder.setFieldNamingPolicy(FieldNamingPolicy.IDENTITY);
Gson gson = gsonBuilder.create();

先不用理解 FieldNamingPolicy.IDENTITY,這段程式碼的意思是，我們的 Gson 使用了 FieldNamingPolicy.IDENTITY 的自定義設定，接下來的幾個例子我們將介紹 FieldNamingPolicy 中的其他屬性。

 FieldNamingPolicy.IDENTITY

FieldNamingPolicy.IDENTITY 的作用是，完全匹配我們 Java model 中的欄位名，不管你有沒有設定其他註解屬性，我們使用以下程式碼來生成一段 JSON 資料：

GsonBuilder gsonBuilder = new GsonBuilder();
gsonBuilder.setFieldNamingPolicy(FieldNamingPolicy.IDENTITY);
Gson gson = gsonBuilder.create();

UserNaming user = new UserNaming("Norman", "[email protected]", true, 26);
String usersJson = gson.toJson(user);

輸出：

{
    "Name": "Norman",
    "_ageOfDeveloper": 26,
    "email_of_developer": "[email protected]",
    "isDeveloper": true
}

可以看到欄位名就是我們 model 中的欄位名，沒有發生改變，如果你使用預設生成例項或者不使用 GsonBuilder 自定義生成，最後都會得到相同的結果。

FieldNamingPolicy - LOWER_CASE_WITH_UNDERSCORES

GsonBuilder gsonBuilder = new GsonBuilder();
gsonBuilder.setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES);
Gson gson = gsonBuilder.create();

UserNaming user = new UserNaming("Norman", "[email protected]", true, 26);

String usersJson = gson.toJson(user);

使用 FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES 規則，將修改生成的 JSON 中的欄位名，格式將全部變成小寫，並且每個單詞用“_” 分割，輸出如下：

{
    "name": "Norman",
    "_age_of_developer": 26,
    "email_of_developer": "[email protected]",
    "is_developer": true
}

這個很容易理解，我們可以通過看原始碼來發現：

LOWER_CASE_WITH_UNDERSCORES() {  
      public String translateName(Field f) {  
             return separateCamelCase(f.getName(), "_").toLowerCase();  
      }
}

 ## FieldNamingPolicy - LOWER_CASE_WITH_DASHES

有了上面的理解，這個就很好理解了，除了每個單詞用“-” 分隔意外其他和
FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES 都一樣

GsonBuilder gsonBuilder = new GsonBuilder();
gsonBuilder.setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_DASHES);
Gson gson = gsonBuilder.create();

UserNaming user = new UserNaming("Norman", "[email protected]", true, 26);
String usersJson = gson.toJson(user);

輸出：

{
    "name": "Norman",
    "_age-of-developer": 26,
    "email_of_developer": "[email protected]",
    "is-developer": true
}

FieldNamingPolicy - UPPER_CAMEL_CASE

這個就更簡單了，規則是每個單詞的第一個字母都要大寫，其他不變

GsonBuilder gsonBuilder = new GsonBuilder();
gsonBuilder.setFieldNamingPolicy(FieldNamingPolicy.UPPER_CAMEL_CASE);
Gson gson = gsonBuilder.create();

UserNaming user = new UserNaming("Norman", "[email protected]", true, 26);
String usersJson = gson.toJson(user);

輸出

 {
    "Name": "Norman",
    "_AgeOfDeveloper": 26,
    "Email_of_developer": "[email protected]",
     "IsDeveloper": true
}

看結果就可以發現，採用了駝峰命名規則，_AgeOfDeveloper 看起來比較特殊，但它是正確的命名方法。

FieldNamingPolicy - UPPER_CAMEL_CASE_WITH_SPACES

規則如下：

1、每個單詞的第一個字母會大寫
2、每個單詞使用空格分隔

含有 “_” 的連結的不會在使用空格。

GsonBuilder gsonBuilder = new GsonBuilder();
gsonBuilder.setFieldNamingPolicy(FieldNamingPolicy.UPPER_CAMEL_CASE_WITH_SPACES);
Gson gson = gsonBuilder.create();

UserNaming user = new UserNaming("Norman", "[email protected]", true, 26);
String usersJson = gson.toJson(user);

輸出：

{
    "Name": "Norman",
    "_Age Of Developer": 26,
    "Email_of_developer": "[email protected]",
    "Is Developer": true
}

@SerializedName 混用

關於 @SerializedName 的用法，我們在之前的文章中已經介紹過了

public class UserNaming {
    String Name;

    @SerializedName("emailOfDeveloper")
    String email_of_developer;

    boolean isDeveloper;
    int _ageOfDeveloper;
}

看上面的例子，我們使用了 @SerializedName ，如果我們在使用 UPPER_CAMEL_CASE 規則，將會發生什麼？

執行看下結果：

{
    "Name": "Norman",
    "_AgeOfDeveloper": 26,
    "emailOfDeveloper": "[email protected]",
    "IsDeveloper": true
}

你會發現出了 emailOfDeveloper 其他的欄位每個單詞的首字母都大寫了，說明最後以 @SerializedName 為準。

自定義規則

@SerializedName 可能不能滿足你的需求規則，我們將使用 GsonBuilder的 setFieldNamingStrategy 方法 ，FieldNamingStrategy 自定義規則。例如：

FieldNamingStrategy customPolicy = new FieldNamingStrategy() {
    @Override
        public String translateName(Field f) {
            return f.getName().replace("_", "");
      }
};

GsonBuilder gsonBuilder = new GsonBuilder();
gsonBuilder.setFieldNamingStrategy(customPolicy);
Gson gson = gsonBuilder.create();

UserNaming user = new UserNaming("Norman", "[email protected]", true, 26);
String usersJson = gson.toJson(user);

輸出：

{
    "Name": "Norman",
    "ageOfDeveloper": 26,
    "emailOfDeveloper": "[email protected]",
    "isDeveloper": true
}

上面將會把 “_” 剔除，需要注意的是一次只能有一個規則，如果使用多個規則，將以最後一個為準。

反序列化

以上都是關於序列化的操作，統一以上的規則也使用於 JSON 的反序列化操作，如果你的伺服器返回的 JSON 欄位是以小寫和下劃線作為規則的話，就可以使用 LOWER_CASE_WITH_UNDERSCORES
規則來匹配欄位名稱。

例如：

{
    "reviewer_name": "Marcus"
}

可以這樣定義 Java model 類：

public class PostReviewer {
      String reviewerName;//不用分隔線，採用駝峰命名
}

目標

瞭解 GsonBuilder 的基本使用，根據不同需求進行自定義 GsonBuilder 規則。

下一篇將繼續介紹有關 GsonBuilder 的操作。

Gson 系列文章翻譯回顧