2024年1月17日 (三) 10:51的版本

Server-Sent Events (SSE) is a server push technology enabling a client to receive automatic updates from a server via an HTTP connection, and describes how servers can initiate data transmission towards clients once an initial client connection has been established. They are commonly used to send message updates or continuous data streams to a browser client and designed to enhance native, cross-browser streaming through a JavaScript API called EventSource, through which a client requests a particular URL in order to receive an event stream. The EventSource API is standardized as part of HTML5 by the WHATWG. The media type for SSE is text/event-stream.

严格地说，HTTP 协议无法做到服务器主动推送信息。但是，有一种变通方法，就是服务器向客户端声明，接下来要发送的是流信息（streaming）。

也就是说，发送的不是一次性的数据包，而是一个数据流，会连续不断地发送过来。这时，客户端不会关闭连接，会一直等着服务器发过来的新的数据流，视频播放就是这样的例子。本质上，这种通信就是以流信息的方式，完成一次用时很长的下载。

SSE 就是利用这种机制，使用流信息向浏览器推送信息。它基于 HTTP 协议，目前除了 IE/Edge，其他浏览器都支持。^[1]

SSE vs WebSocket

SSE 使用 HTTP 协议，现有的服务器软件都支持。WebSocket 是一个独立协议。
SSE 属于轻量级，使用简单；WebSocket 协议相对复杂。
SSE 默认支持断线重连，WebSocket 需要自己实现。
SSE 一般只用来传送文本，二进制数据需要编码后传送，WebSocket 默认支持传送二进制数据。
SSE 支持自定义发送的消息类型。

实现

服务器向浏览器发送的 SSE 数据，必须是 UTF-8 编码的文本，具有如下的 HTTP 头信息。

Content-Type: text/event-stream
Cache-Control: no-cache
Connection: keep-alive

上面三行之中，第一行的Content-Type必须指定 MIME 类型为event-steam。

每一次发送的信息，由若干个message组成，每个message之间用\n\n分隔。每个message内部由若干行组成，每一行都是如下格式。

[field]: value\n

上面的field可以取四个值。

data
event
id
retry

此外，还可以有冒号开头的行，表示注释。通常，服务器每隔一段时间就会向浏览器发送一个注释，保持连接不中断。

: This is a comment

下面是一个例子。

: this is a test stream\n\n

data: some text\n\n

data: another message\n
data: with two lines \n\n

↑ https://www.ruanyifeng.com/blog/2017/05/server-sent_events.html

[1] ttps://www.ruanyifeng.com/blog/2017/05/server-sent_events.html

[1]

@@ 第1行： / 第1行： @@
 Server-Sent Events (SSE) is a server push technology enabling a client to receive automatic updates from a server via an HTTP connection, and describes how servers can initiate data transmission towards clients once an initial client connection has been established. They are commonly used to send message updates or continuous data streams to a browser client and designed to enhance native, cross-browser streaming through a JavaScript API called EventSource, through which a client requests a particular URL in order to receive an event stream. The EventSource API is standardized as part of HTML5 by the WHATWG. The media type for SSE is <syntaxhighlight lang="bash" inline>text/event-stream</syntaxhighlight>.
+严格地说，HTTP 协议无法做到服务器主动推送信息。但是，有一种变通方法，就是服务器向客户端声明，接下来要发送的是流信息（streaming）。
+也就是说，发送的不是一次性的数据包，而是一个数据流，会连续不断地发送过来。这时，客户端不会关闭连接，会一直等着服务器发过来的新的数据流，视频播放就是这样的例子。本质上，这种通信就是以流信息的方式，完成一次用时很长的下载。
+SSE 就是利用这种机制，使用流信息向浏览器推送信息。它基于 HTTP 协议，目前除了 IE/Edge，其他浏览器都支持。<ref>https://www.ruanyifeng.com/blog/2017/05/server-sent_events.html</ref>
+= SSE vs WebSocket =
+* SSE 使用 HTTP 协议，现有的服务器软件都支持。WebSocket 是一个独立协议。
+* SSE 属于轻量级，使用简单；WebSocket 协议相对复杂。
+* SSE 默认支持断线重连，WebSocket 需要自己实现。
+* SSE 一般只用来传送文本，二进制数据需要编码后传送，WebSocket 默认支持传送二进制数据。
+* SSE 支持自定义发送的消息类型。
+= 实现 =
+服务器向浏览器发送的 SSE 数据，必须是 UTF-8 编码的文本，具有如下的 HTTP 头信息。
+<syntaxhighlight lang="http">
+Content-Type: text/event-stream
+Cache-Control: no-cache
+Connection: keep-alive
+</syntaxhighlight>
+上面三行之中，第一行的Content-Type必须指定 MIME 类型为event-steam。
+每一次发送的信息，由若干个message组成，每个message之间用\n\n分隔。每个message内部由若干行组成，每一行都是如下格式。
+<syntaxhighlight lang="bash">
+[field]: value\n
+</syntaxhighlight>
+上面的field可以取四个值。
+* data
+* event
+* id
+* retry
+此外，还可以有冒号开头的行，表示注释。通常，服务器每隔一段时间就会向浏览器发送一个注释，保持连接不中断。
+<syntaxhighlight lang="php">
+: This is a comment
+</syntaxhighlight>
+下面是一个例子。
+<syntaxhighlight lang="bash">
+: this is a test stream\n\n
+data: some text\n\n
+data: another message\n
+data: with two lines \n\n
+</syntaxhighlight>
 [[Category:HTTP]]
 [[Category:Network]]
 [[Category:Protocol]]