JavaScript Server-Sent Events

目錄

服務(wù)器向客戶端推送數(shù)據(jù)，有很多解決方案。除了“輪詢” 和 WebSocket，HTML 5 還提供了 Server-Sent Events（以下簡稱 SSE）。

一般來說，HTTP 協(xié)議只能客戶端向服務(wù)器發(fā)起請求，服務(wù)器不能主動向客戶端推送。但是有一種特殊情況，就是服務(wù)器向客戶端聲明，接下來要發(fā)送的是流信息（streaming）。也就是說，發(fā)送的不是一次性的數(shù)據(jù)包，而是一個數(shù)據(jù)流，會連續(xù)不斷地發(fā)送過來。這時，客戶端不會關(guān)閉連接，會一直等著服務(wù)器發(fā)過來的新的數(shù)據(jù)流。本質(zhì)上，這種通信就是以流信息的方式，完成一次用時很長的下載。

SSE 就是利用這種機制，使用流信息向瀏覽器推送信息。它基于 HTTP 協(xié)議，目前除了 IE/Edge，其他瀏覽器都支持。

SSE 與 WebSocket 作用相似，都是建立瀏覽器與服務(wù)器之間的通信渠道，然后服務(wù)器向瀏覽器推送信息。

總體來說，WebSocket 更強大和靈活。因為它是全雙工通道，可以雙向通信；SSE 是單向通道，只能服務(wù)器向瀏覽器發(fā)送，因為 streaming 本質(zhì)上就是下載。如果瀏覽器向服務(wù)器發(fā)送信息，就變成了另一次 HTTP 請求。

但是，SSE 也有自己的優(yōu)點。

• SSE 使用 HTTP 協(xié)議，現(xiàn)有的服務(wù)器軟件都支持。WebSocket 是一個獨立協(xié)議。
• SSE 屬于輕量級，使用簡單；WebSocket 協(xié)議相對復(fù)雜。
• SSE 默認(rèn)支持?jǐn)嗑€重連，WebSocket 需要自己實現(xiàn)。
• SSE 一般只用來傳送文本，二進制數(shù)據(jù)需要編碼后傳送，WebSocket 默認(rèn)支持傳送二進制數(shù)據(jù)。
• SSE 支持自定義發(fā)送的消息類型。

因此，兩者各有特點，適合不同的場合。

EventSource 對象

SSE 的客戶端 API 部署在EventSource對象上。下面的代碼可以檢測瀏覽器是否支持 SSE。

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

使用 SSE 時，瀏覽器首先生成一個EventSource實例，向服務(wù)器發(fā)起連接。

var source = new EventSource(url);

上面的url可以與當(dāng)前網(wǎng)址同域，也可以跨域?？缬驎r，可以指定第二個參數(shù)，打開withCredentials屬性，表示是否一起發(fā)送 Cookie。

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

readyState 屬性

EventSource實例的readyState屬性，表明連接的當(dāng)前狀態(tài)。該屬性只讀，可以取以下值。

• 0：相當(dāng)于常量EventSource.CONNECTING，表示連接還未建立，或者斷線正在重連。
• 1：相當(dāng)于常量EventSource.OPEN，表示連接已經(jīng)建立，可以接受數(shù)據(jù)。
• 2：相當(dāng)于常量EventSource.CLOSED，表示連接已斷，且不會重連。

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

url 屬性

EventSource實例的url屬性返回連接的網(wǎng)址，該屬性只讀。

withCredentials 屬性

EventSource實例的withCredentials屬性返回一個布爾值，表示當(dāng)前實例是否開啟 CORS 的withCredentials。該屬性只讀，默認(rèn)是false。

onopen 屬性

連接一旦建立，就會觸發(fā)open事件，可以在onopen屬性定義回調(diào)函數(shù)。

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

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

onmessage 屬性

客戶端收到服務(wù)器發(fā)來的數(shù)據(jù)，就會觸發(fā)message事件，可以在onmessage屬性定義回調(diào)函數(shù)。

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

