怎樣控制Go編碼JSON數(shù)據(jù)時的行為

小編給大家分享一下怎樣控制Go編碼JSON數(shù)據(jù)時的行為，相信大部分人都還不怎么了解，因此分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后大有收獲，下面讓我們一起去了解一下吧！

自定義JSON鍵名

這個問題加到文章里我是有所猶豫的，因為基本上大家都會，不過屬于同類問題我還是放進來了，對新接觸 Go 的同學更友好些。

我們先從最常見的一個問題說，首先在Go 程序中要將數(shù)據(jù)編碼成JSON 格式時通常我們會先定義結構體類型，將數(shù)據(jù)存放到結構體變量中。

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)

只有導出的結構體成員才會被編碼，這也就是我們?yōu)槭裁催x擇用大寫字母開頭的字段名稱。在編碼時，默認使用結構體字段的名字作為JSON對象中的 key ，但是一般JSON 是給 HTTP接口 返回數(shù)據(jù)使用的，在接口的規(guī)范里針對數(shù)據(jù)我們一般都要求返回 snake case 風格的字段名。解決這個問題的方法是在結構體聲明時在結構體字段標簽里可以自定義對應的 JSON key

所以我們把結構體聲明改為如下即可：

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

編碼JSON時忽略掉指定字段

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

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

encoding/json 的源碼中和文檔中都列舉了通過結構體字段標簽控制數(shù)據(jù) JSON 編碼行為的說明：

// 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 這個是字段的數(shù)據(jù)為空時，在 JSON 中省略這個字段。為的是節(jié)省數(shù)據(jù)空間， Protobuf 編譯器生成的結構體代碼中每個字段標簽中都有 omitempty 。但是在 Api 開發(fā)中這個不常用，因為字段不固定對前端很不友好。

對 Protobuf 不了解的可以看我之前寫的文章《 Protobuf語言指南 》。

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

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

因為切片的零值為 nil ，無指向內存的地址，所以當以這種形式定義 var f []int 初始化 slice 后，在JSON中將其編碼為 null ，如果想在 JSON 中將空 slice 編碼為 [] 則需用make初始化 slice為其分配內存地址：

運行下面的例子可以看出兩點的區(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":[]
}

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

這就是我在開發(fā)時把數(shù)據(jù)編碼成 JSON 格式時遇到的三個問題和相應的解決方法。加上之前寫的 解析JSON的文章 ，兩個文章加起來差不多就能匯總日常開發(fā)中關于 encoding/json 庫使用的各種問題了。

以上是“怎樣控制Go編碼JSON數(shù)據(jù)時的行為”這篇文章的所有內容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內容對大家有所幫助，如果還想學習更多知識，歡迎關注億速云行業(yè)資訊頻道！