服務(wù)器推送事件(Server-sent Events)是基于WebSocket 協(xié)議的一種服務(wù)器向客戶端發(fā)送事件&數(shù)據(jù)的單向通訊。目前所有主流瀏覽器均支持服務(wù)器發(fā)送事件,當然除了 Internet Explorer 。2333...
WebSocket 協(xié)議是繼HTTP協(xié)議后又一服務(wù)器客戶端通訊協(xié)議,不同于HTTP單純的客戶端請求服務(wù)器響應(yīng)單向通訊模式的是它支持了服務(wù)端客戶端的雙向通訊。
Server-sent Events 的使用
Server-sent Events(以下簡稱SSE)作為服務(wù)器=>客戶端通訊方式那必然客戶端要有相應(yīng)的服務(wù)地址和響應(yīng)方法,服務(wù)端要有相應(yīng)的數(shù)據(jù)發(fā)送方法;廢話不多說,上代碼!
客戶端JS代碼
H5頁面需添加如下JS代碼:
<script>
if (typeof (EventSource) !== "undefined") {
//推送服務(wù)接口地址
var eventSource = new EventSource("http://localhost:2242/webservice/ServerSent/SentNews");
//當通往服務(wù)器的連接被打開
eventSource.onopen = function () {
console.log("連接打開...");
}
//當錯誤發(fā)生
eventSource.onerror= function (e) {
console.log(e);
};
//當接收到消息,此事件為默認事件
eventSource.onmessage = function (event) {
console.log("onmessage...");
eventSource.close()//關(guān)閉SSE鏈接
};
//服務(wù)器推送sentMessage事件
eventSource.addEventListener('sentMessage', function (event) {
var data = eval('('+event.data+')');//服務(wù)器端推送的數(shù)據(jù),eval裝換Json對象
var origin = event.origin;//服務(wù)器 URL 的域名部分,即協(xié)議、域名和端口,表示消息的來源。
var lastEventId = event.lastEventId;////數(shù)據(jù)的編號,由服務(wù)器端發(fā)送。如果沒有編號,這個屬性為空。
//此處根據(jù)需求編寫業(yè)務(wù)邏輯
console.log(data); }, false);
} else {
//瀏覽器不支持server-sent events 所有主流瀏覽器均支持服務(wù)器發(fā)送事件,除了 Internet Explorer。
document.getElementById("result").innerHTML = "Sorry, your browser does not support server-sent events...";
}
</script>
服務(wù)端
服務(wù)端應(yīng)當返回怎樣的數(shù)據(jù)格式?應(yīng)當以什么樣的響應(yīng)給客戶端呢?先來個.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 = “推送至客戶端的數(shù)據(jù)”;//當然可以是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;
}
看完以上代碼我想你應(yīng)該有個大概了,響應(yīng)的方式還是HTTPResponse響應(yīng),但總是有點小小的要求的:
響應(yīng)報頭"Content-Type" 要設(shè)置為 "text/event-stream"
響應(yīng)的數(shù)據(jù)格式也應(yīng)該注意到了上述代碼中的"data:"、"event:"和"retry:"這些標記:
1.event:表示該行用來聲明事件的類型。瀏覽器在收到數(shù)據(jù)時,會產(chǎn)生對應(yīng)類型的事件。
2.data:表示該行包含的是數(shù)據(jù)。以 data 開頭的行可以出現(xiàn)多次。所有這些行都是該事件的數(shù)據(jù)。
3.retry:表示該行用來聲明瀏覽器在連接斷開之后進行再次連接之前的等待時間。
4.id:表示該行用來聲明事件的標識符(即數(shù)據(jù)的編號),不常用。
以上就是Server-sent Events的簡單應(yīng)用,實現(xiàn)效果我就不再展示了,有興趣可以親自操作實現(xiàn)效果!