专栏首页mojocngolang JSON技巧

golang JSON技巧

golang JSON技巧

  1. MojoTech
  2. golang
  3. golang JSON技巧

4.5 Eric Zhou golang 2018-12-26

目录

  1. 临时忽略struct空字段
  2. 临时添加额外的字段
  3. 临时粘合两个struct
  4. 一个json切分成两个struct
  5. 临时改名struct的字段
  6. 用字符串传递数字
  7. 容忍字符串和数字互转
  8. 容忍空数组作为对象
  9. 使用 MarshalJSON支持time.Time
  10. 使用 RegisterTypeEncoder支持time.Time
  11. 使用 MarshalText支持非字符串作为key的map
  12. 使用 json.RawMessage
  13. 使用 json.Number
  14. 统一更改字段的命名风格
  15. 使用私有的字段
  16. 忽略掉一些字段
  17. 忽略掉一些字段2

有的时候上游传过来的字段是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 作为 keymap.但是 golang 通过 MarshalText() 接口,使得其他类型也可以作为 mapkey.例如

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

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • Golang前后端分离项目OAuth2教程

    OAuth2.0是OAuth协议的下一版本,但不向后兼容OAuth 1.0即完全废止了OAuth1.0. OAuth 2.0关注客户端开发者的简易性. 要么通过...

    mojocn
  • Go进阶29:高效io.Reader/io.Writer S3数据传输

    从S3下载小文件保存到小文件,创建zip压缩包,写入小文件的内容到压缩包,上传zip压缩文件的内容到S3.

    mojocn
  • Go教程:22 RESTful-Gorm-Gin分页搜索最佳实践

    使用页码表示法对前端开发比较友好,但是本质上是和偏移量表示发相似. 在这里我们将使用 jinzhu/gorm和 gin-gonic/gin 开发一个简单的分页接...

    mojocn
  • [转载]Go JSON 技巧

    相对于很多的语言来说, Go 的 JSON 解析可谓简单至极. 问题 通常情况下, 我们在 Go 中经常这样进行 JSON 的解码: package main ...

    李海彬
  • Android下json-c库使用

    因为很多地方都以json数据数据交互协议, 尤其嵌入式web数据交互时通常会用到json格式, 因此如果需要在产品端进行json数据解析 , json-c 是一...

    李小白是一只喵
  • Python json读写方式和字典相互转化

    它可以方便的在使用在多种语言中,这里介绍的是在python中的字典(dict)与json字符串相互转化的方式。

    砸漏
  • php json转换相关知识(小结)

    最近在查找一个bug的时候,发现前端传过来的json空对象 {} ,被php转换成了空数组 [] 存到了数据库里面, 读取并返回给前端的时候,没有做特殊处理,返...

    砸漏
  • python中的json模块

    JSON就是JavaScript Object Notation,这个模块完成了python对象和JSON字符串的互相转换! json是一种很多语言支持的通用语...

    py3study
  • SpringMVC底层数据传输校验的方案

    团队的项目正常运行了很久,但近期偶尔会出现BUG。目前观察到的有两种场景:一是大批量提交业务请求,二是生成批量导出文件。出错后,再执行一次就又正常了。

    程序猿讲故事
  • [快学Python3]JSON解析

    概述 本章节将为大家介绍如何使用Python来编码和解码json对象。 json是javascript object notation的简写,是一种轻量级的数据...

    苦叶子

扫码关注云+社区

领取腾讯云代金券