0

0

将 Go 结构体(含嵌入结构体)序列化为有序数组的通用方法

花韻仙語

花韻仙語

发布时间:2025-12-26 13:41:17

|

116人浏览过

|

来源于php中文网

原创

将 Go 结构体(含嵌入结构体)序列化为有序数组的通用方法

本文介绍如何通过实现 `json.marshaler` 接口,将 go 结构体(包括嵌入字段)按预定义顺序转换为 json 数组,适用于前端表格渲染等需紧凑、索引化数据格式的场景。

在 Go 中,标准 json 包默认将结构体序列化为对象(map 形式),但某些前端场景(如 DataTables、SheetJS 或自定义列映射)更倾向接收扁平化、有序的数组(如 ["kiz", "5f1a2b...", "2024-01-01T00:00:00Z", ...]),以节省体积并简化列索引逻辑(如 row[NAME], row[ID])。Go 本身不提供自动反射转数组的内置机制,但可通过显式实现 json.Marshaler 接口安全、高效、可控地达成目标。

✅ 推荐方案:实现 MarshalJSON() 方法

核心思路是:在目标结构体上定义 MarshalJSON() ([]byte, error) 方法,手动构造 []interface{} 切片,并按业务约定顺序填入字段值(含嵌入结构体的字段)。示例如下:

import (
    "encoding/json"
    "time"
)

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

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

// MarshalJSON 实现:将 User 序列化为 JSON 数组
func (u User) MarshalJSON() ([]byte, error) {
    // 按前端所需列顺序:Name, Id, CreatedAt, UpdatedAt, DeletedAt, CreatedBy, UpdatedBy, DeletedBy
    // 注意:Logs 是切片,若需展开可额外处理(如取 len 或首项),此处暂忽略
    arr := []interface{}{
        u.Name,
        u.Id,
        u.CreatedAt.Format(time.RFC3339), // 格式化时间,避免默认 JSON 时间字符串过长
        u.UpdatedAt.Format(time.RFC3339),
        u.DeletedAt.Format(time.RFC3339),
        u.CreatedBy,
        u.UpdatedBy,
        u.DeletedBy,
    }
    return json.Marshal(arr)
}

调用示例:

user := User{
    Name:  "kiz",
    Model: Model{
        Id:        "5f1a2b3c4d5e6f7g8h9i0j1k",
        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.Time{},
        CreatedBy: "admin",
    },
}

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

⚠️ 注意事项与最佳实践

  • 字段顺序即契约:数组索引(0, 1, 2...)必须与前端 NAME, ID, CREATED_AT 等常量严格对齐,建议在代码中用常量定义索引:

    const (
        NAME = iota
        ID
        CREATED_AT
        UPDATED_AT
        DELETED_AT
        // ...
    )
  • 嵌入结构体字段直接访问:因 Model 是匿名嵌入,其字段(如 Id, CreatedAt)在 User 作用域内可直接访问,无需 u.Model.Id —— 这是 Go 嵌入的核心优势。

  • 时间格式统一:time.Time 默认 JSON 序列化为 RFC3339 字符串,但若需 ISO8601 精简格式(如 "2014-01-01"),务必显式调用 Format(),避免前端解析歧义。

    AI帮个忙
    AI帮个忙

    多功能AI小工具,帮你快速生成周报、日报、邮、简历等

    下载
  • 空值与零值处理:omitempty 标签在 MarshalJSON 中不生效,需手动判断(如 if !u.CreatedAt.IsZero())并填入 nil 或占位符(如 "")。

  • 反向支持(Unmarshal):如需从数组反序列化,实现 UnmarshalJSON([]byte) error,注意使用指针接收器:

    func (u *User) UnmarshalJSON(data []byte) error {
        var arr []interface{}
        if err := json.Unmarshal(data, &arr); err != nil {
            return err
        }
        if len(arr) < 3 { return errors.New("array too short") }
        u.Name = toString(arr[0])
        u.Id = toString(arr[1])
        u.CreatedAt = parseTime(arr[2])
        // ... 其余字段
        return nil
    }
  • 性能考量:相比泛型反射方案,此方法零反射开销、类型安全、编译期检查,且易于单元测试和文档化,是生产环境首选。

综上,显式实现 MarshalJSON 是最简洁、高效、可维护的解决方案。它规避了反射的复杂性与运行时风险,将结构体到数组的映射逻辑清晰收口于类型自身,完美契合前后端协同定义的数据契约需求。

相关专题

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

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

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

1428

2023.10.24

if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

703

2023.08.22

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号