HTML5中的SSE（服務器推送技術）

時間 2019-12-05

原文原文鏈接

本文原連接：https://cloud.tencent.com/developer/article/1194063

SSE技術詳解：一種全新的HTML5服務器推送事件技術

前言

通常來講，Web端即時通信技術因受限於瀏覽器的設計限制，一直以來實現起來並不容易，主流的Web端即時通信方案大體有4種：傳統Ajax短輪詢、Comet技術、WebSocket技術、SSE（Server-sent Events）。關於這4種技術方式的優缺點，請參考《Web端即時通信技術盤點：短輪詢、Comet、Websocket、SSE》。本文將專門講解SSE技術。html

服務器推送事件（Server-sent Events），簡稱SSE，是 HTML 5 規範中的一個組成部分，能夠用來從服務端實時推送數據到瀏覽器端。相對於與之相似的 COMET 和 WebSocket 技術來講，服務器推送事件的使用更簡單，對服務器端的改動也比較小。對於某些類型的應用來講，服務器推送事件是最佳的選擇。git

本文對服務器推送技術（SSE）進行了詳細的介紹，包含瀏覽器端和服務器端的相應實現細節，爲在實踐中使用該技術提供了指南。（本文同步發佈於：http://www.52im.net/thread-335-1-1.html）github

概述

對於通常的 Web 應用開發，大多數開發人員並不陌生。在 Web 應用中，瀏覽器和服務器之間使用的是請求 / 響應的交互模式。瀏覽器發出請求，服務器根據收到的請求來生成相應的響應。瀏覽器再對收到的響應進行處理，展示給用戶。響應的格式多是 HTML、XML 或 JSON 等。隨着 REST 架構風格和 AJAX 的流行，服務器更多地使用 JSON 做爲響應的數據格式。Web 應用使用 XMLHttpRequest 對象來發送請求，並根據服務器端返回的數據，對頁面的內容進行動態更新。一般來講，用戶在頁面上的操做，好比點擊或移動鼠標，會觸發相應的事件。由 XMLHttpRequest 對象來發出請求，獲得服務器響應以後進行頁面的局部更新。這種方式的不足之處在於：服務器端產生的數據變化不能及時地通知瀏覽器，而是須要等到下次請求發出時才能被瀏覽器獲取。對於某些對數據實時性要求很高的應用來講，這種延遲是不能接受的。web

爲了知足這類應用的需求，就須要有某種方式可以從服務器端推送數據給瀏覽器，以保證服務器端的數據變化能夠在第一時間通知給用戶。目前常見的解決辦法有很多，主要能夠分紅兩類。這兩類方法的區別在因而否基於 HTTP 協議來實現。不使用 HTTP 協議的作法是使用 HTML 5 新增的 WebSocket 規範，而使用 HTTP 協議的作法則包括簡易輪詢、COMET 技術和本文中要介紹的 HTML 5 服務器推送事件。下面會對這幾種技術進行介紹。後端

基本介紹

在介紹 HTML 5 服務器推送事件（SSE技術）以前，首先介紹一些上面提到的幾種服務器端數據推送技術。跨域

第一種是 WebSocket。WebSocket 規範是 HTML 5 中的一個重要組成部分，已經被不少主流瀏覽器所支持，也有很多基於 WebSocket 開發的應用。正如名稱所表示的同樣，WebSocket 使用的是套接字鏈接，基於 TCP 協議。使用 WebSocket 以後，實際上在服務器端和瀏覽器之間創建一個套接字鏈接，能夠進行雙向的數據傳輸。WebSocket 的功能是很強大的，使用起來也靈活，能夠適用於不一樣的場景。不過 WebSocket 技術也比較複雜，包括服務器端和瀏覽器端的實現都不一樣於通常的 Web 應用。並且更不幸的是WebSocket像其它較新的Web端技術同樣存在瀏覽器兼容性問題，好在已經比較成熟的封裝方案來解決這種技術限制，好比：開源的Socket.io，詳見《Socket.IO介紹：支持WebSocket、用於WEB端的即時通信的框架》。瀏覽器

