讲师中心 微信公众号
AI工具推荐 视频效率加速

Go 中自定义错误类型的 JSON 序列化实践

雨墨大大_7054

雨墨大大_7054

发布时间:2026-01-21 18:51:31

|

281人浏览过

|

来源于php中文网

原创

Go 中自定义错误类型的 JSON 序列化实践

在 go 的 json api 开发中,直接将实现了 `error` 接口的结构体序列化为 {"error": "message"} 形式需手动实现 json.marshaler,因为标准 json.marshal 无法自动提取未导出字段或 error 接口的底层字符串。

Go 的 encoding/json 包在序列化时依赖反射(reflection),而绝大多数 error 类型(如 errors.New 返回的 *errors.errorString)内部字段是非导出的(unexported),因此默认无法被 JSON 编码器访问。你最初尝试的嵌入 Err error 字段的方式之所以输出 {"error":{}},是因为 json 包对空接口或未导出字段仅能序列化为空对象 {},而非其字符串表示。

要实现预期的 JSON 错误格式,最简洁可靠的方式是让自定义错误类型显式实现 json.Marshaler 接口:

type JsonErr struct {
    error // 匿名嵌入,复用 Error() 方法
}

func (e JsonErr) MarshalJSON() ([]byte, error) {
    // 注意:需对 error 消息做 JSON 字符串转义,避免注入非法字符(如换行、引号)
    msg := strings.ReplaceAll(e.Error(), `"`, `"`)
    msg = strings.ReplaceAll(msg, ``, `\`)
    msg = strings.ReplaceAll(msg, `
`, `\n`)
    msg = strings.ReplaceAll(msg, `
`, `\r`)
    msg = strings.ReplaceAll(msg, `	`, `\t`)
    return []byte(`{"error": "` + msg + `"}`), nil
}

⚠️ 更安全、推荐的做法是使用 json.Marshal 对消息本身进行转义,而非手动替换:

func (e JsonErr) MarshalJSON() ([]byte, error) {
    type Alias JsonErr // 防止递归调用 MarshalJSON
    data := struct {
        Error string `json:"error"`
    }{
        Error: e.Error(),
    }
    return json.Marshal(data)
}

该方案利用了匿名结构体+内嵌别名技巧,既避免了无限递归(因 Alias 不再实现 MarshalJSON),又借助标准库完成完整的 JSON 转义与格式化,语义清晰且健壮。

dmap-jsapi-skill
dmap-jsapi-skill

DMap GL地图JSAPI(dmapgl)开发指南。用于编写、审查、调试 DMap 地图 API 代码,涵盖地图初始化、覆盖物渲染、图层管理、事件处理、控件交互等任务。当用户提及 dmap、dmapgl、jsapi‑gl 或相关地图开发需求时自动触发。

下载

✅ 使用示例:

err := JsonErr{errors.New(`Invalid request: "user_id" is missing`)}
b, _ := json.Marshal(err)
fmt.Println(string(b)) // 输出:{"error":"Invalid request: "user_id" is missing"}

? 补充建议:

  • 在真实 API 中,可扩展 JsonErr 为包含 Code int、Message string、Details map[string]interface{} 等字段的结构,统一错误响应规范;
  • 始终优先使用 json.Marshal 处理字符串内容,避免手拼 JSON——它能正确处理 Unicode、控制字符和引号转义;
  • 若需全局错误处理(如 HTTP 中间件),可结合 http.Error 或自定义 ErrorResponse 类型统一序列化逻辑。

通过实现 MarshalJSON,你既能保持 error 接口的兼容性,又能精准控制其 JSON 表现形式,是构建健壮、可维护 Go Web API 的关键实践之一。

热门AI工具

更多
UP简历
UP简历 Hot

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

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

豆包大模型

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

WorkBuddy

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

火山引擎

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

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

DeepSeek

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

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

相关专题

更多
什么是中间件
什么是中间件

中间件是一种软件组件,充当不兼容组件之间的桥梁,提供额外服务,例如集成异构系统、提供常用服务、提高应用程序性能,以及简化应用程序开发。想了解更多中间件的相关内容,可以阅读本专题下面的文章。

649

2024.05.11

Golang 中间件开发与微服务架构
Golang 中间件开发与微服务架构

本专题系统讲解 Golang 在微服务架构中的中间件开发,包括日志处理、限流与熔断、认证与授权、服务监控、API 网关设计等常见中间件功能的实现。通过实战项目,帮助开发者理解如何使用 Go 编写高效、可扩展的中间件组件,并在微服务环境中进行灵活部署与管理。

624

2025.12.18

ThinkPHP中间件机制与请求拦截处理实践
ThinkPHP中间件机制与请求拦截处理实践

本专题围绕 ThinkPHP 中间件体系展开,深入讲解中间件的定义、注册与执行流程。内容包括全局中间件与路由中间件的区别、请求前后处理逻辑、自定义中间件开发以及权限验证与日志处理应用。通过实际案例,帮助开发者掌握中间件在项目中的核心作用与最佳实践。

438

2026.03.31

json数据格式
json数据格式

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

2155

2023.08.07

json是什么
json是什么

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

3302

2023.08.23

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

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

1116

2023.10.13

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

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

3779

2025.09.10

string转int
string转int

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

6459

2023.08.02

剧云故事大纲与分场规划教程
剧云故事大纲与分场规划教程

本专题讲解剧云梗概与多级大纲功能,覆盖全局、分集、分场结构生成,以及主线冲突、剧情节点和场次顺序调整。

0

2026.10.22

热门下载

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

精品课程

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

共101课时 | 21.1万人学习

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

共39课时 | 4.9万人学习

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

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