HTML5 服務器推送事件（Server-sent Events）

時間 2019-12-11

標籤 html5 html 服務器推送事件 server sent events 欄目 HTML5 简体版

原文原文鏈接

服務器推送事件（Server-sent Events）是基於WebSocket 協議的一種服務器向客戶端發送事件&數據的單向通信。目前全部主流瀏覽器均支持服務器發送事件，固然除了 Internet Explorer 。2333...web

WebSocket 協議是繼HTTP協議後又一服務器客戶端通信協議，不一樣於HTTP單純的客戶端請求服務器響應單向通信模式的是它支持了服務端客戶端的雙向通信。json

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>

服務端spa

服務端應當返回怎樣的數據格式？應當以什麼樣的響應給客戶端呢？先來個.Net 的樣例code

 　　　　/// <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;
        }