除了 WebSocket 以外，其餘的實現方式是基於 HTTP 協議來達到實時推送的效果。第一種作法是簡易輪詢，即瀏覽器端定時向服務器端發出請求，來查詢是否有數據更新。這種作法比較簡單，能夠在必定程度上解決問題。不過對於輪詢的時間間隔須要進行仔細考慮。輪詢的間隔過長，會致使用戶不能及時接收到更新的數據；輪詢的間隔太短，會致使查詢請求過多，增長服務器端的負擔。安全

Comet 技術改進了簡易輪詢的缺點（詳見：Comet技術詳解：基於HTTP長鏈接的Web端實時通訊技術），使用的是長輪詢。長輪詢的方式在每次請求時，服務器端會保持該鏈接在一段時間內處於打開狀態，而不是在響應完成以後就當即關閉。這樣作的好處是在鏈接處於打開狀態的時間段內，服務器端產生的數據更新能夠被及時地返回給瀏覽器。當上一個長鏈接關閉以後，瀏覽器會當即打開一個新的長鏈接來繼續請求。不過 COMET 技術的實如今服務器端和瀏覽器端都須要第三方庫的支持。服務器

綜合比較上面提到的 4 種不一樣的技術，簡易輪詢因爲其自己的缺陷，並不推薦使用。Comet 技術並非 HTML 5 標準的一部分，從兼容標準的角度出發，也不推薦使用。WebSocket 規範和服務器推送技術都是 HTML 5 標準的組成部分，在主流瀏覽器上都提供了原生的支持，是推薦使用的。不過 WebSocket 規範更加複雜一些，適用於須要進行復雜雙向數據通信的場景。對於簡單的服務器數據推送的場景，使用服務器推送（SSE技術）事件就足夠了。markdown

在瀏覽器支持方面，服務器推送事件（SSE技術）已經在除 IE 外的大部分桌面和移動瀏覽器上獲得了支持。支持服務器推送事件的瀏覽器及其版本包括：Firefox 6.0+、Chrome 6.0+、Safari 5.0+、Opera 11.0+、iOS Safari 4.0+、Opera Mobile 11.1+、Chrome for Android 25.0+、Firefox for Android 19.0+ 以及 Blackberry Browser 7.0+ 等。關於 IE 的支持，在下面的章節中有詳細的介紹。

下面對服務器推送事件（SSE技術）的規範進行具體的說明。

與WebSocket的比較

簡單不說，SSE適用於更新頻繁、低延遲而且數據都是從服務端到客戶端。

它和WebSocket的區別：

便利，不須要添加任何新組件，用任何習慣的後端語言和框架就能繼續使用，不用爲新建虛擬機弄一個新的IP或新的端口號而勞神。

服務器端的簡潔。由於SSE能在現有的HTTP/HTTPS協議上運做，因此它可以直接運行於現有的代理服務器和認證技術。

WebSocket相較SSE最大的優點在於它是雙向交流的，這意味着服務器發送數據就像從服務器接受數據同樣簡單，而SSE通常經過一個獨立的Ajax請求從客戶端向服務端傳送數據，所以相對於WebSocket使用Ajax會增長開銷。所以，若是須要以每秒一次或者更快的頻率向服務端傳輸數據，就應該用WebSocket。

SSE（Server-sent Events）在HTML 5中的技術規範和定義

Server-sent Events 規範是 HTML 5 規範的一個組成部分，具體的規範文檔見參考資源。該規範比較簡單，主要由兩個部分組成：第一個部分是服務器端與瀏覽器端之間的通信協議，第二部分則是在瀏覽器端可供 JavaScript 使用的 EventSource 對象。通信協議是基於純文本的簡單協議。服務器端的響應的內容類型是「text/event-stream」。響應文本的內容能夠當作是一個事件流，由不一樣的事件所組成。每一個事件由類型和數據兩部分組成，同時每一個事件能夠有一個可選的標識符。不一樣事件的內容之間經過僅包含回車符和換行符的空行（「\r\n」）來分隔。每一個事件的數據可能由多行組成。代碼清單 1 給出了服務器端響應的示例。

清單 1. 服務器端響應的示例：

data: first event data: second event id: 100 event: myevent data: third event id: 101 : this is a comment data: fourth event data: fourth event continue

如代碼清單 1 所示，每一個事件之間經過空行來分隔。對於每一行來講，冒號（「:」）前面表示的是該行的類型，冒號後面則是對應的值。可能的類型包括：

類型爲空白，表示該行是註釋，會在處理時被忽略。

