Golang 中使用 JSON 的小技巧

有的時候上游傳過來的字段是string類型的，可是咱們卻想用變成數字來使用。 原本用一個json:",string" 就能夠支持了，若是不知道golang的這些小技巧，就要大費周章了。

參考文章：http://attilaolah.eu/2014/09/10/json-and-struct-composition-in-go/

臨時忽略struct字段

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

臨時忽略掉Password字段

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

臨時添加額外的字段

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

臨時忽略掉Password字段，而且添加token字段

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

臨時粘合兩個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})
複製代碼

一個json切分紅兩個struct

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

臨時更名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,
})
複製代碼

用字符串傳遞數字

type TestObject struct {
	Field1 int    `json:",string"`
}
複製代碼

這個對應的json是 {"Field1": "100"}

若是json是 {"Field1": 100} 則會報錯

容忍字符串和數字互轉

若是你使用的是jsoniter，能夠啓動模糊模式來支持 PHP 傳遞過來的 JSON。

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

extra.RegisterFuzzyDecoders()
複製代碼

這樣就能夠處理字符串和數字類型不對的問題了。好比

var val string
jsoniter.UnmarshalFromString(`100`, &val)
複製代碼

又好比

var val float32
jsoniter.UnmarshalFromString(`"1.23"`, &val)
複製代碼

容忍空數組做爲對象

PHP另一個使人崩潰的地方是，若是 PHP array是空的時候，序列化出來是[]。可是不爲空的時候，序列化出來的是{"key":"value"}。 咱們須要把 [] 當成 {} 處理。

若是你使用的是jsoniter，能夠啓動模糊模式來支持 PHP 傳遞過來的 JSON。

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

extra.RegisterFuzzyDecoders()
複製代碼

這樣就能夠支持了

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

使用 MarshalJSON支持time.Time

golang 默認會把 time.Time 用字符串方式序列化。若是咱們想用其餘方式表示 time.Time，須要自定義類型並定義 MarshalJSON。

type timeImplementedMarshaler time.Time

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

序列化的時候會調用 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 可以對不是你定義的type自定義JSON編解碼方式。好比對於 time.Time 能夠用 epoch int64 來序列化

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

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

若是要自定義的話，參見 RegisterTimeAsInt64Codec 的實現代碼

使用 MarshalText支持非字符串做爲key的map

雖然 JSON 標準裏只支持 string 做爲 key 的 map。可是 golang 經過 MarshalText() 接口，使得其餘類型也能夠做爲 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 就實現了 MarshalText()

使用 json.RawMessage

若是部分json文檔沒有標準格式，咱們能夠把原始的文本信息用string保存下來。

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

默認狀況下，若是是 interface{} 對應數字的狀況會是 float64 類型的。若是輸入的數字比較大，這個表示會有損精度。因此能夠 UseNumber() 啓用 json.Number 來用字符串表示數字。

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

jsoniter 支持標準庫的這個用法。同時，擴展了行爲使得 Unmarshal 也能夠支持 UseNumber 了。

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

統一更改字段的命名風格

常常 JSON 裏的字段名 Go 裏的字段名是不同的。咱們能夠用 field tag 來修改。

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))
複製代碼

可是一個個字段來設置，太麻煩了。若是使用 jsoniter，咱們能夠統一設置命名風格。

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 的標準庫只支持 public 的 field。jsoniter 額外支持了 private 的 field。須要使用 SupportPrivateFields() 來開啓開關。

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)複製代碼

軟文撰寫不易，客官點個讚唄：github.com/json-iterat…