浅谈HTML5 服务器推送事件(Server-sent Events)


Posted in HTML / CSS onAugust 01, 2017

服务器推送事件(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的简单应用,实现效果我就不再展示了,有兴趣可以亲自操作实现效果!

HTML / CSS 相关文章推荐
css3 background属性调整增强介绍
Dec 18 HTML / CSS
CSS3结构性伪类选择器九种写法
Apr 18 HTML / CSS
CSS3实现点击放大的动画实例代码
Feb 27 HTML / CSS
详解css position 5种不同的值的用法
Jul 30 HTML / CSS
HTML5几个设计和修改的页面范例分享
Sep 29 HTML / CSS
实例讲解使用SVG制作loading加载动画的方法
Apr 05 HTML / CSS
解决canvas转base64/jpeg时透明区域变成黑色背景的方法
Oct 23 HTML / CSS
HTML5单页面手势滑屏切换原理分析
Jul 10 HTML / CSS
canvas环形倒计时组件的示例代码
Jun 14 HTML / CSS
canvas 绘图时位置偏离的问题解决
Sep 16 HTML / CSS
浅析HTML5页面元素及属性
Jan 20 HTML / CSS
HTML中link标签属性的具体用法
May 07 HTML / CSS
基于HTML5陀螺仪实现ofo首页眼睛移动效果的示例
Jul 31 #HTML / CSS
html5教你做炫酷的碎片式图片切换 (canvas)
Jul 28 #HTML / CSS
H5 canvas实现贪吃蛇小游戏
Jul 28 #HTML / CSS
LocalStorage记住用户和密码功能
Jul 24 #HTML / CSS
基于HTML5实现类似微信手机摇一摇功能(计算摇动次数)
Jul 24 #HTML / CSS
H5调用相机拍照并压缩图片的实例代码
Jul 20 #HTML / CSS
h5实现获取用户地理定位的实例代码
Jul 17 #HTML / CSS
You might like
php后台如何避免用户直接进入方法实例
2013/10/15 PHP
php使用unset()删除数组中某个单元(键)的方法
2015/02/17 PHP
PHP中empty和isset对于参数结构的判断及empty()和isset()的区别
2015/11/15 PHP
简介WordPress中用于获取首页和站点链接的PHP函数
2015/12/17 PHP
PHP mysqli事务操作常用方法分析
2017/07/22 PHP
Nginx实现反向代理
2017/09/20 Servers
通过源码解析Laravel的依赖注入
2018/01/22 PHP
php use和include区别总结
2019/10/13 PHP
Array.prototype.concat不是通用方法反驳[译]
2012/09/20 Javascript
jquery ztree实现下拉树形框使用到了json数据
2014/05/14 Javascript
使用不同的方法结合/合并两个JS数组
2014/09/18 Javascript
JS+CSS实现Li列表隔行换色效果的方法
2015/02/16 Javascript
jQuery插件HighCharts绘制2D柱状图、折线图的组合双轴图效果示例【附demo源码下载】
2017/03/09 Javascript
利用NPM淘宝的node.js镜像加速nvm
2017/03/27 Javascript
很棒的vue弹窗组件
2017/05/24 Javascript
基于vue-cli 打包时抽离项目相关配置文件详解
2018/03/07 Javascript
JavaScript的Proxy可以做哪些有意思的事儿
2019/06/15 Javascript
[03:48]2014DOTA2 TI专访71DK夺冠不靠小组赛高排名
2014/07/11 DOTA
Python实例之wxpython中Frame使用方法
2014/06/09 Python
Swift中的协议(protocol)学习教程
2016/07/08 Python
python2.x实现人民币转大写人民币
2018/06/20 Python
opencv python 图像去噪的实现方法
2018/08/31 Python
初探利用Python进行图文识别(OCR)
2019/02/26 Python
python async with和async for的使用
2019/06/20 Python
利用Python实现kNN算法的代码
2019/08/16 Python
django中上传图片分页三级联动效果的实现代码
2019/08/30 Python
Python队列、进程间通信、线程案例
2019/10/25 Python
win10安装tensorflow-gpu1.8.0详细完整步骤
2020/01/20 Python
Python eval函数介绍及用法
2020/11/09 Python
中科软测试工程师面试题
2012/06/16 面试题
自荐信模版
2013/10/24 职场文书
国旗下的演讲稿
2014/05/08 职场文书
我们的节日中秋节活动总结
2015/03/23 职场文书
银行反洗钱宣传活动总结
2015/05/08 职场文书
借款民事起诉状范文
2015/05/19 职场文书
MySQL系列之十二 备份与恢复
2021/07/02 MySQL