如何控制Go編碼JSON數據時的行為
- 2020 年 2 月 17 日
- 筆記
今天來聊一下我在Go中對數據進行 JSON 編碼時遇到次數最多的三個問題以及解決方法，大家來看看是不是也為這些問題撓掉了不少頭髮。
自定義JSON鍵名
這個問題加到文章里我是有所猶豫的，因為基本上大家都會，不過屬於同類問題我還是放進來了，對新接觸 Go 的同學更友好些。
我們先從最常見的一個問題說，首先在Go 程式中要將數據編碼成JSON 格式時通常我們會先定義結構體類型，將數據存放到結構體變數中。
type Address struct { Type string City string Country string } type CreditCard struct { FirstName string LastName string Addresses []*Address Remark string } home := &Address{"private", "Aartselaar", "Belgium"} office := &Address{"work", "Boom", "Belgium"} card := VCard{"Jan", "Kersschot", []*Address{home, office}, "none"} js, err := json.Marshal(card) fmt.Printf("JSON format: %s", js)
只有導出的結構體成員才會被編碼，這也就是我們為什麼選擇用大寫字母開頭的欄位名稱。在編碼時，默認使用結構體欄位的名字作為JSON對象中的 key，但是一般JSON 是給 HTTP介面返回數據使用的，在介面的規範里針對數據我們一般都要求返回 snakecase風格的欄位名。解決這個問題的方法是在結構體聲明時在結構體欄位標籤里可以自定義對應的 JSON key
所以我們把結構體聲明改為如下即可：
type Address struct { Type string `json:"type"` City string `json:"city"` Country string `json:"country"` }
編碼JSON時忽略掉指定欄位
並不是所有數據我們都期望編碼到 JSON中暴露給外部介面的，所以針對一些敏感的欄位我們往往希望將其從編碼後的 JSON數據中忽略掉。那麼上面也說了只有導出的結構體成員才會被編碼，有的同學會問我直接用小寫的欄位名不行嗎？可是為了未導出欄位只能在包內訪問，像這種攜帶內部敏感數據的往往都是應用的基礎數據，由項目的公共包來提供的。那麼怎麼技能維持欄位的導出性又能讓其在 JSON數據中被忽略掉呢? 還是使用結構體的標籤進行註解，比如下面定義的結構體，可以把身份證 IdCard欄位在 JSON數據中去掉：
type User struct { Name string `json:"name"` Age Int `json:"int"` IdCard string `json:"-"` }
encoding/json的源碼中和文檔中都列舉了通過結構體欄位標籤控制數據 JSON編碼行為的說明：
// 忽略欄位 Field int `json:"-"` // 自定義key Field int `json:"myName"` // 數據為空時忽略欄位 Field int `json:"myName,omitempty"`
omitempty這個是欄位的數據為空時，在 JSON中省略這個欄位。為的是節省數據空間， Protobuf編譯器生成的結構體程式碼中每個欄位標籤中都有 omitempty。但是在 Api開發中這個不常用，因為欄位不固定對前端很不友好。
對 Protobuf不了解的可以看我之前寫的文章《Protobuf語言指南》，另外子菜單的gRPC 欄目能找到更多相關文章。
結構體欄位標籤的 json註解中都不加 omitempty後還遇到一種情況，就是數據類型為切片的欄位在數據為空的時候會被 JSON編碼為 null而不是 []。這個前端經常會問我沒數據的時候能不能不要返回 null，沒回還要多寫一個判斷。我的說辭都是不能，其實規範點講是應該返回 []的知識我是我自己沒找到到解決方法。作為一個在寫程式碼上有強迫症的人，這個問題還是想搞明白的，好在有一天在 StackOverflow上看到一個答案，才發現是編碼的疏忽導致的。
解決空切片在JSON里被編碼成null
因為切片的零值為 nil，無指向記憶體的地址，所以當以這種形式定義 varf[]int初始化 slice後，在JSON中將其編碼為 null，如果想在 JSON 中將空 slice 編碼為 []則需用make初始化 slice為其分配記憶體地址：
運行下面的例子可以看出兩點的區別：
package main import ( "encoding/json" "fmt" ) type Person struct { Friends []string } func main() { var f1 []string f2 := make([]string, 0) json1, _ := json.Marshal(Person{f1}) json2, _ := json.Marshal(Person{f2}) fmt.Printf("%sn", json1) fmt.Printf("%sn", json2) }
輸出：
{"Friends":null} {"Friends":[]}
其實導致這個問題的原因是Go的 append函數（甩鍋），我們都知道引用類型的變數定義後如果沒初始化他們的值是 nil，無指向記憶體的地址，是無法直接使用的。但是 append函數在給切片追加元素時會判斷切片是否已初始化，沒有的話會幫其初始化分配底層數組。我的習慣是先聲明切片，然後再在下面的循環程式碼中向切片追加元素。但是如果循環沒有執行，比如你從資料庫沒查出數據，就會導致對應切片欄位在無數據時返回的是 nil然後被 JSON編碼成了 null。所以這個算是一個經驗總結出來的 Tip吧在寫程式碼時大家一定要注意了。
這就是我在開發時把數據編碼成 JSON格式時遇到的三個問題和相應的解決方法。。明天就要開始上班了，因為突發時間這個假期格外長多出了不少時間可以支配。為了不太頹這一周我的公眾號是日更，上班了重心就要回到工作上了，所以為了保證文章品質還是周更。
