服務器推送事件(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的簡單應用,實現效果我就不再展示了,有興趣可以親自操作實現效果!