浅谈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 三维变形实现立体方块特效源码
Dec 15 HTML / CSS
CSS3混合模式mix-blend-mode/background-blend-mode简介
Mar 15 HTML / CSS
深入浅出CSS3 background-clip,background-origin和border-image教程
Jan 27 HTML / CSS
css3 旋转按钮 使用CSS3创建一个旋转可变色按钮
Dec 31 HTML / CSS
CSS3——齿轮转动关键代码
May 02 HTML / CSS
css3 线性渐变和径向渐变示例附图
Apr 08 HTML / CSS
详解CSS3阴影 box-shadow的使用和技巧总结
Dec 03 HTML / CSS
html5摇一摇代码优化包括DeviceMotionEvent等等
Sep 01 HTML / CSS
浅谈html5标签css3的常用样式
Oct 20 HTML / CSS
amaze ui 的使用详细教程
Aug 19 HTML / CSS
使用css样式设计一个简单的html登陆界面的实现
Mar 30 HTML / CSS
基于CSS3画一个iPhone
Apr 21 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 Mssql操作简单封装支持存储过程
2009/12/11 PHP
一步一步学习PHP(8) php 数组
2010/03/05 PHP
理解php原理的opcodes(操作码)
2010/10/26 PHP
PHP面向对象法则
2012/02/23 PHP
php中利用explode函数分割字符串到数组
2014/02/08 PHP
CI框架中redis缓存相关操作文件示例代码
2016/05/17 PHP
基于Laravel-admin 后台的自定义页面用法详解
2019/09/30 PHP
原创javascript小游戏实现代码
2010/08/19 Javascript
解决js正则匹配换行问题实现代码
2012/12/10 Javascript
jQuery-serialize()输出序列化form表单值的方法
2012/12/26 Javascript
使用ImageMagick进行图片缩放、合成与裁剪(js+python)
2013/09/16 Javascript
jquery转盘抽奖功能实现
2015/11/13 Javascript
基于javascript实现随机颜色变化效果
2016/01/14 Javascript
vue中渐进过渡效果实现
2016/10/27 Javascript
JavaScript中关于iframe滚动条的去除和保留
2016/11/17 Javascript
angular2系列之路由转场动画的示例代码
2017/11/09 Javascript
webpack+vue2构建vue项目骨架的方法
2018/01/09 Javascript
详解Vue.js中.native修饰符
2018/04/24 Javascript
Vue.use源码学习小结
2018/06/20 Javascript
实例介绍JavaScript中多种组合继承
2019/01/20 Javascript
JS学习笔记之原型链和利用原型实现继承详解
2019/05/29 Javascript
Vue通过WebSocket建立长连接的实现代码
2019/11/05 Javascript
vue中使用vue-pdf的方法详解
2020/09/05 Javascript
解决antd日期选择组件,添加value就无法点击下一年和下一月问题
2020/10/29 Javascript
python基础_文件操作实现全文或单行替换的方法
2017/09/04 Python
Python爬虫包BeautifulSoup简介与安装(一)
2018/06/17 Python
python dlib人脸识别代码实例
2019/04/04 Python
python 实现交换两个列表元素的位置示例
2019/06/26 Python
Python函数的默认参数设计示例详解
2019/12/01 Python
python实现梯度下降法
2020/03/24 Python
CSS3中31种选择器使用方法教程
2013/12/05 HTML / CSS
css3中单位px,em,rem,vh,vw,vmin,vmax的区别及浏览器支持情况
2016/12/06 HTML / CSS
医院见习报告范文
2014/11/03 职场文书
90行Python代码开发个人云盘应用
2021/04/20 Python
tp5使用layui实现多个图片上传(带附件选择)的方法实例
2021/11/17 PHP
JS前端使用canvas实现扩展物体类和事件派发
2022/08/05 Javascript