Golang结构体中可忽略的字段用什么tag表示

前言

在写项目的时候，需要实现一个搜索功能，可以通过不同的字段查询数据库中的东西，比如可以通过名字或者介绍或者分类进行查询，但是从前端传回到后端的数据中，需要忽略某些字段在查询中的作用（前端传回来为空的字段）。

于是就想到在结构体中使用tag来选择性的忽略某些字段。

实现步骤

使用tag忽略字段有两种用法：

一、使用 json:"-"标签，表示在序列化过程中被忽略，不会出现在结果中。但在其他操作，比如结构体的赋值，访问等时仍会考虑该字段。

package main

import (
	"encoding/json"
	"fmt"
)

type User struct {
	Id   int64  `json:"id"`
	Name string `json:"name"`
	Password string `json:"-"`
}

func main() {
	user1 := User{
		Id:   0,
		Name: "Koya1",
	}
	marshal, err := json.Marshal(user1)
	if err != nil {
		fmt.Println("err1===>", err)
		return
	}
	fmt.Printf("%s\n", marshal)
	fmt.Println("user1的密码为===>", user1.Password)

	fmt.Println("========我是分割线========")
	user2 := User{
		Id:       0,
		Name:     "Koya1",
		Password: "Aaaaaa",
	}
	marshal, err = json.Marshal(user2)
	if err != nil {
		fmt.Println("err2===>", err)
		return
	}
	fmt.Printf("%s\n", marshal)
	fmt.Println("user2的密码为===>", user2.Password)
}
// 运行结果
//{"id":0,"name":"Koya1"}
//user1的密码为===>         
//========我是分割线========
//{"id":0,"name":"Koya1"}   
//user2的密码为===> Aaaaaa 

二、使用json:"omitempty" 标签，表示如果字段的值为空，则在序列化是忽略该字段。使用这种方法可以根据需要灵活地控制字段的序列化。

package main

import (
	"encoding/json"
	"fmt"
)

type User struct {
	Id       int64  `json:"id"`
	Name     string `json:"name"`
	Password string `json:"password,omitempty"`
}

func main() {
	user1 := User{
		Id:   0,
		Name: "Koya1",
	}
	marshal, err := json.Marshal(user1)
	if err != nil {
		fmt.Println("err1===>", err)
		return
	}
	fmt.Printf("%s\n", marshal)
	fmt.Println("user1的密码为===>", user1.Password)

	fmt.Println("========我是分割线========")
	user2 := User{
		Id:       0,
		Name:     "Koya1",
		Password: "Aaaaaa",
	}
	marshal, err = json.Marshal(user2)
	if err != nil {
		fmt.Println("err2===>", err)
		return
	}
	fmt.Printf("%s\n", marshal)
	fmt.Println("user2的密码为===>", user2.Password)
}

// 运行结果
//{"id":0,"name":"Koya1"}
//user1的密码为===>
//========我是分割线========
//{"id":0,"name":"Koya1","password":"Aaaaaa"}
//user2的密码为===> Aaaaaa  

由于 User 结构体里的 Password 字段有 omitempty 属性，因此 encoding/json 在将对象转化 json 字符串时，只要发现对象里的 Password 为 false， 0， 空指针，空接口，空数组，空切片，空映射，空字符串中的一种，就会被忽略。

参考文章：https://zhuanlan.zhihu.com/p/258978922