0

0

Golang Web接口如何返回流式JSON_json.Encoder流式处理

P粉602998670

P粉602998670

发布时间:2026-02-11 12:33:11

|

123人浏览过

|

来源于php中文网

原创

json.Encoder能流式返回是因为它直接写入io.Writer边编码边发送,不缓存全量数据;而json.Marshal必须将整个结构序列化为[]byte后才返回,导致大数组易OOM或超时。

golang web接口如何返回流式json_json.encoder流式处理

为什么 json.Encoder 能流式返回,而 json.Marshal 不能

因为 json.Marshal 必须把整个数据结构序列化成 []byte 才能返回,内存里存着完整 JSON 字符串;json.Encoder 直接写入 io.Writer(比如 HTTP 响应体),边编码边发,不攒全量。适合大数组、实时日志、长连接推送等场景。

常见错误现象:json.Marshal 处理几万条记录时 OOM 或响应超时;用 fmt.Fprintf(w, "%s", jsonStr) 拼接多段 JSON 导致格式非法(缺逗号、括号不闭合)。

  • 必须设置 Content-Type: application/json,否则前端可能不解析流式内容
  • HTTP/1.1 下需禁用缓存:w.Header().Set("Cache-Control", "no-cache")
  • 不要调用 w.WriteHeader() 太早——json.Encoder 第一次写入时会自动触发状态码发送,提前写可能冲突

json.Encoder 返回数组流的正确姿势

典型需求:查数据库分页游标扫描,逐条 encode 并 flush。不能先 collect 到 slice 再 encode,那就失去流式意义了。

关键点是手动控制 JSON 数组结构:开头写 [,每条数据后写 ,(除最后一条),结尾写 ]。但更稳妥的做法是用换行分隔(NDJSON),避免语法校验和客户端解析负担。

立即学习go语言免费学习笔记(深入)”;

Interior AI
Interior AI

AI室内设计,上传室内照片自动帮你生成多种风格的室内设计图

下载
  • 推荐 NDJSON(每行一个合法 JSON 对象):encoder.Encode(item) 每次调用都输出完整对象 + 换行,无需手动拼括号和逗号
  • 若坚持标准 JSON 数组,需手动写 [],并在首次写后记录是否已写过元素,控制逗号逻辑
  • 每次 encoder.Encode() 后建议 w.(http.Flusher).Flush()(确认 w 支持),否则底层缓冲可能滞留
encoder := json.NewEncoder(w)
w.Header().Set("Content-Type", "application/x-ndjson")
for rows.Next() {
    var item MyStruct
    if err := rows.Scan(&item); err != nil {
        http.Error(w, err.Error(), http.StatusInternalServerError)
        return
    }
    encoder.Encode(item) // 自动加换行
    if f, ok := w.(http.Flusher); ok {
        f.Flush()
    }
}

json.Encoder 在 HTTP 长连接中容易卡住的几个原因

不是代码写错了,而是网络层或客户端行为导致“看起来没数据”。最常被忽略的是 TCP 缓冲和 HTTP 分块编码交互问题。

  • Go 的 http.Server 默认启用 HTTP/1.1 分块传输(chunked),但某些反向代理(如 Nginx 默认配置)会缓冲第一个 chunk,直到收到 EOF 或缓冲满才转发 —— 这就造成“前端收不到首条数据”
  • 客户端(尤其是浏览器 fetch)对流式 JSON 支持有限:不支持标准 JSON 数组流,只认 NDJSON 或自定义分隔符;且需设置 responseType: 'text' + 手动按行解析
  • 如果 handler 中有 panic 或未捕获 error,json.Encoder 可能已写部分字节,但连接被断开,客户端收到截断 JSON

兼容性与性能要注意的边界情况

json.Encoder 本身很轻量,但实际吞吐受制于三处:序列化耗时、I/O 写入速度、客户端消费能力。别假设“用了流式就一定快”。

  • 结构体字段太多或嵌套深时,json.Encoder 序列化开销仍存在,可考虑预计算字段或用 ffjson/easyjson 替代(但会牺牲可维护性)
  • 并发写同一个 json.Encoder 实例会 panic —— 每个请求必须新建 json.Encoder,它不保证并发安全
  • Go 1.21+ 支持 json.Encoder.SetEscapeHTML(false) 关闭 HTML 转义,减少小字符串开销;旧版本只能靠自定义 marshaler

真正难的从来不是怎么调用 json.Encoder.Encode(),而是判断该不该流、谁来负责断连重试、怎么让前端稳定解析每一行。这些不在函数签名里,但在生产环境天天出问题。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

206

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

233

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

345

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

212

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

401

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

322

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

197

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

762

2025.06.17

Rust异步编程与Tokio运行时实战
Rust异步编程与Tokio运行时实战

本专题聚焦 Rust 语言的异步编程模型,深入讲解 async/await 机制与 Tokio 运行时的核心原理。内容包括异步任务调度、Future 执行模型、并发安全、网络 IO 编程以及高并发场景下的性能优化。通过实战示例,帮助开发者使用 Rust 构建高性能、低延迟的后端服务与网络应用。

1

2026.02.11

热门下载

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

精品课程

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

共101课时 | 9.1万人学习

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

共39课时 | 3.3万人学习

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

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