Golang 微服务框架 kratos 实现 SSE 服务
我也是最近才知道 SSE 的，问了下周围的人，发现知道的人也着实不多的。我是怎么知道 SSE 的呢？我看了下 OpenAI 的 API，有一个 Stream 模式，就是使用的 SSE 实现的。说白了，这就是一个 HTTP 长连接通过服务端持续发送数据到前端的协议。在网络不稳定的情况下，它比 Websocket 要更好。
什么是 SSE
Server-Sent Events（简称 SSE）
严格地说，HTTP 协议无法做到服务器主动推送信息。但是，有一种变通方法，就是服务器向客户端声明，接下来要发送的是流信息（streaming）。
也就是说，发送的不是一次性的数据包，而是一个数据流，会连续不断地发送过来。这时，客户端不会关闭连接，会一直等着服务器发过来的新的数据流，视频播放就是这样的例子。本质上，这种通信就是以流信息的方式，完成一次用时很长的下载。
SSE 与 WebSocket 作用相似，都是建立浏览器与服务器之间的通信渠道，然后服务器向浏览器推送信息。
总体来说，WebSocket 更强大和灵活。因为它是全双工通道，可以双向通信；SSE 是单向通道，只能服务器向浏览器发送，因为流信息本质上就是下载。如果浏览器向服务器发送信息，就变成了另一次 HTTP 请求。
但是，SSE 也有自己的优点：
SSE 使用 HTTP 协议，现有的服务器软件都支持。WebSocket 是一个独立协议。
SSE 属于轻量级，使用简单；WebSocket 协议相对复杂。
SSE 默认支持断线重连，WebSocket 需要自己实现。
SSE 一般只用来传送文本，二进制数据需要编码后传送，WebSocket 默认支持传送二进制数据。
SSE 支持自定义发送的消息类型。
因此，两者各有特点，适合不同的场合。
协议描述
数据格式
服务器向浏览器发送的 SSE 数据，必须是 UTF-8 编码的文本，具有如下的 HTTP 头信息：
Content-Type: text/event-streamCache-Control: no-cacheConnection: keep-alive
复制代码
上面三行之中，第一行的Content-Type必须指定 MIME 类型为event-steam。
每一次发送的信息，由若干个message组成，每个message之间用\n\n分隔。每个message内部由若干行组成，每一行都是如下格式：
上面的field可以取四个值：
此外，还可以有冒号开头的行，表示注释。通常，服务器每隔一段时间就会向浏览器发送一个注释，保持连接不中断：
下面是一个例子：
: this is a test stream\n\n
data: some text\n\n
data: another message\ndata: with two lines \n\n
复制代码
data 字段
数据内容用data字段表示：
如果数据很长，可以分成多行，最后一行用\n\n结尾，前面行都用\n结尾。
data: begin message\ndata: continue message\n\n
复制代码
下面是一个发送 JSON 数据的例子：
data: {\ndata: "foo": "bar",\ndata: "baz", 555\ndata: }\n\n
复制代码
id 字段
数据标识符用id字段表示，相当于每一条数据的编号。
id: msg1\ndata: message\n\n
复制代码
浏览器用lastEventId属性读取这个值。一旦连接断线，浏览器会发送一个 HTTP 头，里面包含一个特殊的Last-Event-ID头信息，将这个值发送回来，用来帮助服务器端重建连接。因此，这个头信息可以被视为一种同步机制。
event 字段
event字段表示自定义的事件类型，默认是message事件。浏览器可以用addEventListener()监听该事件。
event: foo\ndata: a foo event\n\n
data: an unnamed event\n\n
event: bar\ndata: a bar event\n\n
复制代码
上面的代码创造了三条信息。第一条的名字是foo，触发浏览器的foo事件；第二条未取名，表示默认类型，触发浏览器的message事件；第三条是bar，触发浏览器的bar事件。
下面是另一个例子：
event: userconnectdata: {"username": "bobby", "time": "02:33:48"}
event: usermessagedata: {"username": "bobby", "time": "02:34:11", "text": "Hi everyone."}
event: userdisconnectdata: {"username": "bobby", "time": "02:34:23"}
event: usermessagedata: {"username": "sean", "time": "02:34:36", "text": "Bye, bobby."}
复制代码
retry 字段
服务器可以用 retry 字段，指定浏览器重新发起连接的时间间隔。
两种情况会导致浏览器重新发起连接：一种是时间间隔到期，二是由于网络错误等原因，导致连接出错。
Kratos 服务端
首先安装库：
go get -u github.com/tx7do/kratos-transport/transport/sse
复制代码
然后实现一个简单的服务端：
package main
import ( "context" "errors" "os" "os/signal" "syscall" "time"
"github.com/tx7do/kratos-transport/transport/sse")
func main() { interrupt := make(chan os.Signal, 1) signal.Notify(interrupt, syscall.SIGHUP, syscall.SIGINT, syscall.SIGTERM, syscall.SIGQUIT) ctx := context.Background() s := sse.NewServer( sse.WithAddress(":8800"), ) defer s.Stop(ctx) s.HandleServeHTTP("/events") s.CreateStream("test") go func() { s.Start(ctx) }() s.Publish("test", &Event{Data: []byte("test")}) <-interrupt}
复制代码
JS 客户端
<!DOCTYPE html><html lang="en"><head> <title>SSE Client</title> <meta charset='utf-8'> <meta http-equiv='X-UA-Compatible' content='IE=edge'> <meta name='viewport' content='width=device-width, initial-scale=1'></head><body><div> <ul id="messages"> </ul></div>
<script> if (window.EventSource == null) { alert('The browser does not support Server-Sent Events'); }
const eventSource = new EventSource("http://localhost:8800/events?stream=test")
// 在事件源连接未能打开时触发。 eventSource.onerror = function (error) { console.log('connection state: ' + eventSource.readyState + ', error: ' + error); };
// 在与事件源的连接打开时触发。 eventSource.onopen = function () { console.log('connection is established'); };
// 在从事件源接收到数据时触发。 eventSource.onmessage = (event) => { console.log('id: ' + event.lastEventId + ', data: ' + event.data); //console.log(JSON.parse(event.data)) const ul = document.getElementById("messages"); const li = document.createElement("li"); li.appendChild(document.createTextNode(`${event.data}`)); li.setAttribute("id", "element4"); ul.appendChild(li); }</script></body></html>
复制代码
参考资料 (Reference)
评论