浅谈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中calc在less编译时被计算的解决办法
Dec 04 HTML / CSS
css3 伪类选择器快速复习小结
Sep 10 HTML / CSS
浅析CSS3 用text-overflow解决文字排版问题
Oct 28 HTML / CSS
用HTML5 Canvas API中的clearRect()方法实现橡皮擦功能
Mar 15 HTML / CSS
Html5内唤醒百度、高德APP的实现示例
May 20 HTML / CSS
html5 Canvas绘制线条 closePath()实例代码
May 10 HTML / CSS
html5指南-1.html5全局属性(html5 global attributes)深入理解
Jan 07 HTML / CSS
浅析HTML5中header标签的用法
Jun 24 HTML / CSS
详解移动端HTML5页面端去掉input输入框的白色背景和边框(兼容Android和ios)
Dec 15 HTML / CSS
基于canvas的骨骼动画的示例代码
Jun 12 HTML / CSS
css display table 自适应高度、宽度问题的解决
May 07 HTML / CSS
CSS实现鼠标悬浮动画特效
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
9条PHP编程小知识及易犯的小错误
2015/01/22 PHP
php curl 模拟登录并获取数据实例详解
2016/12/22 PHP
javascript读取RSS数据
2007/01/20 Javascript
一张表格告诉你windows.onload()与$(document).ready()的区别
2014/05/16 Javascript
JavaScript代码编写中各种各样的坑和填坑方法
2014/06/06 Javascript
JSON.stringify转换JSON时日期时间不准确的解决方法
2014/08/08 Javascript
快速解决Canvas.toDataURL 图片跨域的问题
2016/05/10 Javascript
Jquery组件easyUi实现表单验证示例
2016/08/23 Javascript
微信js-sdk界面操作接口用法示例
2016/10/12 Javascript
jquery代码规范让代码越来越好看
2017/02/03 Javascript
详解nodejs微信jssdk后端接口
2017/05/25 NodeJs
React通过redux-persist持久化数据存储的方法示例
2019/02/14 Javascript
vue项目前端微信JSAPI与外部H5支付相关实现过程及常见问题
2020/04/14 Javascript
vue3.0 项目搭建和使用流程
2021/03/04 Vue.js
Python中join和split用法实例
2015/04/14 Python
python简单读取大文件的方法
2016/07/01 Python
python 链接和操作 memcache方法
2017/03/04 Python
python 连接sqlite及简单操作
2017/06/30 Python
R语言 vs Python对比:数据分析哪家强?
2017/11/17 Python
Python进阶之自定义对象实现切片功能
2019/01/07 Python
Python 实现还原已撤回的微信消息
2019/06/18 Python
Django中如何使用sass的方法步骤
2019/07/09 Python
Python画图高斯分布的示例
2019/07/10 Python
图解python全局变量与局部变量相关知识
2019/11/02 Python
Python过滤掉numpy.array中非nan数据实例
2020/06/08 Python
Html5之自定义属性(data-,dataset)
2019/11/19 HTML / CSS
List, Set, Map是否继承自Collection接口?
2016/05/16 面试题
学生爱国演讲稿
2014/01/14 职场文书
个性发展自我评价
2014/02/11 职场文书
英语老师推荐信
2014/02/26 职场文书
新闻发布会策划方案
2014/06/12 职场文书
工地宣传标语
2014/06/18 职场文书
学校政风行风评议工作总结
2014/10/21 职场文书
开展党的群众路线教育实践活动个人对照检查材料
2014/11/05 职场文书
黄河绝恋观后感
2015/06/08 职场文书
2019最新版股权转让及委托持股协议书范本
2019/08/07 职场文书