0

0

将 Go 结构体(含嵌入结构体)序列化为扁平数组的完整实践指南

霞舞

霞舞

发布时间:2025-12-26 12:38:12

|

878人浏览过

|

来源于php中文网

原创

将 Go 结构体(含嵌入结构体)序列化为扁平数组的完整实践指南

本文介绍如何通过实现 `json.marshaler` 接口,将 go 中带嵌入字段的结构体(如 `user` 嵌套 `model`)按预定义顺序自动转换为 json 数组,兼顾性能、可读性与可维护性。

在 Web 数据传输场景中,尤其面向前端表格渲染(如 DataTables、Handsontable),以紧凑数组形式(而非键值对对象)传递结构化数据能显著减少 JSON 体积、提升解析速度,并简化前端索引映射逻辑。Go 标准库默认将结构体序列化为对象({ "Name": "kiz", "Id": "..." }),但通过自定义序列化行为,我们可以精准控制输出格式。

✅ 推荐方案:实现 json.Marshaler 接口

最简洁、高效且类型安全的方式是为需要转换的结构体显式实现 json.Marshaler。它避免了反射带来的运行时开销与类型不确定性,同时天然支持嵌入结构体字段的扁平展开。

以下以 User 结构体为例(含嵌入 Model):

import (
    "encoding/json"
    "time"
)

type Model struct {
    Id        bson.ObjectId   `bson:"_id,omitempty"`
    CreatedAt time.Time       `bson:",omitempty"`
    UpdatedAt time.Time       `bson:",omitempty"`
    DeletedAt time.Time       `bson:",omitempty"`
    CreatedBy bson.ObjectId   `bson:",omitempty"`
    UpdatedBy bson.ObjectId   `bson:",omitempty"`
    DeletedBy bson.ObjectId   `bson:",omitempty"`
    Logs      []bson.ObjectId `bson:",omitempty"`
}

type User struct {
    Name  string `bson:"name"`
    Model `bson:",inline"`
}

// MarshalJSON 实现:将 User 序列化为固定顺序的 JSON 数组
func (u User) MarshalJSON() ([]byte, error) {
    // 按业务约定顺序提取字段(注意:嵌入字段直接通过 u. 字段名访问)
    arr := []interface{}{
        u.Name,
        u.Id,
        u.CreatedAt.Format(time.RFC3339), // 转为标准字符串格式
        u.UpdatedAt.Format(time.RFC3339),
        u.DeletedAt.Format(time.RFC3339),
        u.CreatedBy,
        u.UpdatedBy,
        u.DeletedBy,
        u.Logs,
    }
    return json.Marshal(arr)
}
✅ 关键点说明:嵌入结构体 Model 的字段在 User 中直接可见(如 u.Id, u.CreatedAt),无需额外解包;时间字段建议调用 .Format() 转为字符串(如 RFC3339),避免 json 包默认序列化为 Unix 时间戳或空对象;bson.ObjectId 类型需确保其自身实现了 json.Marshaler(主流驱动如 go.mongodb.org/mongo-driver/bson 已支持),否则需手动转为字符串(u.Id.Hex());若 Logs 字段需进一步扁平化(如只取 ID 字符串切片),可在 MarshalJSON 中做预处理。

? 可选:反向支持 —— 实现 json.Unmarshaler

若还需从数组反序列化回结构体(例如接收前端提交的行数据),则应同时实现 UnmarshalJSON:

SPLASH
SPLASH

将音乐制作的乐趣带给每个人。

下载
func (u *User) UnmarshalJSON(data []byte) error {
    var arr []interface{}
    if err := json.Unmarshal(data, &arr); err != nil {
        return err
    }

    // 按相同顺序赋值(注意类型断言与容错)
    if len(arr) < 1 { return json.ErrUnexpectedEndOfJSON }
    if name, ok := arr[0].(string); ok { u.Name = name }

    if len(arr) < 2 { return json.ErrUnexpectedEndOfJSON }
    if idStr, ok := arr[1].(string); ok {
        if oid := bson.ObjectIdHex(idStr); oid.Valid() {
            u.Id = oid
        }
    }

    // 后续字段依此类推……建议封装辅助函数避免重复逻辑
    return nil
}

⚠️ 注意:UnmarshalJSON 必须使用指针接收器(*User),否则无法修改原结构体。

? 总结与建议

  • 不推荐反射方案:问题中尝试的 reflect 方法虽灵活,但难以安全处理嵌入结构体递归展开、类型转换(如 time.Time → string)、omitempty 逻辑及 bson.ObjectId 等自定义类型,易出错且性能较差;
  • 优先选择显式 MarshalJSON:语义清晰、编译期检查、易于单元测试、便于团队协作维护;
  • 字段顺序即契约:前端 iota 枚举必须与 MarshalJSON 中 []interface{} 的索引严格一致,建议在代码中添加注释或常量定义(如 const (NameIdx = iota; IdIdx; CreatedAtIdx ));
  • 扩展性提示:若多个结构体需同类数组化,可抽象为泛型函数(Go 1.18+)或接口组合,但需权衡简洁性与复杂度。

通过上述方式,你即可稳定、高效地将嵌入结构体转换为前端友好的扁平数组,真正实现“一次定义,处处可用”的数据契约。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

400

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

528

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

306

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

67

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

311

2023.08.02

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1428

2023.10.24

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

616

2023.07.31

python中的format是什么意思
python中的format是什么意思

python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

425

2024.06.27

虚拟号码教程汇总
虚拟号码教程汇总

本专题整合了虚拟号码接收验证码相关教程,阅读下面的文章了解更多详细操作。

25

2025.12.25

热门下载

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

精品课程

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

共101课时 | 8万人学习

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

共39课时 | 3.1万人学习

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

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