golang 结构体struct 标签tag 标记 `` 简介

从一个例子说起
我们经常会碰到下面格式的struct定义：

type Person struct {Name string `json:"name"`Age  int    `json:"age"`
}

这个struct定义一个叫做Person的类型，包含两个域Name和Age；但是在域的后面有神奇的json:"name"，这个用来干什么用？这篇文章试图来解释这个问题。

当golang的对象需要和json做转换的时候，我们就经常用到这个特性。
有两点注意的地方：

如果一个域不是以大写字母开头的，那么转换成json的时候，这个域是被忽略的。

$ cat main.go
package mainimport ("fmt""encoding/json"
)type Person struct {Name string `json:"name"`age  int    `json:"age"`
}func main() {person := Person { "tom", 12 }if b, err := json.Marshal(person); err != nil {fmt.Printf("error: %s", err.Error())} else {fmt.Printf("value: %s", b)}
}
$ go build -o main main.go
$ ./main
value: {"name":"tom"}

我们看到转换成json串之后，name正常输出了，而age被丢弃了，因为age以小写字母开头。

如果没有使用json:"name"tag，那么输出的json字段名和域名是一样的。

$ cat main.go
package mainimport ("fmt""encoding/json"
)type Person struct {Name stringAge  int
}func main() {person := Person { "tom", 12 }if b, err := json.Marshal(person); err != nil {fmt.Printf("error: %s", err.Error())} else {fmt.Printf("value: %s", b)}
}
$ go build -o main main.go
$ ./main
value: {"Name":"tom","Age":12}

我们看到输出的json串使用的是struct定义的字段名。

总结一下，json:"name"格式串是用来指导json.Marshal/Unmarshal，在进行json串和golang对象之间转换的时候映射字段名使用的。再举一个例子，json串和golang域名字可以任意转换：

$ cat main.gopackage mainimport ("fmt""encoding/json"
)type Person struct {Name string    `json:"age"`Age  int       `json:"address"`
}func main() {person := Person { "tom", 12 }if b, err := json.Marshal(person); err != nil {fmt.Printf("error: %s", err.Error())} else {fmt.Printf("value: %s", b)}
}
$ go build -o main main.go
$ ./main
value: {"age":"tom","address":12}

这个例子我们把Name映射成了 age，而把Age映射成address，当然这是个奇葩的映射，没有任何正向意义，只有负向意义，只是为了说明可以进行任何名字映射而已。

如果我们去看json包的源代码，我可以看到在encoding/json/encode.go, encoding/json/decode.go里面有读取tag值得相关代码。

tag := sf.Tag.Get("json")

也就是说这个json的tag是被json.Marshal和json.Unmarshal来使用的。

我们如何使用tag

还是以前的例子，Person有一个域Age，我们能不能限定Age的值在1-100之间，不至于太大，否则这个值没有意义了。

$ cat main.go
package mainimport ("fmt""strings""strconv""reflect"_ "encoding/json"
)type Person struct {Name string    `json:"name"`Age  int       `json:"age" valid:"1-100"`
}func (p * Person) validation() bool {v := reflect.ValueOf(*p)tag := v.Type().Field(1).Tag.Get("valid")val := v.Field(1).Interface().(int)fmt.Printf("tag=%v, val=%v\n", tag, val)result := strings.Split(tag, "-")var min, max intmin, _ = strconv.Atoi(result[0])max, _ = strconv.Atoi(result[1])if val >= min && val <= max {return true} else {return false}
}func main() {person1 := Person { "tom", 12 }if person1.validation() {fmt.Printf("person 1: valid\n")} else {fmt.Printf("person 1: invalid\n")}person2 := Person { "tom", 250 }if person2.validation() {fmt.Printf("person 2 valid\n")} else {fmt.Printf("person 2 invalid\n")}
}

这么例子我们给Person添加了一个validate函数，validate验证age是不是合理。
这个函数可以扩展对任意struct的任意valid域进行验证。

