快捷導(dǎo)航

Golang中使用JSON的一些小技巧分享

更新時(shí)間：2017年06月22日 08:46:01 投稿：daisy

這篇文章主要分享了Golang中使用JSON的一些小技巧，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面來(lái)一起看看吧。

前言

有的時(shí)候上游傳過(guò)來(lái)的字段是string類(lèi)型的，但是我們卻想用變成數(shù)字來(lái)使用。本來(lái)用一個(gè)json:",string" 就可以支持了，如果不知道golang的這些小技巧，就要大費(fèi)周章了。

參考文章： JSON and struct composition in Go

臨時(shí)忽略struct字段

type User struct {
 Email string `json:"email"`
 Password string `json:"password"`
 // many more fields…
}

臨時(shí)忽略掉Password字段

json.Marshal(struct {
 *User
 Password bool `json:"password,omitempty"`
}{
 User: user,
})

臨時(shí)添加額外的字段

type User struct {
 Email string `json:"email"`
 Password string `json:"password"`
 // many more fields…
}

臨時(shí)忽略掉Password字段，并且添加token字段

json.Marshal(struct {
 *User
 Token string `json:"token"`
 Password bool `json:"password,omitempty"`
}{
 User: user,
 Token: token,
})

臨時(shí)粘合兩個(gè)struct

type BlogPost struct {
 URL string `json:"url"`
 Title string `json:"title"`
}

type Analytics struct {
 Visitors int `json:"visitors"`
 PageViews int `json:"page_views"`
}

json.Marshal(struct{
 *BlogPost
 *Analytics
}{post, analytics})

一個(gè)json切分成兩個(gè)struct

json.Unmarshal([]byte(`{
 "url": "attila@attilaolah.eu",
 "title": "Attila's Blog",
 "visitors": 6,
 "page_views": 14
}`), &struct {
 *BlogPost
 *Analytics
}{&post, &analytics})

臨時(shí)改名struct的字段

type CacheItem struct {
 Key string `json:"key"`
 MaxAge int `json:"cacheAge"`
 Value Value `json:"cacheValue"`
}

json.Marshal(struct{
 *CacheItem

 // Omit bad keys
 OmitMaxAge omit `json:"cacheAge,omitempty"`
 OmitValue omit `json:"cacheValue,omitempty"`

 // Add nice keys
 MaxAge int `json:"max_age"`
 Value *Value `json:"value"`
}{
 CacheItem: item,

 // Set the int by value:
 MaxAge: item.MaxAge,

 // Set the nested struct by reference, avoid making a copy:
 Value: &item.Value,
})

用字符串傳遞數(shù)字

type TestObject struct {
 Field1 int `json:",string"`
}

這個(gè)對(duì)應(yīng)的json是 {"Field1": "100"}

如果json是 {"Field1": 100} 則會(huì)報(bào)錯(cuò)

容忍字符串和數(shù)字互轉(zhuǎn)

如果你使用的是jsoniter，可以啟動(dòng)模糊模式來(lái)支持 PHP 傳遞過(guò)來(lái)的 JSON。

import "github.com/json-iterator/go/extra"

extra.RegisterFuzzyDecoders()

這樣就可以處理字符串和數(shù)字類(lèi)型不對(duì)的問(wèn)題了。比如

var val string
jsoniter.UnmarshalFromString(`100`, &val)

又比如

var val float32
jsoniter.UnmarshalFromString(`"1.23"`, &val)

容忍空數(shù)組作為對(duì)象

PHP另外一個(gè)令人崩潰的地方是，如果 PHP array是空的時(shí)候，序列化出來(lái)是[]。但是不為空的時(shí)候，序列化出來(lái)的是{"key":"value"} 。我們需要把 [] 當(dāng)成 {} 處理。

如果你使用的是jsoniter，可以啟動(dòng)模糊模式來(lái)支持 PHP 傳遞過(guò)來(lái)的 JSON。

import "github.com/json-iterator/go/extra"

extra.RegisterFuzzyDecoders()

這樣就可以支持了

var val map[string]interface{}
jsoniter.UnmarshalFromString(`[]`, &val)

使用 MarshalJSON支持time.Time

golang 默認(rèn)會(huì)把 time.Time 用字符串方式序列化。如果我們想用其他方式表示 time.Time，需要自定義類(lèi)型并定義 MarshalJSON。

type timeImplementedMarshaler time.Time

func (obj timeImplementedMarshaler) MarshalJSON() ([]byte, error) {
 seconds := time.Time(obj).Unix()
 return []byte(strconv.FormatInt(seconds, 10)), nil
}

序列化的時(shí)候會(huì)調(diào)用 MarshalJSON

