讲师中心 微信公众号

工具推荐

视频效率加速
AniShort
AniShort

AI短剧协同制作平台

Laper
Laper

剧本策划到成片协作

立刻MV
立刻MV

低成本歌曲 MV、视频生成

剧云
剧云

中文短剧剧本制作平台

Golang:高效控制结构体数组字段的JSON序列化

秋晨小哥_5850

秋晨小哥_5850

发布时间:2025-10-30 13:40:33

|

491人浏览过

|

来源于php中文网

原创

golang:高效控制结构体数组字段的json序列化

本文深入探讨了在Go语言中如何高效地控制结构体数组字段的JSON序列化过程,特别是在需要排除敏感信息(如ID、哈希密码)时。通过利用Go标准库`encoding/json`提供的结构体标签(`json:"-"`),开发者可以简洁明了地指定哪些字段应被忽略,从而避免将不必要或敏感的数据暴露给客户端,确保数据传输的安全性和精简性。

在Go语言的Web开发中,我们经常需要从数据库或其他数据源获取一系列结构体数据(例如,用户列表),然后将其序列化为JSON格式并发送给客户端。然而,原始的结构体可能包含一些不适合直接暴露给客户端的字段,比如数据库内部ID、用户密码哈希值、敏感配置信息等。直接将包含这些字段的结构体数组进行JSON序列化,会带来潜在的安全风险和不必要的数据传输开销。

传统上,一些开发者可能会考虑使用reflect包来动态地选择结构体字段并构建新的映射或结构体,但这通常会导致代码复杂性增加,且性能开销较大,尤其是在处理结构体数组时。Go语言的encoding/json包提供了一种更为优雅和高效的解决方案:结构体标签(struct tags)。

核心解决方案:使用json结构体标签

Go语言的encoding/json包允许开发者通过在结构体字段声明后添加特定的字符串标签来控制JSON序列化和反序列化的行为。其中,最常用的标签之一就是json:"-",它明确指示json包在序列化时忽略该字段。

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

让我们通过一个具体的例子来演示如何应用这一技术。假设我们有一个User结构体,其中包含一个不希望暴露给客户端的Id字段和一个需要暴露的Name字段。

Expanso yaml-to-json
Expanso yaml-to-json

使用 Expanso Edge 管道将 YAML 输入转换为 JSON 格式。

下载
package main

import (
    "encoding/json"
    "fmt"
)

// User 定义用户结构体
type User struct {
    // Id 字段被标记为 "json:"-",表示在JSON序列化时忽略此字段
    Id   int    `json:"-"`
    // Name 字段被标记为 "json:"name",表示在JSON中该字段名为 "name"
    Name string `json:"name"`
}

// Users 定义一个User指针的切片,用于表示用户列表
type Users []*User

func main() {
    // 创建一个用户列表
    users := &Users{
        &User{Id: 1, Name: "Max"},
        &User{Id: 2, Name: "Alice"},
        &User{Id: 3, Name: "Dan"},
    }

    // 将用户列表序列化为JSON
    jsonData, err := json.Marshal(users)
    if err != nil {
        fmt.Println("JSON序列化失败:", err)
        return
    }

    // 打印序列化后的JSON字符串
    fmt.Println(string(jsonData))
}

代码解析:

  1. type User struct { ... }: 定义了一个User结构体。
  2. Id intjson:"-"``: 这是关键所在。json:"-"标签告诉encoding/json包,在将User结构体实例编码为JSON时,完全跳过Id字段。无论Id字段的值是什么,它都不会出现在最终的JSON输出中。
  3. Name stringjson:"name"``: 这个标签表示Name字段将被包含在JSON输出中,并且在JSON中对应的键名将是小写的name。如果省略此标签(即Name string),则默认使用字段名Name作为JSON键。
  4. *`type Users []User**: 为了方便处理用户列表,我们定义了一个Users类型,它是一个*User`切片。
  5. json.Marshal(users): encoding/json包的Marshal函数负责将Go数据结构转换为JSON格式的字节切片。它会自动识别并处理结构体中的json标签。

输出结果:

[{"name":"Max"},{"name":"Alice"},{"name":"Dan"}]

从输出可以看出,Id字段被成功地排除了,而Name字段则以name的键名被包含在JSON中,完全符合我们的预期。

json标签的更多用法

除了json:"-"用于排除字段外,json标签还有其他强大的功能:

  • json:"fieldName": 指定在JSON中使用的字段名。例如,CreatedAt time.Timejson:"created_at"`会将Go结构体中的CreatedAt字段序列化为JSON中的created_at`。
  • json:"fieldName,omitempty": 当字段的值是其类型的零值时(例如,int为0,string为空字符串,*T为nil,slice或map为nil),该字段将不会被包含在JSON输出中。这对于可选字段非常有用。
  • json:"-": 如上所述,完全忽略该字段。

注意事项与最佳实践

  1. 安全性优先: 在设计API响应时,始终优先考虑安全性。敏感数据绝不应无意中暴露给客户端。使用json:"-"是防止此类暴露的有效手段。
  2. DTO模式: 对于复杂的场景,如果需要根据不同的API端点或用户角色返回不同的字段子集,可以考虑使用DTO(Data Transfer Object)模式。即为每个特定的响应需求定义一个单独的结构体,只包含所需的字段。这比动态反射更清晰,也更容易维护。
  3. 可读性与维护性: 结构体标签是声明性的,直接附加在字段定义旁边,使得代码更易读、更易于理解字段的序列化行为。
  4. 性能: 相较于反射或其他手动构建映射的方式,使用json标签进行序列化是Go语言标准库内置且高度优化的方式,性能表现优异。
  5. XML等其他格式: 类似地,Go标准库的encoding/xml包也支持结构体标签来控制XML的序列化行为,但其规则可能略有不同,需要查阅相关文档。

总结

在Go语言中,当需要将结构体数组序列化为JSON,并且希望排除某些敏感或不必要的字段时,encoding/json包提供的结构体标签是最佳实践。通过简单地在字段声明后添加json:"-"标签,开发者可以高效、安全地控制JSON输出,避免了复杂的反射操作,使得代码更加简洁、健壮和易于维护。掌握这一技巧对于构建高质量的Go语言Web服务至关重要。

热门AI工具

更多
音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

函子Zion

一款支持AI搭建、可视化编辑和多端发布的全栈无代码开发平台。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

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

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

539

2024.02.23

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

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

616

2024.02.23

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

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

1296

2024.02.23

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

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

811

2024.03.05

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

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

1886

2024.05.21

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

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

5414

2025.06.09

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

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

2514

2025.06.10

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

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

4366

2025.06.17

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

0

2026.11.12

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21.3万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn