如何控制Go編碼JSON數(shù)據(jù)時(shí)的行為(問(wèn)題及解決方案)

今天來(lái)聊一下我在Go中對(duì)數(shù)據(jù)進(jìn)行 JSON 編碼時(shí)遇到次數(shù)最多的三個(gè)問(wèn)題以及解決方法，大家來(lái)看看是不是也為這些問(wèn)題撓掉了不少頭發(fā)。

自定義JSON鍵名

這個(gè)問(wèn)題加到文章里我是有所猶豫的，因?yàn)榛旧洗蠹叶紩?huì)，不過(guò)屬于同類問(wèn)題我還是放進(jìn)來(lái)了，對(duì)新接觸 Go 的同學(xué)更友好些。

我們先從最常見(jiàn)的一個(gè)問(wèn)題說(shuō)，首先在Go 程序中要將數(shù)據(jù)編碼成JSON 格式時(shí)通常我們會(huì)先定義結(jié)構(gòu)體類型，將數(shù)據(jù)存放到結(jié)構(gòu)體變量中。

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)

只有導(dǎo)出的結(jié)構(gòu)體成員才會(huì)被編碼，這也就是我們?yōu)槭裁催x擇用大寫(xiě)字母開(kāi)頭的字段名稱。在編碼時(shí)，默認(rèn)使用結(jié)構(gòu)體字段的名字作為JSON對(duì)象中的 key ，但是一般JSON 是給 HTTP接口 返回?cái)?shù)據(jù)使用的，在接口的規(guī)范里針對(duì)數(shù)據(jù)我們一般都要求返回 snake case 風(fēng)格的字段名。解決這個(gè)問(wèn)題的方法是在結(jié)構(gòu)體聲明時(shí)在結(jié)構(gòu)體字段標(biāo)簽里可以自定義對(duì)應(yīng)的 JSON key

所以我們把結(jié)構(gòu)體聲明改為如下即可：

type Address struct {
 Type string `json:"type"`
 City string `json:"city"`
 Country string `json:"country"`
}

編碼JSON時(shí)忽略掉指定字段

并不是所有數(shù)據(jù)我們都期望編碼到 JSON 中暴露給外部接口的，所以針對(duì)一些敏感的字段我們往往希望將其從編碼后的 JSON 數(shù)據(jù)中忽略掉。那么上面也說(shuō)了只有導(dǎo)出的結(jié)構(gòu)體成員才會(huì)被編碼，有的同學(xué)會(huì)問(wèn)我直接用小寫(xiě)的字段名不行嗎？可是未導(dǎo)出字段只能在包內(nèi)訪問(wèn)，像這種攜帶內(nèi)部敏感數(shù)據(jù)的往往都是應(yīng)用的基礎(chǔ)數(shù)據(jù)，由項(xiàng)目的公共包來(lái)提供的。那么怎么既能維持字段的導(dǎo)出性又能讓其在 JSON 數(shù)據(jù)中被忽略掉呢? 還是使用結(jié)構(gòu)體的標(biāo)簽進(jìn)行注解，比如下面定義的結(jié)構(gòu)體，可以把身份證 IdCard 字段在 JSON 數(shù)據(jù)中去掉：

type User struct {
 Name string `json:"name"`
 Age  Int  `json:"int"`
 IdCard string `json:"-"`
}

encoding/json 的源碼中和文檔中都列舉了通過(guò)結(jié)構(gòu)體字段標(biāo)簽控制數(shù)據(jù) JSON 編碼行為的說(shuō)明：

// Field is ignored by this package.
Field int `json:"-"`

// Field appears in JSON as key "myName".
Field int `json:"myName"`

// Field appears in JSON as key "myName" and
// the field is omitted from the object if its value is empty,
// as defined above.
Field int `json:"myName,omitempty"`

// Field appears in JSON as key "Field" (the default), but
// the field is skipped if empty.
// Note the leading comma.
Field int `json:",omitempty"`

