Server-Sent Events 教程

标签: Developer | 发表时间:2017-05-27 15:49 | 作者:
出处:http://www.ruanyifeng.com/blog/

服务器向浏览器推送信息,除了 WebSocket,还有一种方法:Server-Sent Events(以下简称 SSE)。本文介绍它的用法。

一、SSE 的本质

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

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

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

二、SSE 的特点

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

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

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

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

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

三、客户端 API

3.1 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 });

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

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

3.2 基本用法

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

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

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

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

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

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

上面代码中,事件对象的 data属性就是服务器端传回的数据(文本格式)。

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

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

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

close方法用于关闭 SSE 连接。

   
source.close();

3.3 自定义事件

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

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

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

四、服务器实现

4.1 数据格式

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

4.2 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

4.3 id 字段

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

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

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

4.4 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."}

4.5 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");

请将上面的代码保存为 server.js,然后执行下面的命令。

   
$ node server.js

上面的命令会在本机的 8844端口,打开一个 HTTP 服务。

然后,打开这个 网页,查看客户端代码并运行。

六、参考链接

(完)

文档信息

相关 [server sent events] 推荐:

Server-Sent Events 教程

- - 阮一峰的网络日志
服务器向浏览器推送信息,除了 WebSocket,还有一种方法:Server-Sent Events(以下简称 SSE). 严格地说, HTTP 协议无法做到服务器主动推送信息. 但是,有一种变通方法,就是服务器向客户端声明,接下来要发送的是流信息(streaming). 也就是说,发送的不是一次性的数据包,而是一个数据流,会连续不断地发送过来.

CSS3 pointer-events介绍

- Pstrey - 前端观察
其实早知道这个属性,但是一直没有去研究过. 今天正好在twitter看到这个词,就去研究了下,正好解决了目前遇到的一个小难题,所以分享下. 嗯,其实这是个比较简单的CSS3属性. 在某个项目中,很多元素需要定位在一个地图层上面,这里就要用到很多绝对定位或者相对定位的元素,但是这样的话,这些浮在上面的div或者其它元素一般都会给个宽高,或者relative的元素可以不给宽高,这个时候,这些元素就会盖住下面的地图层,以至于地图层无法操作.

backbone 之事件(events)

- - 博客园_首页
  最近用 backbone 做了一个项目,加深了对前端mvc理解. 一定要应用的熟练后,了解其思想后,再去阅读源码. 想写写自己对backbone的感悟. 接下来第一步就是backbone的event.   backbone的event 是其核心.  当我们user调用create 就会触发change事件.

Google+Events使用体验

- - 爱谷地
Google在最新的的 Google I/O上发布了Google+ Events功能,此项目针对活动的计划组织、实时参与、活动总结几个阶段,提供了方便的图、文、视频互动功能,同时与Google Calencar以及Youtube紧密结合,意图打造一个线上活动组织平台. 同时结合Google+方便的圈子功能及隐私控制,用户可以很好的设计活动的参与模式.

SQL Server--索引

- - CSDN博客推荐文章
         1,概念:  数据库索引是对数据表中一个或多个列的值进行排序的结构,就像一本书的目录一样,索引提供了在行中快速查询特定行的能力..             2.1优点:  1,大大加快搜索数据的速度,这是引入索引的主要原因..                             2,创建唯一性索引,保证数据库表中每一行数据的唯一性..

SQL Server 面试

- - SQL - 编程语言 - ITeye博客
在SQL语言中,一个SELECT…FROM…WHERE语句称为一个查询块,将一个查询块嵌套在另一个查询块的WHERE子句中的查询称为子查询. 子查询分为嵌套子查询和相关子查询两种. 嵌套子查询的求解方法是由里向外处理,即每个子查询在其上一级查询处理之前求解,子查询的结果作为其父查询的查询条件. 子查询只执行一次,且可以单独执行;.

Google决定采用微软的Pointer Events规格

- - Solidot
Google与微软两大竞争对手的浏览器团队交上了朋友,他们一同聚在酒吧里把酒言欢. 喝完酒后, Chrome的工程师Rick Byers在邮件列表上高兴的宣布Blink渲染引擎将采用微软提出的Pointer Events API. Pointer Events是一套触控输入处理规格,是苹果Touch Events的竞争对手,支持Pointer Events的浏览器包括了IE和Firefox.

什么是Server SAN? Server SAN精解

- - 云存储技术网--光头老蒋
Server SAN是现在一个全新的概念,现在给出的概念都太笼统. 按照老蒋的想法:Server San应该是一个利用软件将基于DAS存储(包含闪存卡,直连存储)的集合,做成一个能共享的SAN存储网络.      SAN存储区域网,大家都很熟悉. 普遍使用的就两种: FC SAN;ISCSI SAN.

weblogic server启动慢

- - Linux - 操作系统 - ITeye博客
(1)较好的解决办法: 在Weblogic启动参数里添加 “-.   Djava.security.egd=file:/dev/./urandom” (/dev/urandom 无法启动). 修改Linux上Weblogic使用的jdk $JAVA_HOME/jre/lib/security/java.security 文件.

天安门六四事件-最珍贵的视频TianAnmen 6.4 events - the most valuable video

- 共匪吃屎 - MrMolihua01在 YouTube 上的活动
什么叫平反,不需要平反,我们不需要某个流氓集团来道歉的,这就是我们做了的事而已. 我对 YouTube 视频进行了评论: 一定有平反的那么的一天的.