# Server-Sent Events

网道（WangDoc.com），互联网文档计划

## 简介 #

服务器向客户端推送数据，有很多解决方案。除了“轮询” 和 WebSocket，HTML 5 还提供了 Server-Sent Events（以下简称 SSE）。

一般来说，HTTP 协议只能客户端向服务器发起请求，服务器不能主动向客户端推送。但是有一种特殊情况，就是服务器向客户端声明，接下来要发送的是流信息（streaming）。也就是说，发送的不是一次性的数据包，而是一个数据流，会连续不断地发送过来。这时，客户端不会关闭连接，会一直等着服务器发过来的新的数据流。本质上，这种通信就是以流信息的方式，完成一次用时很长的下载。

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

## 与 WebSocket 的比较 #

SSE 与 WebSocket 作用相似，都是建立浏览器与服务器之间的通信渠道，然后服务器向浏览器推送信息。

总体来说，WebSocket 更强大和灵活。因为它是全双工通道，可以双向通信；SSE 是单向通道，只能服务器向浏览器发送，因为 streaming 本质上就是下载。如果浏览器向服务器发送信息，就变成了另一次 HTTP 请求。

但是，SSE 也有自己的优点。

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

因此，两者各有特点，适合不同的场合。

## 客户端 API #

### EventSource 对象 #

SSE 的客户端 API 部署在`EventSource`对象上。下面的代码可以检测浏览器是否支持 SSE。

    if ('EventSource' in window) {
      // ...
    }

使用 SSE 时，浏览器首先生成一个`EventSource`实例，向服务器发起连接。

    var source = new EventSource(url);

上面的`url`可以与当前网址同域，也可以跨域。跨域时，可以指定第二个参数，打开`withCredentials`属性，表示是否一起发送 Cookie。

    var source = new EventSource(url, { withCredentials: true });

### readyState 属性 #

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

- 0：相当于常量`EventSource.CONNECTING`，表示连接还未建立，或者断线正在重连。
- 1：相当于常量`EventSource.OPEN`，表示连接已经建立，可以接受数据。
- 2：相当于常量`EventSource.CLOSED`，表示连接已断，且不会重连。

    var source = new EventSource(url);
    console.log(source.readyState);

### url 属性 #

`EventSource`实例的`url`属性返回连接的网址，该属性只读。

### withCredentials 属性 #

`EventSource`实例的`withCredentials`属性返回一个布尔值，表示当前实例是否开启 CORS 的`withCredentials`。该属性只读，默认是`false`。

### onopen 属性 #

连接一旦建立，就会触发`open`事件，可以在`onopen`属性定义回调函数。

    source.onopen = function (event) {
      // ...
    };

    // 另一种写法
    source.addEventListener('open', function (event) {
      // ...
    }, false);

### onmessage 属性 #

客户端收到服务器发来的数据，就会触发`message`事件，可以在`onmessage`属性定义回调函数。

    source.onmessage = function (event) {
      var data = event.data;
      var origin = event.origin;
      var lastEventId = event.lastEventId;
      // handle message
    };

    // 另一种写法
    source.addEventListener('message', function (event) {
      var data = event.data;
      var origin = event.origin;
      var lastEventId = event.lastEventId;
      // handle message
    }, false);

上面代码中，参数对象`event`有如下属性。

- `data`：服务器端传回的数据（文本格式）。
- `origin`： 服务器 URL 的域名部分，即协议、域名和端口，表示消息的来源。
- `lastEventId`：数据的编号，由服务器端发送。如果没有编号，这个属性为空。

### onerror 属性 #

如果发生通信错误（比如连接中断），就会触发`error`事件，可以在`onerror`属性定义回调函数。

    source.onerror = function (event) {
      // handle error event
    };

    // 另一种写法
    source.addEventListener('error', function (event) {
      // handle error event
    }, false);

### 自定义事件 #

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

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