type TestObject struct {
 Field timeImplementedMarshaler
}
should := require.New(t)
val := timeImplementedMarshaler(time.Unix(123, 0))
obj := TestObject{val}
bytes, err := jsoniter.Marshal(obj)
should.Nil(err)
should.Equal(`{"Field":123}`, string(bytes))

使用 RegisterTypeEncoder支持time.Time

jsoniter 能夠?qū)Σ皇悄愣x的type自定義JSON編解碼方式。比如對(duì)于 time.Time 可以用 epoch int64 來(lái)序列化

import "github.com/json-iterator/go/extra"

extra.RegisterTimeAsInt64Codec(time.Microsecond)
output, err := jsoniter.Marshal(time.Unix(1, 1002))
should.Equal("1000001", string(output))

如果要自定義的話(huà)，參見(jiàn) RegisterTimeAsInt64Codec 的實(shí)現(xiàn)代碼

使用 MarshalText支持非字符串作為key的map

雖然 JSON 標(biāo)準(zhǔn)里只支持 string 作為 key 的 map。但是 golang 通過(guò) MarshalText() 接口，使得其他類(lèi)型也可以作為 map 的 key。例如

f, _, _ := big.ParseFloat("1", 10, 64, big.ToZero)
val := map[*big.Float]string{f: "2"}
str, err := MarshalToString(val)
should.Equal(`{"1":"2"}`, str)

其中 big.Float 就實(shí)現(xiàn)了 MarshalText()

使用 json.RawMessage

如果部分json文檔沒(méi)有標(biāo)準(zhǔn)格式，我們可以把原始的文本信息用string保存下來(lái)。

type TestObject struct {
 Field1 string
 Field2 json.RawMessage
}
var data TestObject
json.Unmarshal([]byte(`{"field1": "hello", "field2": [1,2,3]}`), &data)
should.Equal(` [1,2,3]`, string(data.Field2))

使用 json.Number

默認(rèn)情況下，如果是 interface{} 對(duì)應(yīng)數(shù)字的情況會(huì)是 float64 類(lèi)型的。如果輸入的數(shù)字比較大，這個(gè)表示會(huì)有損精度。所以可以 UseNumber() 啟用 json.Number 來(lái)用字符串表示數(shù)字。

decoder1 := json.NewDecoder(bytes.NewBufferString(`123`))
decoder1.UseNumber()
var obj1 interface{}
decoder1.Decode(&obj1)
should.Equal(json.Number("123"), obj1)

jsoniter 支持標(biāo)準(zhǔn)庫(kù)的這個(gè)用法。同時(shí)，擴(kuò)展了行為使得 Unmarshal 也可以支持 UseNumber 了。

json := Config{UseNumber:true}.Froze()
var obj interface{}
json.UnmarshalFromString("123", &obj)
should.Equal(json.Number("123"), obj)

統(tǒng)一更改字段的命名風(fēng)格

經(jīng)常 JSON 里的字段名 Go 里的字段名是不一樣的。我們可以用 field tag 來(lái)修改。

output, err := jsoniter.Marshal(struct {
 UserName string `json:"user_name"`
 FirstLanguage string `json:"first_language"`
}{
 UserName: "taowen",
 FirstLanguage: "Chinese",
})
should.Equal(`{"user_name":"taowen","first_language":"Chinese"}`, string(output))

但是一個(gè)個(gè)字段來(lái)設(shè)置，太麻煩了。如果使用 jsoniter，我們可以統(tǒng)一設(shè)置命名風(fēng)格。

import "github.com/json-iterator/go/extra"

extra.SetNamingStrategy(LowerCaseWithUnderscores)
output, err := jsoniter.Marshal(struct {
 UserName string
 FirstLanguage string
}{
 UserName: "taowen",
 FirstLanguage: "Chinese",
})
should.Nil(err)
should.Equal(`{"user_name":"taowen","first_language":"Chinese"}`, string(output))

使用私有的字段

Go 的標(biāo)準(zhǔn)庫(kù)只支持 public 的 field。jsoniter 額外支持了 private 的 field。需要使用 SupportPrivateFields() 來(lái)開(kāi)啟開(kāi)關(guān)。

import "github.com/json-iterator/go/extra"

extra.SupportPrivateFields()
type TestObject struct {
 field1 string
}
obj := TestObject{}
jsoniter.UnmarshalFromString(`{"field1":"Hello"}`, &obj)
should.Equal("Hello", obj.field1)

總結(jié)

以上就是這篇文章的全部?jī)?nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作能帶來(lái)一定的幫助，如果有疑問(wèn)大家可以留言交流，謝謝大家對(duì)腳本之家的支持。

您可能感興趣的文章: