0

0

Golang如何定义并使用结构体标签_Golang 结构体标签使用实践

P粉602998670

P粉602998670

发布时间:2025-11-18 17:52:02

|

643人浏览过

|

来源于php中文网

原创

结构体标签是Go中为字段添加元信息的机制,用反引号包围,形式为key:"value",可通过反射读取。常用于JSON序列化(如json:"name")、数据库映射(如gorm:"primaryKey")和参数校验(如validate:"required"),提升代码可读性与灵活性。

golang如何定义并使用结构体标签_golang 结构体标签使用实践

在 Go 语言中,结构体标签(Struct Tags)是一种为结构体字段附加元信息的机制,常用于控制序列化、反序列化行为,比如 JSON、XML、BSON 的编码解码。合理使用结构体标签能提升代码的可读性和灵活性。

什么是结构体标签

结构体标签是写在结构体字段后面的字符串注解,用反引号(``)包围,通常以 key:"value" 形式存在。这些标签不会影响程序运行,但可以通过反射(reflect)在运行时读取,被标准库或第三方库解析使用。

例如:

type User struct {
Name string `json:"name"`
Age int `json:"age,omitempty"`
ID string `json:"-"` // 表示不参与 JSON 编码
}

上面的 json:"name" 就是结构体标签,告诉 encoding/json 包在序列化时将 Name 字段映射为 JSON 中的 "name" 字段。

立即学习go语言免费学习笔记(深入)”;

常见标签使用场景

结构体标签广泛应用于数据格式转换和校验。以下是几个典型用途:

1. JSON 序列化与反序列化
通过 json 标签控制字段名、是否忽略空值等。

type Product struct {
Title string `json:"title"`
Price float64 `json:"price"`
Sku string `json:"sku,omitempty"` // 空字符串时不输出
CreatedTime int64 `json:"created_time,string"` // 数值转为字符串输出
}

当 Price 为 0 或 Sku 为空时,Sku 字段不会出现在 JSON 输出中。

2. 数据库映射(如 GORM)
在使用 GORM 等 ORM 框架时,常用标签指定数据库字段名、主键、索引等。

type User struct {
ID uint `gorm:"primaryKey"`
Name string `gorm:"column:username;size:100"`
Email string `gorm:"uniqueIndex"`
}

ToonMe
ToonMe

一款风靡Instagram的软件,一键生成卡通头像

下载

这里 gorm 标签告诉 GORM 如何映射到数据库表结构。

3. 请求参数校验
结合 validator 标签可在 API 接收数据时做字段校验。

import "github.com/go-playground/validator/v10"

type LoginReq struct {
Username string `json:"username" validate:"required,email"`
Password string `json:"password" validate:"required,min=6"`
}

使用 validator 库可以验证请求体是否符合规则。

如何读取结构体标签

通过反射(reflect)可以在运行时获取结构体字段的标签内容,适用于自定义序列化器、配置解析器等场景。

package main

import (
"fmt"
"reflect"
)

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

func main() {
t := reflect.TypeOf(Person{})
field := t.Field(0) // 获取第一个字段 Name

jsonTag := field.Tag.Get("json")
xmlTag := field.Tag.Get("xml")

fmt.Println("JSON tag:", jsonTag) // 输出: full_name
fmt.Println("XML tag:", xmlTag) // 输出: name
}

Tag.Get(key) 方法用于提取指定键的标签值,是处理结构体标签的核心方式。

注意事项与最佳实践

使用结构体标签时需注意以下几点:

  • 标签必须用反引号包裹,不能用双引号
  • 多个标签之间用空格分隔,如:json:"name" validate:"required"
  • 标签内部不能有空格,如 json:" name " 会包含空格,可能引发问题
  • 不是所有库都支持相同标签,需查阅对应文档(如 json、bson、validate、gorm 等)
  • 避免滥用标签,保持结构体清晰易读

基本上就这些。结构体标签是 Go 中非常实用的功能,掌握它有助于更好地处理数据编解码、数据库操作和接口校验。正确使用能让代码更简洁、更规范。

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

179

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

226

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

340

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

209

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

392

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

197

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

191

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

192

2025.06.17

PS使用蒙版相关教程
PS使用蒙版相关教程

本专题整合了ps使用蒙版相关教程,阅读专题下面的文章了解更多详细内容。

23

2026.01.19

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
golang socket 编程
golang socket 编程

共2课时 | 0.1万人学习

nginx浅谈
nginx浅谈

共15课时 | 0.8万人学习

golang和swoole核心底层分析
golang和swoole核心底层分析

共3课时 | 0.1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号