omitempty 這個(gè)是字段的數(shù)據(jù)為空時(shí)，在 JSON 中省略這個(gè)字段。為的是節(jié)省數(shù)據(jù)空間， Protobuf 編譯器生成的結(jié)構(gòu)體代碼中每個(gè)字段標(biāo)簽中都有 omitempty 。但是在 Api 開(kāi)發(fā)中這個(gè)不常用，因?yàn)樽侄尾还潭▽?duì)前端很不友好。

對(duì) Protobuf 不了解的可以看我之前寫(xiě)的文章《 Protobuf語(yǔ)言指南 》。

結(jié)構(gòu)體字段標(biāo)簽的 json 注解中都不加 omitempty 后還遇到一種情況，就是數(shù)據(jù)類型為切片的字段在數(shù)據(jù)為空的時(shí)候會(huì)被 JSON 編碼為 null 而不是 [] 。這個(gè)前端經(jīng)常會(huì)問(wèn)我沒(méi)數(shù)據(jù)的時(shí)候能不能不要返回 null ，每回還要多寫(xiě)一個(gè)判斷。我的說(shuō)辭都是不能，其實(shí)規(guī)范點(diǎn)講是應(yīng)該返回 [] 的知識(shí)我是我自己沒(méi)找到到解決方法。作為一個(gè)在寫(xiě)代碼上有強(qiáng)迫癥的人，這個(gè)問(wèn)題還是想搞明白的，好在有一天在 StackOverflow 上看到一個(gè)答案，才發(fā)現(xiàn)是編碼的疏忽導(dǎo)致的。

解決空切片在JSON里被編碼成null

因?yàn)榍衅牧阒禐?nil ，無(wú)指向內(nèi)存的地址，所以當(dāng)以這種形式定義 var f []int 初始化 slice 后，在JSON中將其編碼為 null ，如果想在 JSON 中將空 slice 編碼為 [] 則需用make初始化 slice為其分配內(nèi)存地址：

運(yùn)行下面的例子可以看出兩點(diǎn)的區(qū)別：

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("%s\n", json1)
 fmt.Printf("%s\n", json2)
}

輸出：

{"Friends":null
}
{"Friends":[]
}

其實(shí)導(dǎo)致這個(gè)問(wèn)題的原因是Go的 append 函數(shù)（甩鍋），我們都知道引用類型的變量定義后如果沒(méi)初始化他們的值是 nil ，無(wú)指向內(nèi)存的地址，是無(wú)法直接使用的。但是 append 函數(shù)在給切片追加元素時(shí)會(huì)判斷切片是否已初始化，沒(méi)有的話會(huì)幫其初始化分配底層數(shù)組。我的習(xí)慣是先聲明切片，然后再在下面的循環(huán)代碼中向切片追加元素。但是如果循環(huán)沒(méi)有執(zhí)行，比如你從數(shù)據(jù)庫(kù)沒(méi)查出數(shù)據(jù)，就會(huì)導(dǎo)致對(duì)應(yīng)切片字段在無(wú)數(shù)據(jù)時(shí)返回的是 nil 然后被 JSON 編碼成了 null 。所以這個(gè)算是一個(gè)經(jīng)驗(yàn)總結(jié)出來(lái)的 Tip 吧在寫(xiě)代碼時(shí)大家一定要注意了。

這就是我在開(kāi)發(fā)時(shí)把數(shù)據(jù)編碼成 JSON 格式時(shí)遇到的三個(gè)問(wèn)題和相應(yīng)的解決方法。加上之前寫(xiě)的 解析JSON的文章 ，兩個(gè)文章加起來(lái)差不多就能匯總?cè)粘ｉ_(kāi)發(fā)中關(guān)于 encoding/json 庫(kù)使用的各種問(wèn)題了。

總結(jié)

以上所述是小編給大家介紹的如何控制Go編碼JSON數(shù)據(jù)時(shí)的行為，希望對(duì)大家有所幫助！