虚拟主机怎么搭建网站,网站建设月薪,wordpress打包小程序,网站建设岗位职责怎么写ESP32-Web-Server编程- 使用SSE 实时更新设备信息
概述
如前所述#xff0c;传统 HTTP 通信协议基于 Request-Apply#xff08;请求-响应#xff09;机制#xff0c;浏览器#xff08;客户端#xff09;只能单向地向服务器发起请求#xff0c;服务器无法主动向浏览器推…ESP32-Web-Server编程- 使用SSE 实时更新设备信息
概述
如前所述传统 HTTP 通信协议基于 Request-Apply请求-响应机制浏览器客户端只能单向地向服务器发起请求服务器无法主动向浏览器推送信息。 上节我们讲述了基于 WebSocket 通信协议实现服务器向浏览器推送信息其实还有一种方法Server-Sent Events以下简称 SSE可以实现这种功能。本文介绍它的用法。
什么是 SSE
SSE 通过服务器向浏览器客户端声明接下来要发送的是流信息streaming来实现让浏览器一直保持该连接并不断地接收更新数据。
也就是说服务器第一次接收浏览器的请求时就通知浏览器此次发送的不是一次性的数据包而是一个数据流会连续不断地发送过来。这时浏览器不会关闭连接会一直等着服务器发过来的新的数据流视频播放就是这样的例子。本质上这种通信就是以流信息的方式完成一次用时很长的下载。
SSE 基于 HTTP 协议目前除了 IE/Edge其他浏览器都支持。
Server-Sent Events 规范描述了一个浏览器支持的内建的类 EventSource与 WebSocket 类似它能保持与服务器的连接并允许从中接收事件。
但是两者之间有几个重要的区别
WebSocketEventSource双向客户端和服务端都能交换消息单向仅服务端能发送消息二进制和文本数据仅文本数据WebSocket 协议常规 HTTP 协议前后端代码较复杂前后端代码简单需要自行实现自动重连支持自动重连机制
SSE 的特点
SSE 与 WebSocket 类似都是先建立浏览器与服务器之间的通信渠道然后服务器向浏览器推送信息。
总体来说WebSocket 更强大和灵活。因为它是真正地全双工通道SSE 是单向通道只能服务器向浏览器发送。此外SSE会一直保持连接状态如果服务器在一段较长的时间内没有推送数据那么SSE相当于浪费了资源我们可以设置一个事件当服务器认为在未来的一段时间内不会推送信息推送一个暂停服务的事件并规定下次重连的时间客户端接收到之后关闭连接开启定时重连机制等时间到了重新发起连接建立通信。 但是SSE 也有自己的优点。 SSE 使用 HTTP 协议现有的服务器软件都支持。WebSocket 是一个独立协议。SSE 属于轻量级使用简单WebSocket 协议相对复杂。SSE 默认支持断线重连WebSocket 需要自己实现。SSE 一般只用来传送文本二进制数据需要编码后传送WebSocket 默认支持传送二进制数据。SSE 支持自定义发送的消息类型。 关于 SSE 更多的学习内容请参考Server-Sent Events规范 、Server-Sent Events 教程、SSE INFO
我们更多关注地是在 ESP32 Web 中应用这种机制。
创建 SSE 对象建立连接
要开始接收消息前端代码只需要创建 new EventSource(url) 即可。浏览器将会尝试连接连接到 Web 服务器上的该 url 并保持连接打开等待事件
// 第二个参数只有一个可选项{ withCredentials: true }它允许发送跨源凭证。
let source new EventSource(url, [credentials]);上面的url可以与当前网址同域也可以跨域跨域问题我们这里不涉及讨论。
EventSource实例的readyState属性表明连接的当前状态。该属性只读可以取以下值。 0相当于常量EventSource.CONNECTING表示连接还未建立或者断线正在重连。1相当于常量EventSource.OPEN表示连接已经建立可以接受数据。2相当于常量EventSource.CLOSED表示连接已断且不会重连。 SSE 的客户端 API 部署在EventSource对象上。下面的代码可以检测浏览器是否支持 SSE。 if (EventSource in window) {
// ...
}Web 服务器后端代码对该 url 的响应状态码应该为 200header 为 Content-Type: text/event-stream然后保持此连接并以一种特殊的格式写入消息比如
data: Message 1data: Message 2data: Message 3
data: of two linesdata: 后为消息文本冒号后面的空格是可选的。消息以双换行符 \n\n 分隔。要发送一个换行 \n我们可以在要换行的位置立即再发送一个 data:上面的第三条消息。
在实际开发中复杂的消息通常是用 JSON 编码后发送。换行符在其中编码为 \n因此不需要多行 data: 消息。
注意建立 SSE 连接后客户端将从服务器持续接收数据更新但在初始握手后客户端无法向服务器发送任何数据。
SSE 消息传输机制
SSE 的消息传输机制主要是定义 open 事件、message 事件、error 事件、自定义事件的回调函数。一旦触发了对应的事件其绑定的前端函数便被执行。
连接一旦建立就会触发open事件可以在onopen属性定义回调函数。 let source new EventSource(url, [credentials]);
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();自定义事件默认情况下服务器发来的数据总是触发浏览器EventSource实例的message事件。开发者还可以自定义 SSE 事件这种情况下发送回来的数据不会触发message事件。 source.addEventListener(foo, function (event) { // 浏览器将对 SSE 的自定义foo事件进行监听。
var data event.data;
// handle message
}, false);SSE 重新连接机制
两种情况会导致浏览器重新发起连接一种是时间间隔到期二是由于网络错误等原因导致连接出错。
浏览器通过运行前端代码的new EventSource 连接到服务器后如果连接断开 可以设置重新连接。
服务器 Web 端可以使用 retry: 标识符来设置需要的延迟响应时间以毫秒为单位
retry: 15000
data: Hello, I set the reconnection delay to 15 secondsretry: 既可以与某些数据一起出现也可以作为独立的消息出现。
在重新连接之前浏览器需要等待那么多毫秒。甚至更长例如如果浏览器知道从操作系统此时没有网络连接它会等到连接出现然后重试。
如果服务器想要浏览器停止重新连接那么它应该使用 HTTP 状态码 204 进行响应。如果浏览器想要关闭连接则应该调用 eventSource.close()
let eventSource new EventSource(...);eventSource.close();并且如果响应具有不正确的 Content-Type 或者其 HTTP 状态码不是 301307200 和 204则不会进行重新连接。在这种情况下将会发出 error 事件并且浏览器不会重新连接。
SSE 消息传输的格式
服务器后端发送的消息是由 \n\n 分隔的字符串。
一条消息可能包含以下字段
data: —— 消息体body一系列多个 data 被解释为单个消息各个部分之间由 \n 分隔。id: —— 更新 lastEventId重连时以 Last-Event-ID 发送此 id。retry: —— 建议重连的延迟以 ms 为单位。无法通过 JavaScript 进行设置。event: —— 事件名必须在 data: 之前。
一条消息可以按任何顺序包含一个或多个字段但是 id: 通常排在最后。
服务器向浏览器发送的 SSE 数据必须是 UTF-8 编码的文本具有如下的 HTTP 头信息。 Content-Type: text/event-stream
Cache-Control: no-cache
Connection: keep-alive上面三行之中第一行的Content-Type必须指定 MIME 类型为event-steam。
每一次发送的信息由若干个message组成每个message之间用\n\n分隔。每个message内部由若干行组成每一行都是如下格式。 [field]: value\n上面的field可以取四个值。后面会一一介绍。 dataeventidretry 此外还可以有冒号开头的行表示注释。通常服务器每隔一段时间就会向浏览器发送一个注释保持连接不中断。 : This is a comment下面是一个例子。 : this is a test stream\n\ndata: some text\n\ndata: another message\n
data: with two lines \n\ndata 字段
数据内容用data字段表示。 data: message\n\n如果数据很长可以分成多行最后一行用\n\n结尾前面行都用\n结尾。 data: begin message\n
data: continue message\n\n下面是一个发送 JSON 数据的例子。 data: {\n
data: foo: bar,\n
data: baz, 555\n
data: }\n\nid 字段
数据标识符用id字段表示相当于每一条数据的编号。 id: msg1\n
data: message\n\n浏览器用lastEventId属性读取这个值。一旦连接断线浏览器会发送一个 HTTP 头里面包含一个特殊的Last-Event-ID头信息将这个值发送回来用来帮助服务器端重建连接。因此这个头信息可以被视为一种同步机制。
event 字段
event字段表示自定义的事件类型默认是message事件。浏览器可以用addEventListener()监听该事件。 event: foo\n
data: a foo event\n\ndata: an unnamed event\n\nevent: bar\n
data: a bar event\n\n上面的代码创造了三条信息。第一条的名字是foo触发浏览器的foo事件第二条未取名表示默认类型触发浏览器的message事件第三条是bar触发浏览器的bar事件。
下面是另一个例子。 event: userconnect
data: {username: bobby, time: 02:33:48}event: usermessage
data: {username: bobby, time: 02:34:11, text: Hi everyone.}event: userdisconnect
data: {username: bobby, time: 02:34:23}event: usermessage
data: {username: sean, time: 02:34:36, text: Bye, bobby.}需求及功能解析
这里建立一个使用 SSE 的简单示例用于实现在网页上实时动态地显示各个模拟传感器的数值。每当有新读数可用时ESP32 都会将其发送给客户端网页网页可以自动更新无需进一步请求。除了传感器读数您还可以发送任何可能对您的项目有用的数据例如 GPIO 状态、检测到运动时的通知等。读者可以仿照这种示例进行进一步的开发。
主要流程是
客户端发起 SSE 连接服务器使用 /events URL 上的事件源协议向客户端发送更新ESP32 Web 服务器更新传感器读数ESP32 Web 服务器将传感器读数封装为 JSON 字符串返回给浏览器对应的 URL;客户端具有服务器发送的事件的事件侦听器并接收这些事件然后更新网页上的传感器读数
重要提示 Internet Explorer 不支持服务器发送事件 (SSE)。
示例解析
目录结构
├── CMakeLists.txt
├── main
│ ├── CMakeLists.txt
│ └── main.c User application
├── components
│ └── fs_image
└── README.md This is the file you are currently reading目录结构主要包含主目录 main以及组件目录 components.其中组件目录components中包含了用于存储网页文件的 fs_image 目录即前述前端文件。
前端代码
关于 SSE 的代码主要在 components/fs_image/web_image/js/script.js 中
// Create an Event Source to listen for events
if (!!window.EventSource) {var source new EventSource(/events); //用于建立连接的 URL 为 /eventssource.addEventListener(open, function(e) {console.log(Events Connected);}, false);source.addEventListener(error, function(e) {if (e.target.readyState ! EventSource.OPEN) {console.log(Events Disconnected);}}, false);source.addEventListener(new_readings, function(e) { //用于接收消息的 event 为 new_readingsconsole.log(new_readings, e.data);var obj JSON.parse(e.data);document.getElementById(temp).innerHTML obj.temperature;document.getElementById(hum).innerHTML obj.humidity;document.getElementById(pres).innerHTML obj.pressure;}, false);
}此外建立了一个首次打开网页时触发的回调函数
// Get current sensor readings when the page loads
window.addEventListener(load, getReadings); // 首次打开网页时调用 getReadings() 向URL /readings发送 Get 请求后端代码
为了在初次打开网页还没有创建 SSE 对象建立实时显示数据的连接时网页上就显示传感器的状态我们建立URL 为 /readings 的回调
{/readings, HTTP_GET, readings_get_handler, rest_context},SSE 的 URL 对应的回调为
{/events, HTTP_GET, events_get_handler, rest_context},示例效果 讨论
1适合使用 SSE 的场景是什么
网页需要从服务器持续接收一个数据流可能是聊天消息或者市场价格等但是不需要向服务器发送数据的情况。
总结
1本节主要是介绍 HTTP 协议 中的 Server-Sent EventsSSE机制的基本原理与使用方法。SSE用于从服务器持续接收一个数据流的使用场景比 websocket 更加简单并支持自动重连接。
2要使用 SSE 机制前端代码要创建 EventSource 对象并基于EventSource 对象的四种事件open、message、error、自定义事件实现与后端数据的通信。后端代码接收 open 时的连接后将向指定的事件推送数据。
3示例在 ESP32 Web 上部署了 SSE 需要的前后端代码用于实时显示 ESP32 上的传感器数据。
资源链接
1ESP32-Web-Server ESP-IDF系列博客介绍 2对应示例的 code 链接 点击直达代码仓库
3下一篇ESP32-Web-Server编程- 使用表格Table实时显示设备信息
(码字不易感谢点赞或收藏)
