• 從一個 Bug 說起
• 重現一下那個 Bug
• 重新認識一下 Gson
• 總結一下

---

從一個 Bug 說起

不知道你們發現沒有，你寫完的程式無論當時怎麼測試，過一段時間總會出 Bug 。再說一個每天都在發生的例子：在你寫完一篇部落格後，立即檢查的話，總是查不出自己寫的錯別字。

據說這些都包含有一些大腦對當下事物處理的邏輯在裡邊，而且還有心理學因素在裡邊，我也不懂。反正現在就是程式出 Bug 了！出 Bug 了！！Bug ！！！

事情是這樣的，客戶端請求伺服器開放介面時，我們是以 JSON 字串的形式傳回的，這時候本來正常傳回形式是這樣：

{
   "name": "mafly",
   "age": "18",
   "sex": "男"
}

但這個名字叫Mafly的人他不想讓你知道他是男是女。就沒填性別，程式中預設賦值為 null了，JSON 序列化時就發生了意想不到的事兒。

重現一下那個 Bug

用於轉換Java物件為 Json 字串和把 Json 字串轉換為物件的工具類有很多，Gson、Jackson、FastJson等，我們用的是 Gson， 它是 Google 開發的，還據傳說它的效能比較強大一些。嗯，對，我們用的就是這個。先看示例程式碼：

public static void main(String[] args) {

   HashMap map = new HashMap();
   map.put("name", "mafly");
   map.put("age", "18");
   map.put("sex", null);

   String jsonString = new Gson().toJson(map);
   System.err.println(jsonString);
}

你猜會輸出上面那段我們預期的 Json 串嗎？然而並不會。

就是這個當 Sex=null時，用 Gson 的tojson方法會把 null 值忽略，從而序列化之後輸出不包含這個屬性值的 Json 串。其實我們的預期是輸出 {“sex”: “”} 或 {“sex”: null}， 那怎麼做呢？

透過搜尋引擎發現，網上大概存在以下三種解決方案：

• 呼叫 toJson(Object src, Type typeOfSrc, JsonWriter writer) 方法
• 註冊自定義 TypeAdapter
• 設定 serializeNulls 屬性值（推薦)

前兩種方式我沒測試，推薦第三種方式，簡單方便，原始碼如下：

GsonBuilder gsonBuilder = new GsonBuilder();
String jsonString1 = gsonBuilder.serializeNulls().create().toJson(map);
System.err.println(jsonString1);

輸出符合我們的需求了， {“sex”: null}，如圖：

簡單轉到原始碼看了看，除了這一個設定還有很多，真是太方便了。呼叫serializeNulls()後， Gson 設定 serializeNulls 屬性值為 true，預設是false，原始碼:

public GsonBuilder serializeNulls() {
   this.serializeNulls = true;
   return this;
}

重新認識一下 Gson

我看了幾行 Gson 的原始碼後，我發現它可配置及特性多的數不勝數，可以用@SerializedName註解給屬性重新命名，用@Expose註解標識屬性不進行序列化，支援 Map 的 key 為複雜物件的形式，日期型別轉化為特定格式，還有區分版本進行顯示，這些在日常專案中都極常用到，只不過好像我們之前都是自己實現的。

我簡單建立了一個 UserInfo 物體類，裡邊包含了username、age、sex這三個屬性值。試著測試了一下其中一兩個：

1.@Expose 想讓誰輸出誰輸出，註解程式碼如圖：

設定excludeFieldsWithoutExposeAnnotation()，看下麵第三行是輸出：

2.@SerializedName 想怎麼顯示怎麼顯示，註解程式碼如圖：

我想把age再 Json序列化時顯示maflyAge，現在就可以了，輸出如下圖：

3.@Since、@Until 不同版本不同資料，註解程式碼如圖：

這裡要設定setVersion(3.2)，@Since標註的在 3.2 版本或之後才會輸出，@Until標註的只在 3.2 版本前才有。效果輸出如下圖：

當然，還有好多特性呢，比如欄位首字母大寫阿、結果格式化阿等等，我這裡拋個磚，剩下的有需要的可以試試。

總結一下

這是由於一個 Json 序列化輸出後發現的小 Bug ，也可以說不能算 Bug ，因為是我們對於自己使用的工具類並不瞭解導致的，所以，去試著瞭解你使用的任何一個開源工具類或專案，對於遇到的問題可以很好的得到解決，從而也可以提升自己吧。