上面代碼中，參數(shù)對象event有如下屬性。

• data：服務(wù)器端傳回的數(shù)據(jù)（文本格式）。
• origin： 服務(wù)器 URL 的域名部分，即協(xié)議、域名和端口，表示消息的來源。
• lastEventId：數(shù)據(jù)的編號，由服務(wù)器端發(fā)送。如果沒有編號，這個屬性為空。

onerror 屬性

如果發(fā)生通信錯誤（比如連接中斷），就會觸發(fā)error事件，可以在onerror屬性定義回調(diào)函數(shù)。

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

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

自定義事件

默認(rèn)情況下，服務(wù)器發(fā)來的數(shù)據(jù)，總是觸發(fā)瀏覽器EventSource實例的message事件。開發(fā)者還可以自定義 SSE 事件，這種情況下，發(fā)送回來的數(shù)據(jù)不會觸發(fā)message事件。

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

上面代碼中，瀏覽器對 SSE 的foo事件進行監(jiān)聽。如何實現(xiàn)服務(wù)器發(fā)送foo事件，請看下文。

close() 方法

close方法用于關(guān)閉 SSE 連接。

source.close();

數(shù)據(jù)格式

服務(wù)器向瀏覽器發(fā)送的 SSE 數(shù)據(jù)，必須是 UTF-8 編碼的文本，具有如下的 HTTP 頭信息。

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

上面三行之中，第一行的Content-Type必須指定 MIME 類型為event-steam。

每一次發(fā)送的信息，由若干個message組成，每個message之間用\n\n分隔。每個message內(nèi)部由若干行組成，每一行都是如下格式。

[field]: value\n

上面的field可以取四個值。

• data
• event
• id
• retry

此外，還可以有冒號開頭的行，表示注釋。通常，服務(wù)器每隔一段時間就會向瀏覽器發(fā)送一個注釋，保持連接不中斷。

: 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 字段

數(shù)據(jù)內(nèi)容用data字段表示。

data:  message\n\n

如果數(shù)據(jù)很長，可以分成多行，最后一行用\n\n結(jié)尾，前面行都用\n結(jié)尾。

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

下面是一個發(fā)送 JSON 數(shù)據(jù)的例子。

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

id 字段

數(shù)據(jù)標(biāo)識符用id字段表示，相當(dāng)于每一條數(shù)據(jù)的編號。

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

瀏覽器用lastEventId屬性讀取這個值。一旦連接斷線，瀏覽器會發(fā)送一個 HTTP 頭，里面包含一個特殊的Last-Event-ID頭信息，將這個值發(fā)送回來，用來幫助服務(wù)器端重建連接。因此，這個頭信息可以被視為一種同步機制。

event 字段

event字段表示自定義的事件類型，默認(rèn)是message事件。瀏覽器可以用addEventListener()監(jiān)聽該事件。

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

data: an unnamed event\n\n

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

上面的代碼創(chuàng)造了三條信息。第一條的名字是foo，觸發(fā)瀏覽器的foo事件；第二條未取名，表示默認(rèn)類型，觸發(fā)瀏覽器的message事件；第三條是bar，觸發(fā)瀏覽器的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 字段

服務(wù)器可以用retry字段，指定瀏覽器重新發(fā)起連接的時間間隔。

retry: 10000\n

兩種情況會導(dǎo)致瀏覽器重新發(fā)起連接：一種是時間間隔到期，二是由于網(wǎng)絡(luò)錯誤等原因，導(dǎo)致連接出錯。

SSE 要求服務(wù)器與瀏覽器保持連接。對于不同的服務(wù)器軟件來說，所消耗的資源是不一樣的。Apache 服務(wù)器，每個連接就是一個線程，如果要維持大量連接，勢必要消耗大量資源。Node 則是所有連接都使用同一個線程，因此消耗的資源會小得多，但是這要求每個連接不能包含很耗時的操作，比如磁盤的 IO 讀寫。

下面是 Node 的 SSE 服務(wù)器實例。

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