【语言知识】golang struct tag type -- json

最新推荐文章于 2025-05-07 20:37:32 发布

Pecto

最新推荐文章于 2025-05-07 20:37:32 发布

阅读量492

点赞数 1

CC 4.0 BY-SA版权

分类专栏： golang 文章标签： golang json 开发语言

本文链接：https://blog.youkuaiyun.com/weixin_41198062/article/details/125083639

golang 专栏收录该内容

9 篇文章

订阅专栏

本文介绍了Golang中struct在进行json marshal/unmarshal时，如何使用tag type来控制字段转换规则。特别是`inline`、`omitempty`和`-`的用法。`inline`常用于内嵌结构体，`omitempty`会忽略值为空的字段，`-`则会完全忽略指定字段，即使其有值也不会出现在json输出中。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

json tag type

json tag type用于struct marshal/unmarshal时，将结构体字段按照一定规则，转换为json字段，如下文，Project结构体，marshal后"Name"转换为"name"
```
type Project struct {
	Name string `json:"name"`
	Id string  `json:"id"`
}
```
基本格式： Name(定义的字段名) string(类型) json:"opt1,opt2" key:"value"

tag:inline

常用语内嵌结构体

未定义inline时，如下输出：

type Project struct {
	Name string `json:"name"`
	Id string  `json:"id"`
}

type ProjectList struct {
	Project `json:"project"`
	Description string `json:"description"`
}

func main() {
	p := Project{
		Name: "projectA",
		Id: "xxx01",
	}
	pL := ProjectList{
		p,
		"Has one Project",
	}
	body, _ := json.Marshal(pL)
	fmt.Printf("marshal body is: %v\n", string(body))
	}

输出：

D:\restfulAPIPractise>go run main.go
marshal body is: {"project":{"name":"projectA","id":"xxx01"},"description":"Has one Project"}

定义json:",inline"时：
如将上文做一下变更：

type ProjectList struct {
	Project `json:",inline"`   // 变更点
	Description string `json:"description"`
}

输出：

D:\restfulAPIPractise>go run main.go
marshal body is: {"name":"projectA","id":"xxx01","description":"Has one Project"}

type:omitempty

omitempty，当字段值为空时，忽略

type ProjectList struct {
	Project `json:"project"`
	Description string `json:"description,omitempty"`   // omitempty
}

输出，description为空值，输出不显示：

marshal body is: {"project":{"name":"projectA","id":"xxx01"}}

对比，当不设置omitempty时

type ProjectList struct {
	Project `json:"project"`
	Description string `json:"description"` // 未设置omitempty
}

输出：

marshal body is: {"project":{"name":"projectA","id":"xxx01"},"description":""}

tag: -

json:“-”，忽略，即便字段有值

type ProjectList struct {
	Project `json:"project"`
	Description string `json:"-"`    //
}
// main中
pL := ProjectList{
	p,
	"xxx happy",   // description有值
}

输出：

marshal body is: {"project":{"name":"projectA","id":"xxx01"}}