$ cat main.go
package mainimport ("fmt""strings""strconv""reflect"_ "encoding/json"
)type Person struct {Name string    `json:"name"`Age  int       `json:"age" valid:"1-100"`
}type OtherStruct struct {Age  int       `valid:"20-300"`
}func validateStruct(s interface{}) bool {v := reflect.ValueOf(s)for i := 0; i < v.NumField(); i++ {fieldTag    := v.Type().Field(i).Tag.Get("valid")fieldName   := v.Type().Field(i).NamefieldType   := v.Field(i).Type()fieldValue  := v.Field(i).Interface()if fieldTag == "" || fieldTag == "-" {continue}if fieldName == "Age" && fieldType.String() == "int" {val := fieldValue.(int)tmp := strings.Split(fieldTag, "-")var min, max intmin, _ = strconv.Atoi(tmp[0])max, _ = strconv.Atoi(tmp[1])if val >= min && val <= max {return true} else {return false}}}return true
}func main() {person1 := Person { "tom", 12 }if validateStruct(person1) {fmt.Printf("person 1: valid\n")} else {fmt.Printf("person 1: invalid\n")}person2 := Person { "jerry", 250 }if validateStruct(person2) {fmt.Printf("person 2: valid\n")} else {fmt.Printf("person 2: invalid\n")}other1 := OtherStruct { 12 }if validateStruct(other1) {fmt.Printf("other 1: valid\n")} else {fmt.Printf("other 1: invalid\n")}other2 := OtherStruct { 250 }if validateStruct(other2) {fmt.Printf("other 2: valid\n")} else {fmt.Printf("other 2: invalid\n")}
}

在这个例子中我们定义了一个函数validateStruct，接受任意一个struct作为参数；validateStruct为验证struct中所有定义的Age字段，如果字段名字是Age，字段类型是int，并且定义了valid tag，那么就会验证这个valid是否有效。
看执行结果：

$ go build -o main main.go
$ ./main
person 1: valid
person 2: invalid
other 1: invalid
other 2: valid

golang 结构体struct 标签tag 标记 `` 简介相关推荐

golang 得到结构体 struct 标签 tag 内容结构体中的``数据
goLang获取struct的tag内容:beego的ORM中也通过tag来定义参数的. 获取tag的内容是利用反射包来实现的.示例代码如下: package main import ("f ...
Go语言学习笔记——结构体中使用tag标记
文章目录 golang结构体中使用tag标记简介语法结构快速入门常见应用应用json编码应用xml编码应用form表单绑定 gin框架form和数据绑定 golang结构体中使用tag标 ...
Golang结构体struct的使用(结构体嵌套，匿名结构体等)
转自: https://studygolang.com/articles/11313 golang中是没有class的,但是有一个结构体struct,有点类似,他没有像java,c++中继承的概念,但 ...
golang 结构体struct、数组、结构体数组定义与赋值、json string转struct
文章目录 1.结构体struct 1.1 声明结构体 1.2 初始化结构体以及传参 2. 结构体数组.append 3. 接口返回含数组的结构体常用写法 json string转struct ...
mysql表结构转 golang 结构体struct
在线转 https://dev.ataotaoa.com 本地转换(推荐) github地址: https://github.com/gohouse/converter 下载地址: https://g ...
golang 结构体简介
Go 通过类型别名(alias types)和结构体的形式支持用户自定义类型,或者叫定制类型.试图表示一个现实世界中的实体. 结构体由一系列命名的元素组成,这些元素又被称为字段,每个字段都有一个名称和 ...
Golang 入门 : 结构体(struct)
Go 通过类型别名(alias types)和结构体的形式支持用户自定义类型,或者叫定制类型.试图表示一个现实世界中的实体. 结构体由一系列命名的元素组成,这些元素又被称为字段,每个字段都有一个名称和 ...
golang 学习（二十四）结构体struct 和 json之间的转换
结构体struct 和 json之间的转换 import ("encoding/json""fmt""math/rand""tes ...
linux 结构体 struct addrinfo 简介
目录定义相关方法 1. getaddrinfo(const char, const char, const struct addrinfo, struct addrinfo*) 2. freead ...

golang 结构体struct 标签tag 标记 `` 简介

golang 结构体struct 标签tag 标记 `` 简介相关推荐

最新文章

热门文章