美文网首页
JS中SSE (Server-Sent event)服务器向浏览

JS中SSE (Server-Sent event)服务器向浏览

作者: 谢大见 | 来源:发表于2019-03-04 16:59 被阅读0次

    SSE

    服务器向浏览器推送信息,除了 WebSocket,还有一种方法:Server-Sent Events(以下简称 SSE)。本文介绍它的用法。

    SSE 的本质

    严格地说,HTTP 协议无法做到服务器主动推送信息。但是,有一种变通方法,就是服务器向客户端声明,接下来要发送的是流信息(streaming)。

    也就是说,发送的不是一次性的数据包,而是一个数据流,会连续不断地发送过来。这时,客户端不会关闭连接,会一直等着服务器发过来的新的数据流,视频播放就是这样的例子。本质上,这种通信就是以流信息的方式,完成一次用时很长的下载。

    SSE 就是利用这种机制,使用流信息向浏览器推送信息。它基于 HTTP 协议,目前除了 IE/Edge,其他浏览器都支持。

    SSE 的特点

    SSE 与 WebSocket 作用相似,都是建立浏览器与服务器之间的通信渠道,然后服务器向浏览器推送信息。

    总体来说,WebSocket 更强大和灵活。因为它是全双工通道,可以双向通信;SSE 是单向通道,只能服务器向浏览器发送,因为流信息本质上就是下载。如果浏览器向服务器发送信息,就变成了另一次 HTTP 请求。

    但是,SSE 也有自己的优点。

    SSE 使用 HTTP 协议,现有的服务器软件都支持。WebSocket 是一个独立协议。
    SSE 属于轻量级,使用简单;WebSocket 协议相对复杂。
    SSE 默认支持断线重连,WebSocket 需要自己实现。
    SSE 一般只用来传送文本,二进制数据需要编码后传送,WebSocket 默认支持传送二进制数据。
    SSE 支持自定义发送的消息类型。
    因此,两者各有特点,适合不同的场合。

    三、客户端 API

    3.1 EventSource 对象

    SSE 的客户端 API 部署在EventSource对象上。下面的代码可以检测浏览器是否支持 SSE。

    if ('EventSource' in window) {
    // ...
    }
    使用 SSE 时,浏览器首先生成一个EventSource实例,向服务器发起连接。

    var source = new EventSource(url);
    上面的url可以与当前网址同域,也可以跨域。跨域时,可以指定第二个参数,打开withCredentials属性,表示是否一起发送 Cookie。

    var source = new EventSource(url, { withCredentials: true });
    EventSource实例的readyState属性,表明连接的当前状态。该属性只读,可以取以下值。

    0:相当于常量EventSource.CONNECTING,表示连接还未建立,或者断线正在重连。
    1:相当于常量EventSource.OPEN,表示连接已经建立,可以接受数据。
    2:相当于常量EventSource.CLOSED,表示连接已断,且不会重连。

    3.2 基本用法

    连接一旦建立,就会触发open事件,可以在onopen属性定义回调函数。

    source.onopen = function (event) {
    // ...
    };

    // 另一种写法
    source.addEventListener('open', function (event) {
    // ...
    }, false);
    客户端收到服务器发来的数据,就会触发message事件,可以在onmessage属性的回调函数。

    source.onmessage = function (event) {
    var data = event.data;
    // handle message
    };

    // 另一种写法
    source.addEventListener('message', function (event) {
    var data = event.data;
    // handle message
    }, false);
    上面代码中,事件对象的data属性就是服务器端传回的数据(文本格式)。

    如果发生通信错误(比如连接中断),就会触发error事件,可以在onerror属性定义回调函数。

    source.onerror = function (event) {
    // handle error event
    };

    // 另一种写法
    source.addEventListener('error', function (event) {
    // handle error event
    }, false);
    close方法用于关闭 SSE 连接。

    source.close();

    3.3 自定义事件

    默认情况下,服务器发来的数据,总是触发浏览器EventSource实例的message事件。开发者还可以自定义 SSE 事件,这种情况下,发送回来的数据不会触发message事件。

    source.addEventListener('foo', function (event) {
    var data = event.data;
    // handle message
    }, false);
    上面代码中,浏览器对 SSE 的foo事件进行监听。如何实现服务器发送foo事件,请看下文。

    相关文章

      网友评论

          本文标题:JS中SSE (Server-Sent event)服务器向浏览

          本文链接:https://www.haomeiwen.com/subject/drkvlftx.html