浅谈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弹性布局内容对齐(justify-content)属性使用详解
Jul 31 HTML / CSS
CSS3 实现弹幕的示例代码
Aug 07 HTML / CSS
css3使用animation属性实现炫酷效果(推荐)
Feb 04 HTML / CSS
HTML5 本地存储实现购物车功能
Sep 07 HTML / CSS
Html5游戏开发之乒乓Ping Pong游戏示例(三)
Jan 21 HTML / CSS
html5桌面通知(Web Notifications)实例解析
Jul 07 HTML / CSS
详解HTML5中的Communication API基本使用方法
Jan 29 HTML / CSS
HTML5+CSS3实现机器猫
Oct 17 HTML / CSS
浅谈移动端网页图片预加载方案
Nov 05 HTML / CSS
html5+css如何实现中间大两头小的轮播效果
Dec 06 HTML / CSS
Html5页面内使用JSON动画的实现
Jan 29 HTML / CSS
清除canvas画布内容(点擦除+线擦除)
Aug 12 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 模拟$_PUT实现代码
2010/03/15 PHP
php实用代码片段整理
2016/11/12 PHP
php实现数据库的增删改查
2017/02/26 PHP
COM中获取JavaScript数组大小的代码
2009/11/22 Javascript
jQuery取得设置清空select选择的文本与值
2014/07/08 Javascript
js中string转int把String类型转化成int类型
2014/08/13 Javascript
基于jQuery的JavaScript模版引擎JsRender使用指南
2014/12/29 Javascript
jQuery实现鼠标滑过点击事件音效试听
2015/08/31 Javascript
js日期相关函数dateAdd,dateDiff,dateFormat等介绍
2016/09/24 Javascript
修改ligerui 默认确认按钮的方法
2016/12/27 Javascript
Linux系统中利用node.js提取Word(doc/docx)及PDF文本的内容
2017/06/17 Javascript
利用jquery如何从json中读取数据追加到html中
2017/12/01 jQuery
vue resource发送请求的几种方式
2019/09/30 Javascript
基于JS实现计算24点算法代码实例解析
2020/07/23 Javascript
Vue前端判断数据对象是否为空的实例
2020/09/02 Javascript
js实现随机点名功能
2020/12/23 Javascript
python基础教程之简单入门说明(变量和控制语言使用方法)
2014/03/25 Python
详解在Python程序中解析并修改XML内容的方法
2015/11/16 Python
python用Pygal如何生成漂亮的SVG图像详解
2017/02/10 Python
python中装饰器级连的使用方法示例
2017/09/29 Python
Python3+Pycharm+PyQt5环境搭建步骤图文详解
2019/05/29 Python
python中property属性的介绍及其应用详解
2019/08/29 Python
关于python中的xpath解析定位
2020/03/06 Python
django实现将修改好的新模型写入数据库
2020/03/31 Python
python3的pip路径在哪
2020/06/23 Python
Pygame框架实现飞机大战
2020/08/07 Python
Python用SSH连接到网络设备
2021/02/18 Python
Python Selenium异常处理的实例分析
2021/02/28 Python
澳大利亚百货公司:David Jones
2018/02/08 全球购物
美国电力供应商店/电气批发商:USESI
2018/10/12 全球购物
土木工程师岗位职责
2013/11/24 职场文书
户外活动总结
2015/02/04 职场文书
大学毕业生自我评价
2015/03/02 职场文书
2015年学生会部门工作总结
2015/04/21 职场文书
2015年宣传思想工作总结
2015/05/22 职场文书
Python Matplotlib绘制等高线图与渐变色扇形图
2022/04/14 Python