0

0

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

花韻仙語

花韻仙語

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

|

313人浏览过

|

来源于php中文网

原创

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

go 构建 json api 时,需将错误统一格式化为 {"error": "message"} 结构返回;直接嵌入 error 接口或使用未导出字段的结构体无法被标准 json.marshal 正确序列化,必须显式实现 json.marshaler 接口。

要让自定义错误类型(如 JsonErr)在调用 json.Marshal 或 json.NewEncoder.Encode 时输出符合 API 规范的 JSON,核心在于:Go 的 JSON 包不会自动识别 error 接口,也不会序列化未导出字段或接口值本身。若仅定义如下结构:

type JsonErr struct {
    Err error `json:"error"`
}

由于 Err 是接口类型且 error 接口无导出字段,反射机制无法获取其字符串内容,最终序列化结果为 {"error":{}} —— 这显然不符合预期。

✅ 正确做法是让类型实现 json.Marshaler 接口(即添加 MarshalJSON() ([]byte, error) 方法)。推荐采用组合方式嵌入匿名 error 字段,既保留错误语义,又简化实现:

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

func (e JsonErr) MarshalJSON() ([]byte, error) {
    // 注意:需对 error 消息做 JSON 字符串转义,避免注入非法字符
    msg := e.Error()
    escapedMsg, err := json.Marshal(msg)
    if err != nil {
        return nil, err
    }
    return []byte(`{"error":` + string(escapedMsg) + `}`), nil
}

⚠️ 关键注意事项:

成新网络商城购物系统
成新网络商城购物系统

使用模板与程序分离的方式构建,依靠专门设计的数据库操作类实现数据库存取,具有专有错误处理模块,通过 Email 实时报告数据库错误,除具有满足购物需要的全部功能外,成新商城购物系统还对购物系统体系做了丰富的扩展,全新设计的搜索功能,自定义成新商城购物系统代码功能代码已经全面优化,杜绝SQL注入漏洞前台测试用户名:admin密码:admin888后台管理员名:admin密码:admin888

下载
  • 务必使用 json.Marshal(msg) 对错误消息进行转义(如处理双引号、换行符、控制字符等),不可直接拼接字符串,否则可能破坏 JSON 结构或引发安全问题;
  • 若错误本身为 nil,e.Error() 将 panic,因此生产环境建议增加空值检查:
    func (e JsonErr) MarshalJSON() ([]byte, error) {
        if e.error == nil {
            return []byte(`{"error":""}`), nil
        }
        msg := e.Error()
        escapedMsg, err := json.Marshal(msg)
        if err != nil {
            return nil, err
        }
        return []byte(`{"error":` + string(escapedMsg) + `}`), nil
    }

? 扩展建议:可进一步封装通用错误响应结构,支持状态码、时间戳等字段,并配合 HTTP 中间件统一处理错误返回,提升 API 一致性与可观测性。

综上,无需放弃标准 JSON 流程——只需为错误类型提供合规的 MarshalJSON 实现,即可干净、安全、高效地输出结构化错误响应。

相关专题

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

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

178

2024.05.11

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

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

213

2025.12.18

json数据格式
json数据格式

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

415

2023.08.07

json是什么
json是什么

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

533

2023.08.23

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

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

310

2023.10.13

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

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

75

2025.09.10

scripterror怎么解决
scripterror怎么解决

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

188

2023.10.18

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

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

288

2023.10.25

Java编译相关教程合集
Java编译相关教程合集

本专题整合了Java编译相关教程,阅读专题下面的文章了解更多详细内容。

9

2026.01.21

热门下载

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

精品课程

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

共101课时 | 8.4万人学习

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

共39课时 | 3.2万人学习

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

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