怎么使用Server-Sent Events (SSE)

2021-10-18  本文已影响0人  曲昶光

一、什么是Server-Sent Events(SSE)

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

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

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

SSE特点

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

如何使用SSE

1.首先利用EventSource 对象判断浏览器是否支持SSE
if('EventSource' in window){ 
//true
}else{ 
//false
}
2.创建EventSource实例,向服务器发起连接。
var source = new EventSource(url);//url与当前网站同域
var source = new EventSource(url, { withCredentials: true });//url与当前网站跨域,withCredentials属性,表示是否一起发送 Cookie。

返回结果:

{
onerror: null
onmessage: null
onopen: null
readyState: 0
url: "http://www.baidu.com/"
withCredentials: true
}

其中readyState属性,表明连接的当前状态。该属性只读,可以取以下值。

连接一旦建立,就会触发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();

以上为SSE的基本使用方法。

参考:
Server-Sent Events 教程.

上一篇下一篇

猜你喜欢

热点阅读