浅谈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 相关文章推荐
Web前端绘制0.5像素的几种方法
Aug 11 HTML / CSS
7款设计巧妙的css3飘带状3D立体效果的导航菜单和表单窗口
Feb 04 HTML / CSS
基于CSS3实现的漂亮Menu菜单效果代码
Sep 10 HTML / CSS
html5-canvas中使用clip抠出一个区域的示例代码
May 25 HTML / CSS
html5 svg 中元素点击事件添加方法
Jan 16 HTML / CSS
HTML5 Canvas自定义圆角矩形与虚线示例代码
Aug 02 HTML / CSS
html5基础教程常用技巧整理
Aug 20 HTML / CSS
html5使用Drag事件编辑器拖拽上传图片的示例代码
Aug 22 HTML / CSS
教你使用Canvas处理图片的方法
Nov 28 HTML / CSS
详解如何通过H5(浏览器/WebView/其他)唤起本地app
Dec 11 HTML / CSS
微信端html5页面调用分享接口示例
Mar 14 HTML / CSS
利用Node实现HTML5离线存储的方法
Oct 16 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开发中常用的三个表单验证函数使用小结
2010/03/03 PHP
Blitz templates 最快的PHP模板引擎
2010/04/06 PHP
PHP实现把MySQL数据库导出为.sql文件实例(仿PHPMyadmin导出功能)
2014/05/10 PHP
PHP中读取照片exif信息的方法
2014/08/20 PHP
PHP CURL 内存泄露问题解决方法
2015/02/12 PHP
PHP实现通过get方式识别用户发送邮件的方法
2015/07/16 PHP
PHP实现上传多文件示例代码
2017/02/20 PHP
PHP+Oracle本地开发环境搭建方法详解
2019/04/01 PHP
javascript下IE与FF兼容函数收集
2008/09/17 Javascript
10个基于jQuery或JavaScript的WYSIWYG 编辑器整理
2010/05/06 Javascript
JS读取XML文件示例代码
2013/11/15 Javascript
把多个JavaScript函数绑定到onload事件处理函数上的方法
2016/09/04 Javascript
详解Jquery Easyui的验证扩展
2017/01/09 Javascript
微信小程序 天气预报开发实例代码源码
2017/01/20 Javascript
使用JavaScript开发跨平台的桌面应用详解
2017/07/27 Javascript
nodejs socket服务端和客户端简单通信功能
2017/09/14 NodeJs
JS组件系列之Gojs组件 前端图形化插件之利器
2017/11/29 Javascript
AngularJS集合数据遍历显示的实例
2017/12/27 Javascript
jQuery实现模拟搜索引擎的智能提示功能简单示例
2019/01/27 jQuery
微信小程序pinker组件使用实现自动相减日期
2020/05/07 Javascript
python采用getopt解析命令行输入参数实例
2014/09/30 Python
Python的条件语句与运算符优先级详解
2015/10/13 Python
Python 登录网站详解及实例
2017/04/11 Python
Python3 执行系统命令并获取实时回显功能
2019/07/09 Python
Python日志无延迟实时写入的示例
2019/07/11 Python
python使用celery实现异步任务执行的例子
2019/08/28 Python
Python内置函数locals和globals对比
2020/04/28 Python
如何利用Python 进行边缘检测
2020/10/14 Python
Python爬虫之Selenium多窗口切换的实现
2020/12/04 Python
用60行代码实现Python自动抢微信红包
2021/02/04 Python
html5设计原理(推荐收藏)
2014/05/17 HTML / CSS
html5需遵循的6个设计原则
2016/04/27 HTML / CSS
吃空饷专项治理工作实施方案
2014/03/04 职场文书
专题组织生活会思想汇报
2014/10/01 职场文书
MySQL官方导出工具mysqlpump的使用
2021/05/21 MySQL
关于使用Redisson订阅数问题
2022/01/18 Redis