golang如何使用struct的tag属性的详细介绍
从一个例子说起
我们经常会碰到下面格式的struct定义:
type person struct { name string `json:"name"` age int `json:"age"` }
这个struct定义一个叫做person的类型,包含两个域name和age;但是在域的后面有神奇的 json:"name" ,这个用来干什么用?这篇文章试图来解释这个问题。
当golang的对象需要和json做转换的时候,我们就经常用到这个特性。
有两点注意的地方:
1、如果一个域不是以大写字母开头的,那么转换成json的时候,这个域是被忽略的。
$ cat main.go package main import ( "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以小写字母开头。
2、如果没有使用 json:"name" tag,那么输出的json字段名和域名是一样的。
$ cat main.go package main import ( "fmt" "encoding/json" ) type person struct { name string age 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.go package main import ( "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 main import ( "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 int min, _ = 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 main import ( "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).name fieldtype := 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 int min, _ = 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
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。