Go语言struct要使用 tags的原因解析
作者:yongxinz 发布时间:2023-08-31 09:25:19
在 Go 语言中,struct 是一种常见的数据类型,它可以用来表示复杂的数据结构。在 struct 中,我们可以定义多个字段,每个字段可以有不同的类型和名称。
除了这些基本信息之外,Go 还提供了 struct tags,它可以用来指定 struct 中每个字段的元信息。
在本文中,我们将探讨为什么 Go 语言中需要使用 struct tags,以及 struct tags 的使用场景和优势。
struct tags 的使用
struct tags 使用还是很广泛的,特别是在 json 序列化,或者是数据库 ORM 映射方面。
在定义上,它以 key:value
的形式出现,跟在 struct 字段后面,除此之外,还有以下几点需要注意:
使用反引号
在声明 struct tag 时,使用反引号 `
包围 tag 的值,可以防止转义字符的影响,使 tag 更容易读取和理解。例如:
type User struct {
ID int `json:"id" db:"id"`
Name string `json:"name" db:"name"`
Email string `json:"email" db:"email"`
}
避免使用空格
在 struct tag 中,应该避免使用空格,特别是在 tag 名称和 tag 值之间。使用空格可能会导致编码或解码错误,并使代码更难以维护。例如:
// 不规范的写法
type User struct {
ID int `json: "id" db: "id"`
Name string `json: "name" db: "name"`
Email string `json: "email" db: "email"`
}
// 规范的写法
type User struct {
ID int `json:"id" db:"id"`
Name string `json:"name" db:"name"`
Email string `json:"email" db:"email"`
}
避免重复
在 struct 中,应该避免重复使用同一个 tag 名称。如果重复使用同一个 tag 名称,编译器可能会无法识别 tag,从而导致编码或解码错误。例如:
// 不规范的写法
type User struct {
ID int `json:"id" db:"id"`
Name string `json:"name" db:"name"`
Email string `json:"email" db:"name"`
}
// 规范的写法
type User struct {
ID int `json:"id" db:"id"`
Name string `json:"name" db:"name"`
Email string `json:"email" db:"email"`
}
使用标准化的 tag 名称
为了使 struct tag 更加标准化和易于维护,应该使用一些标准化的 tag 名称。
例如,对于序列化和反序列化,可以使用 json
、xml
、yaml
等;对于数据库操作,可以使用 db
。
type User struct {
ID int `json:"id" db:"id"`
Name string `json:"name" db:"name"`
Password string `json:"-" db:"password"` // 忽略该字段
Email string `json:"email" db:"email"`
}
其中,Password
字段后面的 -
表示忽略该字段,也就是说该字段不会被序列化或反序列化。
多个 tag 值
如果一个字段需要指定多个 tag 值,可以使用 ,
将多个 tag 值分隔开。例如:
type User struct {
ID int `json:"id" db:"id"`
Name string `json:"name" db:"name"`
Email string `json:"email,omitempty" db:"email,omitempty"`
}
其中 omitempty
表示如果该字段值为空,则不序列化该字段。
struct tags 的原理
Go 的反射库提供了一些方法,可以让我们在程序运行时获取和解析结构体标签。
介绍这些方法之前,先来看看 reflect.StructField
,它是描述结构体字段的数据类型。定义如下:
type StructField struct {
Name string // 字段名
Type Type // 字段类型
Tag StructTag // 字段标签
}
结构体中还有一些其他字段,被我省略了,只保留了和本文相关的。
在结构体的反射中,我们经常使用 reflect.TypeOf
获取类型信息,然后使用 Type.Field
或 Type.FieldByName()
获取结构体字段的 reflect.StructField
,然后根据 StructField
中的信息做进一步处理。
例如,可以通过 StructField.Tag.Get
方法获取结构体字段的标签值。
下面看一段代码:
package main
import (
"fmt"
"reflect"
)
type User struct {
Name string `json:"name"`
Age int `json:"age"`
}
type Manager struct {
Title string `json:"title"`
User
}
func main() {
m := Manager{Title: "Manager", User: User{Name: "Alice", Age: 25}}
mt := reflect.TypeOf(m)
// 获取 User 字段的 reflect.StructField
userField, _ := mt.FieldByName("User")
fmt.Println("Field 'User' exists:", userField.Name, userField.Type)
// 获取 User.Name 字段的 reflect.StructField
nameField, _ := userField.Type.FieldByName("Name")
tag := nameField.Tag.Get("json")
fmt.Println("User.Name tag:", tag)
}
运行以上代码,输出结果如下:
Field 'User' exists: User {string int}
User.Name tag: "name"
struct tags 的优势
使用 struct tag 的主要优势之一是可以在运行时通过反射来访问和操作 struct 中的字段。
比如在 Go Web 开发中,常常需要将 HTTP 请求中的参数绑定到一个 struct 中。这时,我们可以使用 struct tag 指定每个字段对应的参数名称、验证规则等信息。在接收到 HTTP 请求时,就可以使用反射机制读取这些信息,并根据信息来验证参数是否合法。
另外,在将 struct 序列化为 JSON 或者其他格式时,我们也可以使用 struct tag 来指定每个字段在序列化时的名称和规则。
此外,使用 struct tag 还可以提高代码的可读性和可维护性。在一个大型的项目中,struct 中的字段通常会包含很多不同的元信息,比如数据库中的表名、字段名、索引、验证规则等等。
如果没有 struct tag,我们可能需要将这些元信息放在注释中或者在代码中进行硬编码。这样会让代码变得难以维护和修改。而使用 struct tag 可以将这些元信息与 struct 字段紧密关联起来,使代码更加清晰和易于维护。
常用的 struct tags
在 Go 的官方 wiki 中,有一个常用的 struct tags 的库的列表,我复制在下面了,感兴趣的同学可以看看源码,再继续深入学习。
Tag | Documentation |
---|---|
xml | https://pkg.go.dev/encoding/xml |
json | https://pkg.go.dev/encoding/json |
asn1 | https://pkg.go.dev/encoding/asn1 |
reform | https://pkg.go.dev/gopkg.in/reform.v1 |
dynamodb | https://docs.aws.amazon.com/sdk-for-go/api/service/dynamodb/dynamodbattribute/#Marshal |
bigquery | https://pkg.go.dev/cloud.google.com/go/bigquery |
datastore | https://pkg.go.dev/cloud.google.com/go/datastore |
spanner | https://pkg.go.dev/cloud.google.com/go/spanner |
bson | https://pkg.go.dev/labix.org/v2/mgo/bson, https://pkg.go.dev/go.mongodb.org/mongo-driver/bson/bsoncodec |
gorm | https://pkg.go.dev/github.com/jinzhu/gorm |
yaml | https://pkg.go.dev/gopkg.in/yaml.v2 |
toml | https://pkg.go.dev/github.com/pelletier/go-toml |
validate | https://github.com/go-playground/validator |
mapstructure | https://pkg.go.dev/github.com/mitchellh/mapstructure |
parser | https://pkg.go.dev/github.com/alecthomas/participle |
protobuf | https://github.com/golang/protobuf |
db | https://github.com/jmoiron/sqlx |
url | https://github.com/google/go-querystring |
feature | https://github.com/nikolaydubina/go-featureprocessing |
来源:https://www.cnblogs.com/alwaysbeta/p/17205950.html
猜你喜欢
- 支持实时监控sliderbar的数据,允许有callback回调的函数,有示例1、可自定样式SetStyle() 2、带有onSroll功能
- 你用过css么?当然,我是指你喜欢做网页的话,用过?很好,那你用过它的特效么?没有?那请跟我来。让我先通俗的介绍一下css,cs
- 2008年的圣诞节LOGO依旧延续着2007年的圣诞老人、鹿车、红帽子、圣诞树、蜡烛等元素装点。当然,也少不了雪花,但在LOGO设计上,较0
- HTML5 是近十年来 Web 标准最巨大的飞跃。和以前的版本不同,HTML 5 并非仅仅用来表示 Web 内容,它的使命是将 W
- PHP下载图片后文件打开显示损坏问题用php写个图片下载方法,测试发现下载的图片大小都没问题,但是无法打开文件。解决方法如下:首先打开文件下
- 锁定数据库的一个表 SELECT * FROM table WITH (HOLDLOCK) 注意: 锁定数据库的一个表的区别 SELECT
- 所以对应的asp处理代码如下代码如下:dedearr=split(xiangguanid2,chr(13)) '分割成数组
- 1、使用索引来更快地遍历表。缺省情况下建立的索引是非群集索引,但有时它并不是最佳的。在非群集索引下,数据在物理上随机存放在数据页上。合理的索
- 前言我们在写应用时,基本都会用到配置文件,从各种 shell 到 nginx 等,都有自己的配置文件。虽然这没有太多难度,但是配置项一般相对
- 假设我们已经安装好了tensorflow。一般在安装好tensorflow后,都会跑它的demo,而最常见的demo就是手写数字识别的dem
- 在asp中调用sql server的存储过程可以加快程序运行速度,本文介绍了asp使用存储过程的方法。1.调用存储过程的一般方法 先假设在s
- 如果要问做什么事是最有吸引力,那就是创建Web应用。Web设计者们对设计交互式的Web没有什么更好的办法,却对我们做桌面软件的同事投去少许羡
- 大家好,我们的数据库已经介绍完了,这里给大家总结一下。我们这段主要是学习了SQL的增删改查语句,其中查询是我们的重点。我们是以SQL Ser
- 这样处理的弊端是:如果数据量大,子分类很多,达到4级以上,这方法处理极端占用数据库连接池 对性能影响很大。 如果用SQL下面的CTE递归处理
- 最近看到好多人说到tns或者数据库不能登录等问题,就索性总结了下面的文档。首先来说Oracle的网络结构,往复杂处说能加上加密、LDAP等等
- 1引言实现磁带备份数据的功能有两方面的困难:首先,SQL Server(以下简称SQL)所提供的数据库的整体备份及恢复功能不能直接满足本系统
- 如何制作一个搜索引擎链接程序?多收集几个网站的,然后我们引用它到自己的页面中。接下来,我们要创建页面用于搜索:<center>&
- 这个问题困扰了我很长很长的时间,在跨域获取数据的时候就要用到服务器端的对象,以前一直用的是Msxml.XMLHTTP。但是问题太多了,特别严
- 大家都知道搜索引擎比较喜欢H1。在SEO中H1也是很基础也很重要的一步。但有些时候为了界面风格的原因,很多标题性的文字做成了图片。大多数情况
- 上次还是CSDN里的朋友回答的,我复制了下来。原文如下 =========================== 利用统计文章字数,然后达到一