Encode

将一个对象编码成JSON数据,接受一个interface{}对象,返回[]byte和error:

func Marshal(v interface{}) ([]byte, error)

Marshal函数将会递归遍历整个对象,依次按成员类型对这个对象进行编码,类型转换规则如下:

bool类型 转换为JSON的Boolean
整数,浮点数等数值类型 转换为JSON的Number
string 转换为JSON的字符串(带""引号)
struct 转换为JSON的Object,再根据各个成员的类型递归打包
数组或切片 转换为JSON的Array
[]byte 会先进行base64编码然后转换为JSON字符串
map 转换为JSON的Object,key必须是string
interface{} 按照内部的实际类型进行转换
nil 转为JSON的null
channel,func等类型 会返回UnsupportedTypeError

[plain] view plain copy
  • var jsonBlob = []byte(`[
  • {"Name": "Platypus", "Order": "Monotremata"},
  • {"Name": "Quoll",    "Order": "Dasyuromorphia"}
  • type Animal struct {
  • Name  string
  • Order string
  • var animals []Animal
  • err := json.Unmarshal(jsonBlob, &animals)
  • if err != nil {
  • fmt.Println("error:", err)
  • fmt.Printf("%+v", animals)
  • Output:
  • [{Name:Platypus Order:Monotremata} {Name:Quoll Order:Dasyuromorphia}]
  • 结构体必须是 大写字母开头 的成员才会被JSON处理到,小写字母开头的成员不会有影响。

    Mashal时,结构体的成员变量名将会直接作为JSON Object的key打包成JSON;Unmashal时,会自动匹配对应的变量名进行赋值,大小写不敏感。

    Unmarshal时,如果JSON中有多余的字段,会被直接抛弃掉;如果JSON缺少某个字段,则直接忽略不对结构体中变量赋值,不会报错。

    [plain] view plain copy
  • b := []byte(`{"nAmE":"Bob","Food":"Pickle", "inner":"changed"}`)
  • err := json.Unmarshal(b, &m)
  • if err != nil {
  • fmt.Printf(err.Error())
  • return
  • fmt.Printf("%v", m)
  • Output:
  • {Bob Hello 1294706395881547000 ok}
  • StructTag

    如果希望手动配置结构体的成员和JSON字段的对应关系,可以在定义结构体的时候给成员打标签:

    使用omitempty熟悉,如果该字段为nil或0值(数字0,字符串"",空数组[]等),则打包的JSON结果不会有这个字段。

    [plain] view plain copy
  • type Message struct {
  • Name string `json:"msg_name"`       // 对应JSON的msg_name
  • Body string `json:"body,omitempty"` // 如果为空置则忽略字段
  • Time int64  `json:"-"`              // 直接忽略字段
  • var m = Message{
  • Name: "Alice",
  • Body: "",
  • Time: 1294706395881547000,
  • data, err := json.Marshal(m)
  • if err != nil {
  • fmt.Printf(err.Error())
  • return
  • fmt.Println(string(data))
  • Output:
  • {"msg_name":"Alice"}
  • 更灵活地使用JSON

    使用json.RawMessage

    json.RawMessage其实就是[]byte类型的重定义。可以进行强制类型转换。

    现在有这么一种场景,结构体中的其中一个字段的格式是未知的: