0

0

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

花韻仙語

花韻仙語

发布时间:2026-01-21 20:19:12

|

572人浏览过

|

来源于php中文网

原创

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

go 构建 json api 时,需将错误以标准 json 格式(如 {"error": "message"})返回;直接嵌入 error 字段无法自动序列化,须显式实现 json.marshaler 接口。

要让自定义错误类型(如 JsonErr)在调用 json.Marshal 或 json.NewEncoder.Encode 时输出结构化的 JSON 错误响应,关键在于正确实现 json.Marshaler 接口,而非依赖 error 接口本身——因为 encoding/json 包不会对 error 类型做特殊处理,且大多数 error 实现(如 errors.New 返回的 *errors.errorString)内部字段非导出,反射无法访问。

推荐做法是采用内嵌 error 接口 + 自定义 MarshalJSON() 方法的方式,简洁且符合 Go 惯例:

type JsonErr struct {
    error // 内嵌 error,自动获得 Error() 方法
}

func (e JsonErr) MarshalJSON() ([]byte, error) {
    // 安全转义错误消息,避免 JSON 注入(生产环境务必使用)
    msg := strings.ReplaceAll(e.Error(), `"`, `\"`)
    return []byte(`{"error": "` + msg + `"}`), nil
}

⚠️ 注意:上述字符串拼接仅作演示,实际项目中应使用 json.Marshal 处理消息字段以确保 JSON 安全性

AssemblyAI
AssemblyAI

转录和理解语音的AI模型

下载
func (e JsonErr) MarshalJSON() ([]byte, error) {
    type Alias JsonErr // 防止无限递归(避免再次调用本方法)
    return json.Marshal(struct {
        Error string `json:"error"`
    }{
        Error: e.Error(),
    })
}

这样既保持了类型清晰,又利用了标准库的转义与格式化能力。使用示例如下:

func handler(w http.ResponseWriter, r *http.Request) {
    w.Header().Set("Content-Type", "application/json")
    w.WriteHeader(http.StatusBadRequest)
    json.NewEncoder(w).Encode(JsonErr{errors.New("Invalid request syntax")})
}
// 输出:{"error": "Invalid request syntax"}

✅ 总结:

  • 不要试图通过结构体标签(如 json:"error")直接 marshal error 字段——它会变成空对象 {};
  • 必须实现 MarshalJSON() ([]byte, error);
  • 优先使用 json.Marshal 序列化内部字段,而非手动拼接字符串;
  • 可进一步扩展 JsonErr 支持状态码、详情字段等,只需在匿名结构体中添加对应字段即可。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

457

2023.08.07

json是什么
json是什么

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

549

2023.08.23

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

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

337

2023.10.13

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

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

82

2025.09.10

scripterror怎么解决
scripterror怎么解决

scripterror的解决办法有检查语法、文件路径、检查网络连接、浏览器兼容性、使用try-catch语句、使用开发者工具进行调试、更新浏览器和JavaScript库或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

493

2023.10.18

500error怎么解决
500error怎么解决

500error的解决办法有检查服务器日志、检查代码、检查服务器配置、更新软件版本、重新启动服务、调试代码和寻求帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

382

2023.10.25

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

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

761

2023.08.03

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

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

221

2023.09.04

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

49

2026.03.13

热门下载

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

精品课程

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

共101课时 | 10.2万人学习

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

共39课时 | 3.4万人学习

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

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