当前位置:首页 > 文章列表 > Golang > Go问答 > Go map 用什么类型的键才能转成 JSON

Go map 用什么类型的键才能转成 JSON

来源:17golang原创 2026-09-05 22:33:01 0浏览 收藏

把 Go 的 map 传给 json.Marshal 时,最容易踩的坑不是值类型,而是键类型。结论先说:默认的 encoding/json 可以把字符串类型、整数类型,或实现 encoding.TextMarshaler 的键编码成 JSON 对象名;结构体、浮点数、指针等键不能直接这样编码。

要点速览
  • map[string]T 最直接;整数键会被转换成 JSON 字符串键。
  • 自定义键可以实现 encoding.TextMarshaler,由 MarshalText 返回属性名。
  • 如果键无法稳定表示为文本,改成对象切片通常比强行套 map 更清楚。

先看 json.Marshal 接受哪些 map 键

JSON 对象的键只能是字符串,而 Go 的 map 键可以比字符串丰富得多。因此编码器必须先把 Go 键收敛为对象名。官方文档给出的规则是:任意字符串类型直接使用;整数类型转成字符串;实现 encoding.TextMarshaler 的键调用 MarshalText 后使用返回文本。

Go encoding/json 将字符串键、整数键和 TextMarshaler 键映射为 JSON 对象名的静态结构框图
图1:查看 Go map 键到 JSON 对象名的三条静态映射边界,判断当前键是否具备可表示的文本形式。

这个规则解释了一个常见现象:map[bool]string、map[float64]string 或 map[Point]string 在调用 json.Marshal 时,会返回 json: unsupported type 一类错误。不是 map 不能编码,而是对象名没有默认转换规则。

用 string 和整数键完成直接编码

字符串键无需额外处理:

package main

import (
    "encoding/json"
    "fmt"
)

type UserID int

func main() {
    byName := map[string]int{"alice": 2, "bob": 1}
    byID := map[int]string{7: "ready", 42: "running"}
    byTypedID := map[UserID]string{1001: "active"}

    for _, value := range []any{byName, byID, byTypedID} {
        data, err := json.Marshal(value)
        if err != nil {
            panic(err)
        }
        fmt.Println(string(data))
    }
}

byName 的键保持为字符串;byID 的数字键会成为 "7" 和 "42";底层类型为整数的命名类型也属于整数键。解码时要注意,JSON 对象名仍然是字符串,目标 map 若使用整数键,Unmarshal 会按目标整数类型解析。

让自定义键实现 encoding.TextMarshaler

日期、枚举或租户标识经常希望保留自己的展示格式。这时不要把键改成含义不明的整数,可以让它实现文本接口:

type Month struct {
    Year  int
    Month int
}

func (m Month) MarshalText() ([]byte, error) {
    return []byte(fmt.Sprintf("%04d-%02d", m.Year, m.Month)), nil
}

func main() {
    sales := map[Month]int{
        {Year: 2026, Month: 9}: 18,
        {Year: 2026, Month: 10}: 23,
    }

    data, err := json.Marshal(sales)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(data))
}

这里的关键不是实现了任意一个字符串方法,而是准确实现 encoding.TextMarshaler。返回文本应当稳定、可读,并且能在业务上唯一标识原键。若两个不同的 Go 键返回相同文本,编码后的 JSON 对象名就会发生碰撞,设计上应先避免这种情况。

Go 自定义 Month 键通过 encoding.TextMarshaler 生成 JSON 日期属性名的静态关系图
图2:查看 Month、MarshalText、文本属性名和 JSON 对象之间的静态关系,理解自定义键的转换责任落在哪里。

结构体、浮点数和指针键不能直接套用

Go 允许结构体作为 map 键,只要结构体可比较;但“可比较”只解决 map 存储问题,不等于它有 JSON 对象名。下面这些写法都不适合作为默认 JSON 对象键:

Go 键类型默认 Marshal更合适的处理
string、整数及其命名类型支持直接编码
实现 TextMarshaler 的类型支持保证文本唯一且稳定
bool、float、指针、普通结构体不支持为对象键改为 string 或对象切片

例如点位统计可以改成 []PointValue,显式保留 x、y 和 value 字段。这样 JSON 结构不依赖隐式键格式,也更方便前端校验;如果确实需要对象形式,就为点类型定义无歧义的 MarshalText。

检查键排序与反序列化边界

默认 encoding/json 会对 map 键排序后输出,所以同一组字符串键通常得到稳定文本;这适合日志、缓存键或测试比较,但不要把 JSON 文本顺序当成业务排序。需要展示顺序时,用切片表达顺序更可靠。

反序列化 JSON 对象到 map 时,目标键必须是字符串类型、整数类型,或实现 encoding.TextUnmarshaler。因此只实现 MarshalText 还不够:如果接口需要 JSON 往返,就要同时设计反向解析,并为非法文本返回明确错误。

常见问题

为什么 map[int]string 能转 JSON,但 map[bool]string 不行?

整数有明确的十进制字符串表示,标准库规定把它转成对象名;布尔键没有默认的 JSON 对象键规则,所以不能直接编码。

自定义 map 键实现 String() 可以吗?

仅实现 String() 不够。应实现 encoding.TextMarshaler,让编码器明确知道如何得到键文本。

为什么输出的 map 键顺序和插入顺序不同?

map 本身不提供业务插入顺序,encoding/json 会按规则处理键顺序。需要固定展示顺序时,请显式使用排序后的切片。

排查这类问题时,先看键是否能收敛成唯一文本,再看值是否可编码,最后决定是补齐文本接口还是调整 JSON 数据结构。这样比只围绕报错字符串反复改类型更快。

版本声明
本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
产品标签用热敏纸还是热转印标签更合适产品标签用热敏纸还是热转印标签更合适
上一篇
产品标签用热敏纸还是热转印标签更合适
深海荧光珊瑚壁纸怎么生成低亮度锁屏背景
下一篇
深海荧光珊瑚壁纸怎么生成低亮度锁屏背景
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • PubMedQA数据集详解:生物医学问答基准、功能与应用指南
    PubMedQA
    深入了解PubMedQA生物医学问答数据集,涵盖其核心功能、使用方法及在临床决策、药物研发等场景的应用,助力提升NLP模型性能。
    573次使用
  • H2O EvalGPT:开源LLM大模型评估与排行榜工具
    H2O EvalGPT
    H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
    616次使用
  • LMArena是什么?伯克利AI模型评估平台使用指南与功能解析
    LMArena
    LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
    646次使用
  • 斯坦福HELM:大语言模型Holistic Evaluation整体评估框架详解
    HELM
    深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
    605次使用
  • MMBench详解:多模态大模型基准测试、功能特点与使用指南
    MMBench
    MMBench是由上海人工智能实验室等机构联合推出的多模态基准测试平台,提供细粒度能力评估、大规模数据集及VLMEvalKit工具。本文详细介绍其核心功能、安装使用方法及应用场景,助力开发者全面评估多模态模型性能。
    422次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议 和 隐私政策
返回登录
  • 重置密码