Golang中omitempty關鍵字的具體實現(xiàn)
用法
熟悉 Golang 的朋友對于 json 和 struct 之間的轉換一定不陌生，為了將代碼中的結構體與 json 數(shù)據解耦，通常我們會在結構體的 field 類型后加上解釋說明，例如在表示一個地址的時候， json 數(shù)據如下所示
{
"street": "200 Larkin St",
"city": "San Francisco",
"state": "CA",
"zipcode": "94102"
}
與之相對應的 Golang 結構體表示可能是這個樣子的
type address struct {
Street string `json:"street"` // 街道
Ste string `json:"suite"` // 單元（可以不存在）
City string `json:"city"` // 城市
State string `json:"state"` // 州/省
Zipcode string `json:"zipcode"` // 郵編
}
這樣無論代碼中的變量如何改變，我們都能成功將 json 數(shù)據解析出來，獲得正確的街道，城市等信息，到目前為止一切正常。但如果我們想要將地址結構體恢復成 json 格式時，問題就來了。比方說我們用下面這段代碼讀取了地址 json ，然后根據業(yè)務邏輯處理了之后恢復成正常的 json 打印出來
func main() {
? ? ? ? data := `{
? ? ? ? "street": "200 Larkin St",
? ? ? ? "city": "San Francisco",
? ? ? ? "state": "CA",
? ? ? ? "zipcode": "94102"
? ? }`
? ? addr := new(address)
? ? json.Unmarshal([]byte(data), &addr)
? ? ? ? // 處理了一番 addr 變量...
? ? addressBytes, _ := json.MarshalIndent(addr, "", " ? ?")
? ? fmt.Printf("%s\n", string(addressBytes))
}這段代碼的輸出是
{
"street": "200 Larkin St",
"suite": "",
"city": "San Francisco",
"state": "CA",
"zipcode": "94102"
}
多了一行 "suite": "", ，而這則信息在原本的 json 數(shù)據中是沒有的（在美國的地址中，如果不是群租公寓或者共享辦公樓， suite 這一條不存在很正常，人們直接用街道門牌號來表示地址就足夠了），但我們更希望的是，在一個地址有 suite 號碼的時候輸出，不存在 suite 的時候就不輸出，幸運的是，我們可以在 Golang 的結構體定義中添加 omitempty 關鍵字，來表示這條信息如果沒有提供，在序列化成 json 的時候就不要包含其默認值。稍作修改，地址結構體就變成了
type address struct {
Street string `json:"street"`
Ste string `json:"suite,omitempty"`
City string `json:"city"`
State string `json:"state"`
Zipcode string `json:"zipcode"`
}
重新運行，即可得到正確的結果。
陷阱
帶來方便的同時，使用 omitempty 也有些小陷阱，一個是該關鍵字無法忽略掉嵌套結構體。還是拿地址類型說事，這回我們想要往地址結構體中加一個新 field 來表示經緯度，如果沒有缺乏相關的數(shù)據，暫時可以忽略。新的 struct 定義如下所示
type address struct {
? ? Street ? ? string ? ? `json:"street"`
? ? Ste ? ? ? ?string ? ? `json:"suite,omitempty"`
? ? City ? ? ? string ? ? `json:"city"`
? ? State ? ? ?string ? ? `json:"state"`
? ? Zipcode ? ?string ? ? `json:"zipcode"`
? ? Coordinate coordinate `json:"coordinate,omitempty"`
}
type coordinate struct {
? ? Lat float64 `json:"latitude"`
? ? Lng float64 `json:"longitude"`
}讀入原來的地址數(shù)據，處理后序列化輸出，我們就會發(fā)現(xiàn)即使加上了 omitempty 關鍵字，輸出的 json 還是帶上了一個空的坐標信息
{
"street": "200 Larkin St",
"city": "San Francisco",
"state": "CA",
"zipcode": "94102",
"coordinate": {
"latitude": 0,
"longitude": 0
}
}
為了達到我們想要的效果，可以把坐標定義為指針類型，這樣 Golang 就能知道一個指針的“空值”是多少了，否則面對一個我們自定義的結構， Golang 是猜不出我們想要的空值的。于是有了如下的結構體定義
type address struct {
? ? Street ? ? string ? ? ?`json:"street"`
? ? Ste ? ? ? ?string ? ? ?`json:"suite,omitempty"`
? ? City ? ? ? string ? ? ?`json:"city"`
? ? State ? ? ?string ? ? ?`json:"state"`
? ? Zipcode ? ?string ? ? ?`json:"zipcode"`
? ? Coordinate *coordinate `json:"coordinate,omitempty"`
}
type coordinate struct {
? ? Lat float64 `json:"latitude"`
? ? Lng float64 `json:"longitude"`
}相應的輸出為
{
"street": "200 Larkin St",
"city": "San Francisco",
"state": "CA",
"zipcode": "94102"
}
另一個“陷阱”是，對于用 omitempty 定義的 field ，如果給它賦的值恰好等于默認空值的話，在轉為 json 之后也不會輸出這個 field 。比如說上面定義的經緯度坐標結構體，如果我們將經緯度兩個 field 都加上 omitempty
type coordinate struct {
Lat float64 `json:"latitude,omitempty"`
Lng float64 `json:"longitude,omitempty"`
}
然后我們對非洲幾內亞灣的“原點坐標”非常感興趣，于是編寫了如下代碼
func main() {
? ? cData := `{
? ? ? ? "latitude": 0.0,
? ? ? ? "longitude": 0.0
? ? }`
? ? c := new(coordinate)
? ? json.Unmarshal([]byte(cData), &c)
? ? ? ? // 具體處理邏輯...
? ? coordinateBytes, _ := json.MarshalIndent(c, "", " ? ?")
? ? fmt.Printf("%s\n", string(coordinateBytes))
}最終我們得到了一個
{}
這個坐標消失不見了！但我們的設想是，如果一個地點沒有經緯度信息，則懸空，這沒有問題，但對于“原點坐標”，我們在確切知道它的經緯度的情況下，（0.0, 0.0）仍然被忽略了。正確的寫法也是將結構體內的定義改為指針
type coordinate struct {
? ? Lat *float64 `json:"latitude,omitempty"`
? ? Lng *float64 `json:"longitude,omitempty"`
}這樣空值就從 float64 的 0.0 變?yōu)榱酥羔橆愋偷?nil ，我們就能看到正確的經緯度輸出。
{
"latitude": 0,
"longitude": 0
}
P.S. 本文中拿來作示例的地址是舊金山亞洲藝術博物館的地址，藏品豐富，上到夏商周，下至明清的文物都能看到，幾年前第一次去參觀，很是喜歡，印象深刻。
到此這篇關于Golang中omitempty關鍵字的具體實現(xiàn)的文章就介紹到這了,更多相關Golang omitempty 內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
這篇文章主要為大家介紹了go語言中布隆過濾器低空間成本判斷元素是否存在方式詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-09-09
作為一名開發(fā)者,確保Go應用中處理的數(shù)據是有效和準確的非常重要,Go Validator是一個開源的數(shù)據驗證庫,為Go結構體提供強大且易于使用的數(shù)據驗證功能,本篇文章將介紹Go Validator庫的主要特點以及如何在Go應用中使用它來有效驗證數(shù)據2023-12-12
我們在進行灰度發(fā)布時,往往需要轉發(fā)一部分流量到新上線的服務上,進行小規(guī)模的驗證,隨著功能的不斷完善,我們也會逐漸增加轉發(fā)的流量,這就需要按比例去切分流量,那么如何實現(xiàn)流量切分呢,接下來小編就給大家詳細的介紹一下實現(xiàn)方法,需要的朋友可以參考下2023-09-09
JWT,全稱 JSON Web Token,是一種開放標準（RFC 7519）,用于安全地在雙方之間傳遞信息,這篇文章主要介紹了golang 在Gin框架中使用JWT鑒權,需要的朋友可以參考下2024-07-07
切片(Slice)是一個擁有相同類型元素的可變長度的序列,下面這篇文章主要給大家介紹了關于如何用Go判斷元素是否在切片中的相關資料,文中通過實例代碼介紹的非常詳細,需要的朋友可以參考下2022-06-06
這篇文章主要介紹Go語言之fo循環(huán)與條件判斷，for 循環(huán)是一個循環(huán)控制結構，可以執(zhí)行指定次數(shù)的循環(huán)。下面文章我們結合條件判斷,感興趣的朋友可以參考一下2021-10-10
這篇文章主要為大家介紹了如何優(yōu)雅的管理Go?Project生命周期，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2023-03-03
這篇文章主要介紹了Go語言編程中字符串切割方法小結,所整理的方法都來自字符串相關的strings包,需要的朋友可以參考下2015-10-10
學習Go語言的過程中，遇到素數(shù)篩選的問題。這是一個經典的并發(fā)編程問題，是某大佬的代碼，短短幾行代碼就實現(xiàn)了素數(shù)篩選，這篇文章主要介紹了Go素數(shù)篩選分析,需要的朋友可以參考下2022-10-10
本篇是Go語言七篇入門系列第一篇Go語言初識及簡單介紹，從現(xiàn)在開始一起打開Go語言的學習大門吧，希望能夠有所幫助，祝大家多多進步2021-11-11