Iris 默认路由因Compress、CORS、Logger中间件篡改响应头/状态导致SSE失败;须用DisableBodyConsumption(true)注册无中间件路由,并在handler开头设头、Flush;推送需单goroutine+channel模型,含心跳防断连。

为什么 Iris 默认路由会静默破坏 SSE
Iris 的默认中间件链(如 Logger、Compress、CORS)会在 handler 执行前或后篡改响应状态和头信息,导致 SSE 失败。典型表现是前端 EventSource 一直卡在 connecting 状态,控制台无报错,但收不到任何事件。
根本原因有三个:
-
Compress中间件会重写Content-Type为text/event-stream; charset=utf-8或添加Content-Encoding: gzip,而浏览器只认严格等于text/event-stream的类型 -
CORS中间件可能提前调用WriteHeader(200),导致你后续设置的Cache-Control、Connection等头被忽略 -
Logger中间件在 handler 返回后才写日志,但 SSE 要求连接长期存活,它会阻塞Flush()调用时机
解决办法只有一个:用 app.Get("/events", handler).DisableBodyConsumption(true) 注册无中间件路由,并显式禁用请求体解析——SSE 是 GET 长连接,不需要读 body。
如何正确设置响应头并确保立即 flush
必须在 handler 开头就完成响应头设置和首次 flush,否则客户端无法建立流式连接。Iris 的 Context.ResponseWriter() 实现了 http.Flusher,但需手动断言。
关键操作顺序不能错:
- 调用
ctx.ContentType("text/event-stream")(注意:不要加; charset=utf-8) - 手动设置
ctx.Header("Cache-Control", "no-cache")和ctx.Header("Connection", "keep-alive") - 手动设置
ctx.Header("X-Accel-Buffering", "no")(防 Nginx 缓冲) - 立刻获取
flusher := ctx.ResponseWriter().Flusher(),并调用flusher.Flush() - 检查
flusher是否可用,不可用直接 return 500
示例片段:
func sseHandler(ctx iris.Context) {
ctx.ContentType("text/event-stream")
ctx.Header("Cache-Control", "no-cache")
ctx.Header("Connection", "keep-alive")
ctx.Header("X-Accel-Buffering", "no")
<pre class="brush:php;toolbar:false;">flusher, ok := ctx.ResponseWriter().Flusher()
if !ok {
ctx.StatusCode(500)
ctx.WriteString("streaming not supported")
return
}
flusher.Flush() // 必须立刻 flush,否则前端卡住
// 后续每条事件都要 fmt.Fprintf + flusher.Flush()
}
goroutine + channel 安全推送模型怎么写
SSE 连接生命周期长,必须为每个连接分配独立 goroutine,避免并发写入同一 ResponseWriter 导致 panic 或数据错乱。
推荐结构是:handler 启动一个 goroutine 监听 channel,主协程只负责初始化和返回;channel 由业务逻辑(如消息总线、Redis pub/sub 回调)写入。
- 每个连接绑定一个
chan sseMessage,避免全局 channel 竞态 -
sseMessage结构体应包含ID string、Event string、Payload string字段,便于格式化 - 写事件时用
fmt.Fprintf(w, "id: %s\nevent: %s\ndata: %s\n\n", msg.ID, msg.Event, msg.Payload),结尾必须是双换行 - 每次写完必须调
flusher.Flush(),并检查 error:若err != nil且非net.ErrClosed或syscall.EPIPE,应关闭 channel 并 return - 别直接
json.Marshal塞进data:字段——中文、换行符、双引号都会破坏 SSE 格式;先strings.ReplaceAll(payload, "\n", "\ndata: ")
生产环境必须加心跳,否则 Nginx/ALB 会静默断连
真实链路中,Nginx 默认 proxy_read_timeout 60s,ALB 可配但最小也 60s,而 Go http.Server.WriteTimeout 默认几分钟也会关连接。纯靠业务消息保活不可靠——消息可能稀疏,一断就是 60 秒以上。
解决方案是服务端每 25 秒发一条注释心跳:
- 用
fmt.Fprint(w, ":heartbeat\n\n")(冒号开头的行是注释,EventSource自动忽略) - 心跳必须和业务消息走同一个 goroutine + channel 模型,否则并发写冲突
- 心跳 timer 应在 channel 监听 goroutine 内部启动,避免跨 goroutine 控制 flush
- Go 侧建议设
srv := &http.Server{WriteTimeout: 0, ReadHeaderTimeout: 10 * time.Second},彻底禁用写超时 - Nginx 配置必须加:
proxy_read_timeout 300;、proxy_buffering off;、proxy_cache off;
最容易被忽略的是:心跳不能只依赖 time.Ticker 单独起 goroutine 往 ResponseWriter 写——那会和主推送 goroutine 竞争写权限,导致 panic 或乱序。所有输出必须串行经过同一个 flusher。
golang免费学习笔记(深入):立即使用
在学习笔记中,你将探索golang的核心概念和高级技巧!