類型爲 data，表示該行包含的是數據。以 data 開頭的行能夠出現屢次。全部這些行都是該事件的數據。

類型爲 event，表示該行用來聲明事件的類型。瀏覽器在收到數據時，會產生對應類型的事件。

類型爲 id，表示該行用來聲明事件的標識符。

類型爲 retry，表示該行用來聲明瀏覽器在鏈接斷開以後進行再次鏈接以前的等待時間。

在代碼清單 1 中，第一個事件只包含數據「first event」，會產生默認的事件；第二個事件的標識符是 100，數據爲「second event」；第三個事件會產生類型爲「myevent」的事件；最後一個事件的數據爲「fourth event\nfourth event continue」。當有多行數據時，實際的數據由每行數據以換行符鏈接而成。

若是服務器端返回的數據中包含了事件的標識符，瀏覽器會記錄最近一次接收到的事件的標識符。若是與服務器端的鏈接中斷，當瀏覽器端再次進行鏈接時，會經過 HTTP 頭「Last-Event-ID」來聲明最後一次接收到的事件的標識符。服務器端能夠經過瀏覽器端發送的事件標識符來肯定從哪一個事件開始來繼續鏈接。

對於服務器端返回的響應，瀏覽器端須要在 JavaScript 中使用 EventSource 對象來進行處理。EventSource 使用的是標準的事件監聽器方式，只須要在對象上添加相應的事件處理方法便可。EventSource 提供了三個標準事件，如表 1 所示。

表 1. EventSource 對象提供的標準事件：

如以前所述，服務器端能夠返回自定義類型的事件。對於這些事件，可使用 addEventListener 方法來添加相應的事件處理方法。代碼清單 2 給出了 EventSource 對象的使用示例。

清單 2. EventSource 對象的使用示例：

vares =newEventSource('events'); es.onmessage =function(e) { console.log(e.data); }; es.addEventListener('myevent',function(e) { console.log(e.data); });

如代碼清單 2 所示，在指定 URL 建立出 EventSource 對象以後，能夠經過 onmessage 和 addEventListener 方法來添加事件處理方法。當服務器端有新的事件產生，相應的事件處理方法會被調用。EventSource 對象的 onmessage 屬性的做用相似於 addEventListener( ‘ message ’ )，不過 onmessage 屬性只支持一個事件處理方法。

在介紹完服務器推送事件的規範內容以後，下面介紹服務器端的實現。

SSE實戰示例：服務器端和瀏覽器端實現

從上一節中對通信協議的描述能夠看出，服務器端推送事件是一個比較簡單的協議。服務器端的實現也相對比較簡單，只須要按照協議規定的格式，返回響應內容便可。在開源社區能夠找到各類不一樣的服務器端技術相對應的實現。本身開發的難度也不大。本文使用 Java 做爲服務器端的實現語言。相應的實現基於開源的 jetty-eventsource-servlet 項目，見參考資源。下面經過一個具體的示例來講明如何使用 jetty-eventsource-servlet 項目。示例用來模擬一個物體在某個限定空間中的隨機移動。該物體從一個隨機位置開始，而後從上、下、左和右四個方向中隨機選擇一個方向，並在該方向上移動隨機的距離。服務器端不斷改變該物體的位置，並把位置信息推送給瀏覽器，由瀏覽器來顯示。

1）服務器端實現

服務器端的實現由兩部分組成：一部分是用來產生數據的 org.eclipse.jetty.servlets.EventSource 接口的實現，另外一部分是做爲瀏覽器訪問端點的繼承自 org.eclipse.jetty.servlets.EventSourceServlet 類的 servlet 實現。代碼清單 3 給出了 EventSource 接口的實現類。

清單 3. EventSource 接口的實現類 MovementEventSource：

