0

0

将 Go 结构体(含嵌入结构体)按指定顺序序列化为 JSON 数组

霞舞

霞舞

发布时间:2025-12-26 11:15:18

|

507人浏览过

|

来源于php中文网

原创

将 Go 结构体(含嵌入结构体)按指定顺序序列化为 JSON 数组

本文介绍如何通过实现 `json.marshaler` 接口,将 go 中的结构体(包括嵌入字段)高效、可控地转换为扁平化的 json 数组,适用于前端表格渲染等需紧凑数据格式的场景。

在 Web 开发中,尤其是与前端表格库(如 DataTables、Handsontable)配合时,常需将结构化数据以索引数组(而非键值对象) 形式传输,以节省带宽、提升解析速度,并与预定义列序(如 NAME, ID, CREATED_AT)对齐。Go 原生不支持自动将 struct 转为字段顺序数组,但可通过标准接口优雅实现。

✅ 推荐方案:实现 json.Marshaler

最简洁、类型安全且性能良好的方式是为结构体显式实现 json.Marshaler 接口。它允许你完全控制序列化逻辑,无需反射、无运行时开销,且天然支持嵌入字段展开。

以问题中的 User 和 Model 为例:

Outwrite
Outwrite

AI写作浏览器插件,将您的想法变成有力的句子

下载
import (
    "encoding/json"
    "time"
)

// Model 定义保持不变
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"`
}

// User 显式内嵌 Model,并实现 MarshalJSON
type User struct {
    Name  string `bson:"name"`
    Model `bson:",inline"`
}

// MarshalJSON 将 User 实例序列化为固定顺序的 JSON 数组
// 顺序:[Name, Id, CreatedAt, UpdatedAt, DeletedAt, CreatedBy, UpdatedBy, DeletedBy, Logs]
func (u User) MarshalJSON() ([]byte, error) {
    // 注意:Logs 是 []bson.ObjectId,若需前端可读字符串,建议预转为 []string
    logs := make([]string, len(u.Logs))
    for i, id := range u.Logs {
        logs[i] = id.Hex()
    }

    arr := []interface{}{
        u.Name,
        u.Id.Hex(),                    // 转为字符串 ID(前端友好)
        u.CreatedAt.Format(time.RFC3339),
        u.UpdatedAt.Format(time.RFC3339),
        u.DeletedAt.Format(time.RFC3339),
        u.CreatedBy.Hex(),
        u.UpdatedBy.Hex(),
        u.DeletedBy.Hex(),
        logs,
    }
    return json.Marshal(arr)
}

使用示例:

user := User{
    Name: "kiz",
    Model: Model{
        Id:        bson.NewObjectId(),
        CreatedAt: time.Date(2014, 1, 1, 0, 0, 0, 0, time.UTC),
        UpdatedAt: time.Date(2014, 1, 1, 0, 0, 0, 0, time.UTC),
        DeletedAt: time.Date(2014, 1, 1, 0, 0, 0, 0, time.UTC),
        CreatedBy: bson.NewObjectId(),
        UpdatedBy: bson.NewObjectId(),
        DeletedBy: bson.NewObjectId(),
        Logs:      []bson.ObjectId{bson.NewObjectId()},
    },
}

data, _ := json.Marshal(user)
fmt.Println(string(data))
// 输出:["kiz","...id...","2014-01-01T00:00:00Z","2014-01-01T00:00:00Z",...]

⚠️ 注意事项与进阶建议

  • 字段顺序即契约:数组下标对应前端列定义(如 NAME=0, ID=1),务必与 JS 端 iota 枚举严格一致,变更需前后端同步。
  • 嵌入字段直接访问:因 Model 是匿名字段,u.Id、u.CreatedAt 等可直接访问,无需额外反射或递归处理——这是 Go 嵌入的核心优势。
  • 时间与 ObjectId 格式化:前端通常无法直接解析 time.Time 或 bson.ObjectId,应在 MarshalJSON 中统一转为字符串(如 .Hex() 或 .Format())。
  • 反向解析(可选):如需从数组反序列化,实现 UnmarshalJSON(注意必须用指针接收者):
    func (u *User) UnmarshalJSON(data []byte) error {
        var arr []interface{}
        if err := json.Unmarshal(data, &arr); err != nil {
            return err
        }
        if len(arr) < 9 { return errors.New("insufficient fields") }
        u.Name = arr[0].(string)
        u.Id = bson.ObjectIdHex(arr[1].(string))
        // ... 其余字段解析
        return nil
    }
  • 避免反射方案:原问题中尝试的 reflect 方案存在类型判断复杂、嵌套处理困难、性能损耗及 omitempty 逻辑难以复现等问题,不推荐用于生产。

✅ 总结

通过实现 json.Marshaler,你获得了零依赖、高可控、易测试、高性能的结构体→数组转换能力。它将“字段顺序”这一业务契约显式编码在方法中,比泛型反射更健壮,也比手动拼接更可维护。对于多层嵌入结构,只需在顶层 MarshalJSON 中按需展开字段即可,无需递归或元编程——这正是 Go “显式优于隐式”哲学的完美体现。

相关专题

更多
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

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

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

616

2023.07.31

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

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

425

2024.06.27

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

246

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

203

2023.09.04

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

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

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号