天天看點

HTML5 伺服器推送事件(Server-sent Events)

伺服器推送事件(Server-sent Events)是基于WebSocket 協定的一種伺服器向用戶端發送事件&資料的單向通訊。目前所有主流浏覽器均支援伺服器發送事件,當然除了 Internet Explorer 。2333...

WebSocket 協定是繼HTTP協定後又一伺服器用戶端通訊協定,不同于HTTP單純的用戶端請求伺服器響應單向通訊模式的是它支援了服務端用戶端的雙向通訊。

Server-sent Events 的使用

Server-sent Events(以下簡稱SSE)作為伺服器=>用戶端通訊方式那必然用戶端要有相應的服務位址和響應方法,服務端要有相應的資料發送方法;廢話不多說,上代碼!

用戶端JS代碼

H5頁面需添加如下JS代碼:
     <script>
         if (typeof (EventSource) !== "undefined") {
             //推送服務接口位址
             var eventSource = new EventSource("http://localhost:2242/webservice/ServerSent/SentNews");
             //當通往伺服器的連接配接被打開
             eventSource.onopen = function () {
                 console.log("連接配接打開...");
             }
              //當錯誤發生
              eventSource.onerror= function (e) {
                  console.log(e);
              };
              //當接收到消息,此事件為預設事件
              eventSource.onmessage = function (event) {
                  console.log("onmessage...");
               eventSource.close()//關閉SSE連結
              };
              //伺服器推送sentMessage事件
              eventSource.addEventListener(\'sentMessage\', function (event) { 
                  var data = eval(\'(\'+event.data+\')\');//伺服器端推送的資料,eval裝換Json對象
                  var origin = event.origin;//伺服器 URL 的域名部分,即協定、域名和端口,表示消息的來源。
                  var lastEventId = event.lastEventId;////資料的編号,由伺服器端發送。如果沒有編号,這個屬性為空。
                  //此處根據需求編寫業務邏輯
                  console.log(data);              }, false);
          } else {
              //浏覽器不支援server-sent events 所有主流浏覽器均支援伺服器發送事件,除了 Internet Explorer。
              document.getElementById("result").innerHTML = "Sorry, your browser does not support server-sent events...";
          }
      </script>      

服務端

服務端應當傳回怎樣的資料格式?應當以什麼樣的響應給用戶端呢?先來個.Net 的樣例

    /// <summary>
        /// 推送消息
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public HttpResponseMessage SentNews()
        {
            HttpResponseMessage response = Request.CreateResponse(HttpStatusCode.OK);
            try
            {
                //response.Headers.Add("Access-Control-Allow-Origin", "*");//如需要跨域可配置
                string data_str = “推送至用戶端的資料”;//當然可以是json字元串格式
                string even = "", data = "";
                if (!string.IsNullOrWhiteSpace(data_str))
                {
                    even = "event:sentMessage\n";
                    data = "data:" + data_str + "\n\n";
                }
                string retry = "retry:" + 1000 + "\n";//連接配接斷開後重連時間(毫秒),其實可以了解為輪詢時間 2333...
                byte[] array = Encoding.UTF8.GetBytes(even + data + retry);
                Stream stream_result = new MemoryStream(array);
                response.Content = new StreamContent(stream_result);
                response.Content.Headers.ContentType = new MediaTypeHeaderValue("text/event-stream");//此處一定要配置
                response.Headers.CacheControl = new CacheControlHeaderValue();
                response.Headers.CacheControl.NoCache = false;
            }
            catch (Exception ex)
            {
                LogHelper.WriteWebLog(ex);
            }
            return response;
        }      

看完以上代碼我想你應該有個大概了,響應的方式還是HTTPResponse響應,但總是有點小小的要求的:

  • 響應報頭"Content-Type" 要設定為 "text/event-stream"

響應的資料格式也應該注意到了上述代碼中的"data:"、"event:"和"retry:"這些标記:

  1. event:表示該行用來聲明事件的類型。浏覽器在收到資料時,會産生對應類型的事件。
  2. data:表示該行包含的是資料。以 data 開頭的行可以出現多次。所有這些行都是該事件的資料。
  3. retry:表示該行用來聲明浏覽器在連接配接斷開之後進行再次連接配接之前的等待時間。
  4. id:表示該行用來聲明事件的辨別符(即資料的編号),不常用。

以上就是Server-sent Events的簡單應用,實作效果我就不再展示了,有興趣可以親自操作實作效果!

HTML5 伺服器推送事件(Server-sent Events)