Golang中encoding/json关于omitempty的坑

一句话概括

omitempty标签并不是省略空值, 而是省略变量类型对应的零值. 如果刚好赋值为零值, 会被json.Marshal方法省略掉. (我认为是bug)

发现问题

type TestStruct struct {
	BoolVar      bool        `json:"bool_var,omitempty"`
	IntVar       int         `json:"int_var,omitempty"`
	StringVar    string      `json:"string_var,omitempty"`
	InterfaceVar interface{} `json:"interface,omitempty"`
}

这样的一个结构, 带上omitempty的tag, 本来是希望几个值不赋值时就不序列化. 但发现赋值后也会被省略.
例如业务场景中, 一个布尔类型的值带上了omitempt, 那么只会返回true, false时就没有这个字段, 显然不是我们想要的.

	InterfaceVarIsInt := TestStruct{
		BoolVar:      false,
		IntVar:       0,
		InterfaceVar: 0,
		StringVar: "",
	}
	res, _ := json.Marshal(InterfaceVarIsInt)
	fmt.Println(string(res))

输出:

{"interface":0}

原因与解决

false/0/""刚好都是bool类型, int类型和string类型的零值, json不会判断有没有主动赋值, 都会被省略.

如果想要实现, 不赋值的变量就不会序列化返回, 应该使用interface{}, 因为interface{}的零值是nil, 只要有手动赋值,就不会是nil.

完整代码

package main

import (
	"fmt"
	"encoding/json"
)
type TestStruct struct {
	BoolVar      bool        `json:"bool_var,omitempty"`
	IntVar       int         `json:"int_var,omitempty"`
	StringVar    string      `json:"string_var,omitempty"`
	InterfaceVar interface{} `json:"interface,omitempty"`
}

func main() {
	InterfaceVarIsInt := TestStruct{
		BoolVar:      false,
		IntVar:       0,
		InterfaceVar: 0,
		StringVar: "",
	}
	res, _ := json.Marshal(InterfaceVarIsInt)
	fmt.Println(string(res))
	InterfaceVarIsBool := TestStruct{
		BoolVar:      false,
		IntVar:       0,
		InterfaceVar: false,
		StringVar: "",
	}
	res, _ = json.Marshal(InterfaceVarIsBool)
	fmt.Println(string(res))
}

输出,不会省略零值:

{"interface":0}
{"interface":false}