Go 语言中结构体标签的作用及示例

阿贾克斯的黎明

于 2024-09-30 00:00:20 发布

阅读量191

点赞数 3

分类专栏： golang 文章标签： microsoft golang

本文链接：https://blog.csdn.net/m0_57836225/article/details/142645870

版权

golang 专栏收录该内容

115 篇文章 1 订阅

订阅专栏

在 Go 语言中，结构体标签在 JSON 编码和解码等场景中起着重要的作用。本文将以特定的代码示例来详细介绍带json标签和不带标签的结构体在 JSON 处理上的区别。

一、示例代码及分析

以下是一段 Go 语言代码示例：

package main

import (
    "encoding/json"
    "fmt"
)

type AuthResponse struct {
    Token  string `json:"token"`
    UserID string `json:"user_id"`
}

type AuthResponseWithoutTags struct {
    Token  string
    UserID string
}

func main() {
    // 带标签的结构体
    withTags := AuthResponse{Token: "myToken", UserID: "123"}
    encodedWithTags, _ := json.Marshal(withTags)
    fmt.Println(string(encodedWithTags))

    // 不带标签的结构体
    withoutTags := AuthResponseWithoutTags{Token: "myToken", UserID: "123"}
    encodedWithoutTags, _ := json.Marshal(withoutTags)
    fmt.Println(string(encodedWithoutTags))
}

在这个示例中，我们定义了两个结构体AuthResponse和AuthResponseWithoutTags。AuthResponse带有json标签，而AuthResponseWithoutTags没有标签。

二、带标签与不带标签的区别

（一）不带`json`标签的情况

当结构体没有这些标签时，在进行 JSON 编码和解码操作时，有以下特点：

编码后的 JSON 键名和结构体字段名一致。例如，对于AuthResponseWithoutTags结构体，在编码为 JSON 时，键名将是Token和UserID。
在解码 JSON 数据到结构体时，也要求 JSON 中的键名与结构体字段名完全匹配。

（二）带`json`标签的情况

带有json标签的结构体，如AuthResponse，具有以下优势：

可以自定义在 JSON 编码和解码时使用的键名。在上述代码中，json:"token"表示在编码为 JSON 时，该字段对应的键名为token，而不是默认的Token；同理，json:"user_id"使得编码后的键名为user_id而不是UserID。
这在与外部系统交互时非常有用，尤其是当外部系统要求特定的键名格式或者键名与 Go 结构体字段名不一致的情况下。例如，如果你要与一个只接受小写键名的 API 进行交互，就可以使用这些标签来确保编码后的 JSON 符合要求。

三、代码中关键语句解释

encodedWithTags, _ := json.Marshal(withTags)：
- json.Marshal是 Go 语言标准库中用于将数据编码为 JSON 格式的函数。
- 这里将带有json标签的结构体变量withTags作为参数传入，该函数会返回一个字节切片和一个可能的错误。
- encodedWithTags是一个字节切片，它存储了编码后的 JSON 数据。
- _是一个空白标识符，用于忽略可能返回的错误。在实际应用中，不建议直接忽略错误，而应该对错误进行适当的处理。
fmt.Println(string(encodedWithTags))：
- encodedWithTags是一个字节切片，为了方便查看，这里将其转换为字符串类型并打印输出。
- string(encodedWithTags)将字节切片转换为字符串，这样就可以在控制台中以可读的形式显示编码后的 JSON 数据。