WEB-API-Server-Sent Events

Server-Sent Events

阮一峰《JavaScript标准教程》:http://javascript.ruanyifeng.com/htmlapi/eventsource.html

阮一峰 GitHub 介绍：https://github.com/wangdoc/webapi-tutorial/blob/master/docs/server-sent-events.md

MDN: https://developer.mozilla.org/zh-CN/docs/Server-sent_events/Using_server-sent_events

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

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

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

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

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

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

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

0：相当于常量EventSource.CONNECTING，表示连接还未建立，或者断线正在重连。

1：相当于常量EventSource.OPEN，表示连接已经建立，可以接受数据。

2：相当于常量EventSource.CLOSED，表示连接已断，且不会重连。

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

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

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

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

8.自定义事件 默认情况下，服务器发来的数据，总是触发浏览器EventSource实例的message事件。

开发者还可以自定义 SSE 事件，这种情况下，发送回来的数据不会触发message事件。

9.close方法用于关闭 SSE 连接。

服务器实现

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

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

data 字段

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

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

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

Node 服务器实例