上面代码中，浏览器对 SSE 的`foo`事件进行监听。如何实现服务器发送`foo`事件，请看下文。

### close() 方法 #

`close`方法用于关闭 SSE 连接。

    source.close();

## 服务器实现 #

### 数据格式 #

服务器向浏览器发送的 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

### data 字段 #

数据内容用`data`字段表示。

    data:  message\n\n

如果数据很长，可以分成多行，最后一行用`\n\n`结尾，前面行都用`\n`结尾。

    data: begin message\n
    data: continue message\n\n

下面是一个发送 JSON 数据的例子。

    data: {\n
    data: "foo": "bar",\n
    data: "baz", 555\n
    data: }\n\n

### id 字段 #

数据标识符用`id`字段表示，相当于每一条数据的编号。

    id: msg1\n
    data: message\n\n

浏览器用`lastEventId`属性读取这个值。一旦连接断线，浏览器会发送一个 HTTP 头，里面包含一个特殊的`Last-Event-ID`头信息，将这个值发送回来，用来帮助服务器端重建连接。因此，这个头信息可以被视为一种同步机制。

### event 字段 #

`event`字段表示自定义的事件类型，默认是`message`事件。浏览器可以用`addEventListener()`监听该事件。

    event: foo\n
    data: a foo event\n\n

    data: an unnamed event\n\n

    event: bar\n
    data: a bar event\n\n

上面的代码创造了三条信息。第一条的名字是`foo`，触发浏览器的`foo`事件；第二条未取名，表示默认类型，触发浏览器的`message`事件；第三条是`bar`，触发浏览器的`bar`事件。

下面是另一个例子。

    event: userconnect
    data: {"username": "bobby", "time": "02:33:48"}

    event: usermessage
    data: {"username": "bobby", "time": "02:34:11", "text": "Hi everyone."}

    event: userdisconnect
    data: {"username": "bobby", "time": "02:34:23"}

    event: usermessage
    data: {"username": "sean", "time": "02:34:36", "text": "Bye, bobby."}

### retry 字段 #

服务器可以用`retry`字段，指定浏览器重新发起连接的时间间隔。

    retry: 10000\n

两种情况会导致浏览器重新发起连接：一种是时间间隔到期，二是由于网络错误等原因，导致连接出错。

## Node 服务器实例 #

SSE 要求服务器与浏览器保持连接。对于不同的服务器软件来说，所消耗的资源是不一样的。Apache 服务器，每个连接就是一个线程，如果要维持大量连接，势必要消耗大量资源。Node 则是所有连接都使用同一个线程，因此消耗的资源会小得多，但是这要求每个连接不能包含很耗时的操作，比如磁盘的 IO 读写。

下面是 Node 的 SSE 服务器实例。

    var http = require("http");

    http.createServer(function (req, res) {
      var fileName = "." + req.url;

      if (fileName === "./stream") {
        res.writeHead(200, {
          "Content-Type":"text/event-stream",
          "Cache-Control":"no-cache",
          "Connection":"keep-alive",
          "Access-Control-Allow-Origin": '*',
        });
        res.write("retry: 10000\n");
        res.write("event: connecttime\n");
        res.write("data: " + (new Date()) + "\n\n");
        res.write("data: " + (new Date()) + "\n\n");

        interval = setInterval(function () {
          res.write("data: " + (new Date()) + "\n\n");
        }, 1000);

        req.connection.addListener("close", function () {
          clearInterval(interval);
        }, false);
      }
    }).listen(8844, "127.0.0.1");

## 参考链接 #

- Colin Ihrig, Implementing Push Technology Using Server-Sent Events
- Colin Ihrig，The Server Side of Server-Sent Events
- Eric Bidelman, Stream Updates with Server-Sent Events
- MDN，Using server-sent events
- Segment.io, Server-Sent Events: The simplest realtime browser spec

本教程采用知识共享 署名-相同方式共享 3.0协议。

分享本文