Server Sent Events

莫凡是莫烦
685 阅读4分钟

开启掘金成长之旅！这是我参与「掘金日新计划 · 12 月更文挑战」的第20天，点击查看活动详情

Server-Sent Events 规范描述了一个内建的类 EventSource，它能保持与服务器的连接，并允许从中接收事件。

与 WebSocket 类似，其连接是持久的。

但是两者之间有几个重要的区别：

WebSocketEventSource
双向：客户端和服务端都能交换消息单向：仅服务端能发送消息
二进制和文本数据仅文本数据
WebSocket 协议常规 HTTP 协议

与 WebSocket 相比，EventSource 是与服务器通信的一种不那么强大的方式。

我们为什么要使用它？

主要原因：简单。在很多应用中，WebSocket 有点大材小用。

我们需要从服务器接收一个数据流：可能是聊天消息或者市场价格等。这正是 EventSource 所擅长的。它还支持自动重新连接，而在 WebSocket 中这个功能需要我们手动实现。此外，它是一个普通的旧的 HTTP，不是一个新协议。

获取消息

要开始接收消息，我们只需要创建 new EventSource(url) 即可。

浏览器将会连接到 url 并保持连接打开，等待事件。

服务器响应状态码应该为 200，header 为 Content-Type: text/event-stream，然后保持此连接并以一种特殊的格式写入消息，就像这样：

data: Message 1

data: Message 2

data: Message 3
data: of two lines
  • data: 后为消息文本，冒号后面的空格是可选的。
  • 消息以双换行符 \n\n 分隔。
  • 要发送一个换行 \n，我们可以在要换行的位置立即再发送一个 data:（上面的第三条消息）。

在实际开发中，复杂的消息通常是用 JSON 编码后发送。换行符在其中编码为 \n，因此不需要多行 data: 消息。

例如：

data: {"user":"John","message":"First line\n Second line"}

……因此，我们可以假设一个 data: 只保存了一条消息。

对于每个这样的消息，都会生成 message 事件：

let eventSource = new EventSource("/events/subscribe");

eventSource.onmessage = function(event) {
  console.log("New message", event.data);
  // 对于上面的数据流将打印三次
};

// 或 eventSource.addEventListener('message', ...)

跨源请求

EventSource 支持跨源请求，就像 fetch 和任何其他网络方法。我们可以使用任何 URL：

let source = new EventSource("https://another-site.com/events");

远程服务器将会获取到 Origin header，并且必须以 Access-Control-Allow-Origin 响应来处理。

要传递凭证（credentials），我们应该设置附加选项 withCredentials，就像这样：

let source = new EventSource("https://another-site.com/events", {
  withCredentials: true
});

更多关于跨源 header 的详细内容，请参见 Fetch：跨源请求。

重新连接

创建之后，new EventSource 连接到服务器，如果连接断开 —— 则重新连接。

这非常方便，我们不用去关心重新连接的事情。

每次重新连接之间有一点小的延迟，默认为几秒钟。

服务器可以使用 retry: 来设置需要的延迟响应时间（以毫秒为单位）。

retry: 15000
data: Hello, I set the reconnection delay to 15 seconds

retry: 既可以与某些数据一起出现，也可以作为独立的消息出现。

在重新连接之前，浏览器需要等待那么多毫秒。甚至更长，例如，如果浏览器知道（从操作系统）此时没有网络连接，它会等到连接出现，然后重试。

  • 如果服务器想要浏览器停止重新连接，那么它应该使用 HTTP 状态码 204 进行响应。
  • 如果浏览器想要关闭连接，则应该调用 eventSource.close()：
let eventSource = new EventSource(...);

eventSource.close();

并且，如果响应具有不正确的 Content-Type 或者其 HTTP 状态码不是 301，307，200 和 204，则不会进行重新连接。在这种情况下，将会发出 "error" 事件，并且浏览器不会重新连接。

请注意：

当连接最终被关闭时，就无法“重新打开”它。如果我们想要再次连接，只需要创建一个新的 EventSource。

消息 id

当一个连接由于网络问题而中断时，客户端和服务器都无法确定哪些消息已经收到哪些没有收到。

为了正确地恢复连接，每条消息都应该有一个 id 字段，就像这样：

data: Message 1
id: 1

data: Message 2
id: 2

data: Message 3
data: of two lines
id: 3

当收到具有 id 的消息时，浏览器会：

  • 将属性 eventSource.lastEventId 设置为其值。
  • 重新连接后，发送带有 id 的 header Last-Event-ID，以便服务器可以重新发送后面的消息。

把 id: 放在 data: 后

请注意：id 被服务器附加到 data 消息后，以确保在收到消息后 lastEventId 会被更新。

avatar
文章
阅读
粉丝