publicclassMovementEventSourceimplementsEventSource { privateintwidth =800; privateintheight =600; privateintstepMax =5; privateintx =0; privateinty =0; privateRandom random =newRandom(); privateLogger logger = Logger.getLogger(getClass().getName()); publicMovementEventSource(intwidth,intheight,intstepMax) { this.width = width; this.height = height; this.stepMax = stepMax; this.x = random.nextInt(width); this.y = random.nextInt(height); }

@Override publicvoidonOpen(Emitter emitter)throwsIOException { query(emitter);//開始生成位置信息 }

@Override publicvoidonResume(Emitter emitter, String lastEventId) throwsIOException { updatePosition(lastEventId);//更新起始位置 query(emitter);//開始生成位置信息 }

//根據Last-Event-Id來更新起始位置 privatevoidupdatePosition(String id) { if(id !=null) { String[] pos = id.split(","); if(pos.length >1) { intxPos = -1, yPos = -1; try{ xPos = Integer.parseInt(pos[0],10); yPos = Integer.parseInt(pos[1],10); }catch(NumberFormatException e) { }

（簡書沒法格工化代碼，詳細代碼請見：http://www.52im.net/thread-335-1-1.html）

代碼清單 3 中，類 MovementEventSource 須要實現 EventSource 接口的 onOpen、onResume 和 onClose 方法，其中 onOpen 方法在瀏覽器端的鏈接打開的時候被調用，onResume 方法在瀏覽器端從新創建鏈接時被調用，onClose 方法則在瀏覽器關閉鏈接的時候被調用。onOpen 和 onResume 方法都有一個 EventSource.Emitter 接口類型的參數，能夠用來發送數據。EventSource.Emitter 接口中包含的方法包括 data、event、comment、id 和 close 等，分別對應於通信協議中各類不一樣類型的事件。而 onResume 方法還額外包含一個參數 lastEventId，表示經過 Last-Event-ID 頭髮送過來的最近一次事件的標識符。

MovementEventSource 類中事件生成的主要邏輯在 query 方法中。該方法中包含一個無限循環，每隔 2 秒鐘改變一次位置，同時把更新以後的位置經過 EventSource.Emitter 接口的 data 方法發送給瀏覽器端。每一個事件都有對應的標識符，而標識符的值就是位置自己。若是鏈接斷開以後，瀏覽器從新進行鏈接，能夠從上一次的位置開始繼續移動該物體。

與 MovementEventSource 類對應的 servlet 實現比較簡單，只須要繼承自 EventSourceServlet 類並覆寫 newEventSource 方法便可。在 newEventSource 方法的實現中，須要返回一個 MovementEventSource 類的對象，如代碼清單 4 所示。每當瀏覽器端創建鏈接時，該 servlet 會建立一個新的 MovementEventSource 類的對象來處理該請求。

清單 4. servlet 實現類 MovementServlet：

publicclassMovementServletextendsEventSourceServlet { @Override protectedEventSource newEventSource(HttpServletRequest request, String clientId) { returnnewMovementEventSource(800,600,20); }

}

在服務器端實現中，須要注意的是要添加相應的 servlet 過濾器支持。這是 jetty-eventsource-servlet 項目所依賴的 Jetty Continuations 框架的要求，不然的話會出現錯誤。添加過濾器的方式是在 web.xml 文件中添加代碼清單 5 中所示的配置內容。

清單 5. Jetty Continuations 所需 servlet 過濾器的配置：

（簡書沒法格工化代碼，詳細代碼請見：http://www.52im.net/thread-335-1-1.html）

2）瀏覽器端實現

瀏覽器端的實現也比較簡單，只須要建立出 EventSource 對象，並添加相應的事件處理方法便可。代碼清單 6 給出了相應的實現。在頁面中使用一個方塊表示物體。當接收到新的事件時，根據事件數據中給出的座標信息，更新方塊在頁面上的位置。

清單 6. 瀏覽器端的實現代碼：

（簡書沒法格工化代碼，詳細代碼請見：http://www.52im.net/thread-335-1-1.html）

在介紹完基本的服務器端和瀏覽器端實現以後，下面介紹比較重要的 IE 的支持。

IE上的兼容性問題

使用瀏覽器原生的 EventSource 對象的一個比較大的問題是 IE 並不提供支持。爲了在 IE 上提供一樣的支持，通常有兩種辦法。第一種辦法是在其餘瀏覽器上使用原生 EventSource 對象，而在 IE 上則使用簡易輪詢或 COMET 技術來實現；另一種作法是使用 polyfill 技術，即便用第三方提供的 JavaScript 庫來屏蔽瀏覽器的不一樣。本文使用的是 polyfill 技術，只須要在頁面中加載第三方 JavaScript 庫便可。應用自己的瀏覽器端代碼並不須要進行改動。通常推薦使用第二種作法，由於這樣的話，在服務器端只須要使用一種實現技術便可。

在 IE 上提供相似原生 EventSource 對象的實現並不簡單。理論上來講，只須要經過 XMLHttpRequest 對象來獲取服務器端的響應內容，並經過文本解析，就能夠提取出相應的事件，並觸發對應的事件處理方法。不過問題在於 IE 上的 XMLHttpRequest 對象並不支持獲取部分的響應內容。只有在響應完成以後，才能獲取其內容。因爲服務器端推送事件使用的是一個長鏈接。當鏈接一直處於打開狀態時，經過 XMLHttpRequest 對象並不能獲取響應的內容，也就沒法觸發對應的事件。更具體的來講，當 XMLHttpRequest 對象的 readyState 爲 3（READYSTATE_INTERACTIVE）時，其 responseText 屬性是沒法獲取的。

爲了解決 IE 上 XMLHttpRequest 對象的問題，就須要使用 IE 8 中引入的 XDomainRequest 對象。XDomainRequest 對象的做用是發出跨域的 AJAX 請求。XDomainRequest 對象提供了 onprogress 事件。當 onprogress 事件發生時，能夠經過 responseText 屬性來獲取到響應的部份內容。這是 XDomainRequest 對象和 XMLHttpRequest 對象的最大不一樣，也是使用 XDomainRequest 對象來實現相似原生 EventSource 對象的基礎。在使用 XDomainRequest 對象打開與服務器端的鏈接以後，當服務器端有新的數據產生時，能夠經過 XDomainRequest 對象的 onprogress 事件的處理方法來進行處理，對接收到的數據進行解析，根據數據的內容觸發相應的事件。

不過因爲 XDomainRequest 對象原本的目的是發出跨域 AJAX 請求，考慮到跨域訪問的安全性問題，XDomainRequest 對象在使用時的限制也比較嚴格。這些限制會影響到其做爲 EventSource 對象的實現方式。具體的限制和解決辦法以下所示：

服務器端的響應須要包含 Access-Control-Allow-Origin 頭，用來聲明容許從哪些域訪問該 URL。「*」表示容許來自任何域的訪問，不推薦使用該值。通常使用與當前應用相同的域，限制只容許來自當前域的訪問。

XDomainRequest 對象發出的請求不能包含自定義的 HTTP 頭，這就限制了不能使用 Last-Event-ID 頭來聲明瀏覽器端最近一次接收到的事件的標識符。只能經過 HTTP 請求的其餘方式來傳遞該標識符，如 GET 請求的參數或 POST 請求的內容體。

XDomainRequest 對象的請求的內容類型（Content-Type）只能是「text/plain」。這就意味着，當使用 POST 請求時，服務器端使用的框架，如 servlet，不會對 POST 請求的內容進行自動解析，沒法使用 HttpServletRequest 類的 getParameter 方法來獲取 POST 請求的內容。只能在服務器端對原始的請求內容進行解析，獲取到其中的參數的值。

XDomainRequest 對象發出的請求中不包含任何與用戶認證相關的信息，包括 cookie 等。這就意味着，若是服務器端須要認證，則須要經過 HTTP 請求的其餘方式來傳遞用戶的認證信息，好比 session 的 ID 等。

因爲 XDomainRequest 對象的這些限制，服務器端的實現也須要做出相應的改動。這些改動包括返回 Access-Control-Allow-Origin 頭；對於瀏覽器端發送的「text/plain」類型的參數進行解析；處理請求中包含的用戶認證相關的信息。

本文的示例使用的 polyfill 庫是 GitHub 上的Yaffle 開發的 EventSource 項目。在使用該 polyfill 庫，並對服務器端的實現進行修改以後，就能夠在 IE 8 及以上的瀏覽器中使用服務器推送事件。若是須要支持 IE 7，則只能使用簡易輪詢或 �Comet 技術。本文的示例代碼見參考資源。

結束語

若是須要從服務器端推送數據給瀏覽器，可使用的基於 HTML 5 規範標準的技術包括 WebSocket 和服務器推送事件。開發人員能夠根據應用的具體需求來選擇合適的技術。若是隻是須要從服務器端推送數據，服務器推送事件的規範更加簡單，實現起來更容易。本文對服務器推送事件的規範內容、服務器端和瀏覽器端的實現都進行了詳細的介紹，對如何支持 IE 瀏覽器也進行了具體的分析。