golang JSON技巧小结_Golang

有的时候上游传过来的字段是string类型的,但是我们却想用变成数字来使用. 本来用一个json:”,string” 就可以支持了,如果不知道golang的这些小技巧,就要大费周章了.

临时忽略struct空字段

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

如果想临时忽略掉空password字段,可以用omitempty:

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

通过嵌入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文档没有标准格式,我们可以把原始的信息用[]byte保存下来.

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", &amp;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)

下面是我补充的内容

忽略掉一些字段

原文中第一节有个错误,我更正过来了.omitempty不会忽略某个字段,而是忽略空的字段,当字段的值为空值的时候,它不会出现在json数据中.

如果想忽略某个字段,需要使用 json:"-"格式.

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

如果想临时忽略掉空password字段,可以用-:

json.marshal(struct {
    *user
    password bool `json:"-"`
}{
    user: user,
})

忽略掉一些字段2

如果不想更改原struct,还可以使用下面的方法：

type user struct {
    email    string `json:"email"`
    password string `json:"password"`
    // many more fields…
}
type omit *struct{}
type publicuser struct {
    *user
    password omit `json:"-"`
}
json.marshal(publicuser{
    user: user,
})

到此这篇关于golang json技巧的文章就介绍到这了,更多相关golang json技巧内容请搜索代码网以前的文章或继续浏览下面的相关文章希望大家以后多多支持代码网！