Server-Sent Events

316 阅读3分钟

概念

服务器向客户端声明,接下来要发送的是流信息(streaming)。

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

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

SSE 是单向通道,只能服务器向浏览器发送,因为流信息本质上就是下载。如果浏览器向服务器发送信息,就变成了另一次 HTTP 请求。

优点

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

自动重连机制

前文说SSE 默认支持断线重连,并不是 EventSource 存在重连机制,而是浏览器会对断开的连接进行重连操作。通过配置 EventSource 的 retry 时间来控制重连的时间间隔。默认时间间隔是3秒。

当然我们也可以手动控制重连:

  1. 监听 onerror 事件:在 onerror 事件中检测连接状态。
  2. 手动重新创建 EventSource:在 onerror 事件中关闭当前的 EventSource 并重新创建一个新的 EventSource 对象。

使用--客户端

EventSource实例的readyState属性,表明连接的当前状态。该属性只读,可以取以下值。

  • 0:相当于常量EventSource.CONNECTING,表示连接还未建立,或者断线正在重连。
  • 1:相当于常量EventSource.OPEN,表示连接已经建立,可以接受数据。
  • 2:相当于常量EventSource.CLOSED,表示连接已断,且不会重连。
if ('EventSource' in window) { //SSE 的客户端 API 部署在EventSource对象上

    //首先生成一个EventSource实例,向服务器发起连接。
    // 跨域时,可以指定第二个参数,打开withCredentials属性,表示是否一起发送 Cookie
    var source = new EventSource(url, { withCredentials: true });

    // 连接一旦建立,就会触发open事件
    source.onopen = function (event) {
        // ...
    };

    // 客户端收到服务器发来的数据,就会触发message事件,事件对象的data属性就是服务器端传回的数据(文本格式)。
    source.onmessage = function (event) {
        var data = event.data;
        // handle message
    };

    // 如果发生通信错误(比如连接中断),就会触发error事件
    source.onerror = function (event) {
        // handle error event
    };

    // close方法用于关闭 SSE 连接。
    source.close();
}

自定义事件

默认情况下,服务器发来的数据,总是触发浏览器EventSource实例的message事件。开发者还可以自定义 SSE 事件,这种情况下,发送回来的数据不会触发message事件。

source.addEventListener('foo', function (event) {
  var data = event.data;
   // handle message
 }, false);

上面代码中,浏览器对 SSE 的foo事件进行监听。

数据格式

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


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

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