浅谈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教程(8):CSS3透明度指南
Apr 02 HTML / CSS
利用CSS3的特性改变文本选中时的颜色
Sep 11 HTML / CSS
CSS3之边框多颜色Border-color属性使用示例
Oct 11 HTML / CSS
纯css3制作网站后台管理面板
Dec 30 HTML / CSS
css3实现的多级渐变下拉菜单导航效果代码
Aug 31 HTML / CSS
使用CSS3的appearance属性改变元素的外观的方法
Dec 12 HTML / CSS
CSS3选择器新增问题的实现
Jan 21 HTML / CSS
HTML5之SVG 2D入门10—滤镜的定义及使用
Jan 30 HTML / CSS
HTML5 DeviceOrientation实现手机网站摇一摇功能代码实例
Apr 24 HTML / CSS
html5实现多图片预览上传及点击可拖拽控件
Mar 15 HTML / CSS
浅谈Html5多线程开发之WebWorkers
May 02 HTML / CSS
CSS3通过var()和calc()函数实现动画特效
Mar 30 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
S900/ ETON E1-XM 收音机
2021/03/02 无线电
利用递归把多维数组转为一维数组的函数
2006/10/09 PHP
Linux下安装PHP MSSQL扩展教程
2014/10/24 PHP
PHP采用超长(超大)数字运算防止数字以科学计数法显示的方法
2016/04/01 PHP
PHP查询大量数据内存耗尽问题的解决方法
2016/10/28 PHP
php输出含有“#”字符串的方法
2017/01/18 PHP
PHP基于DOMDocument解析和生成xml的方法分析
2017/07/17 PHP
Yii2框架自定义类统一处理url操作示例
2019/05/25 PHP
js 自定义的联动下拉框
2010/02/07 Javascript
js匿名函数的调用示例(形式多种多样)
2014/08/20 Javascript
node爬取微博的数据的简单封装库nodeweibo使用指南
2015/01/02 Javascript
JavaScript中数据结构与算法(四):串(BF)
2015/06/19 Javascript
jQuery实现的简单百分比进度条效果示例
2016/08/01 Javascript
vue.js中$watch的用法示例
2016/10/04 Javascript
js实现3D图片环展示效果
2017/03/09 Javascript
React Native第三方平台分享的实例(Android,IOS双平台)
2017/08/04 Javascript
从零开始最小实现react服务器渲染详解
2018/01/26 Javascript
微信小程序实现多图上传
2020/06/19 Javascript
python正则表达式re模块详解
2014/06/25 Python
使用python遍历指定城市的一周气温
2017/03/31 Python
PyQt5创建一个新窗口的实例
2019/06/20 Python
Pandas中resample方法详解
2019/07/02 Python
Django框架表单操作实例分析
2019/11/04 Python
Python列表去重复项的N种方法(实例代码)
2020/05/12 Python
详解HTML5之pushstate、popstate操作history,无刷新改变当前url
2017/03/15 HTML / CSS
火山咖啡:Volcanica Coffee
2019/10/29 全球购物
英国在线药房和在线药剂师:Chemist 4 U
2020/01/05 全球购物
高级护理实习生自荐信
2013/09/28 职场文书
后进生转化工作制度
2014/01/17 职场文书
单位工作证明格式模板
2014/10/04 职场文书
12.4全国法制宣传日活动方案
2014/11/02 职场文书
工作检讨书大全
2015/01/26 职场文书
《我的伯父鲁迅先生》教学反思
2016/02/16 职场文书
2017年寒假少先队活动总结
2016/04/06 职场文书
导游词之江苏溱潼古镇
2019/11/27 职场文书
详细了解MVC+proxy
2021/07/09 Java/Android