HTML 服务器发送事件 API

服务器发送事件 - 单向消息传递

服务器发送事件是指网页自动从服务器获取消息/更新。

通常，网页必须从服务器请求数据，但通过服务器发送事件，更新会自动推送。

例如：Facebook/Twitter 更新、股市更新、新闻源、体育结果等。

浏览器支持

表格中的数字指定了完全支持服务器发送事件 API 的第一个浏览器版本。

接收服务器发送事件通知

EventSource 对象用于接收服务器发送事件通知：

实例

<script>
const x = document.getElementById("result");
// 检查浏览器对 SSE 的支持
if(typeof(EventSource) !== "undefined") {
  var source = new EventSource("demo_sse.php");
  source.onmessage = function(event) {
    x.innerHTML += event.data + "<br>";
  };
} else {
  x.innerHTML = "抱歉，不支持服务器发送事件。";
}
</script>

亲自试一试

示例解释：

• 创建一个新的 EventSource 对象，并指定发送更新的页面 URL（在本示例中为 "demo_sse.php"）
• 每次收到更新时，都会触发 onmessage 事件
• 当 onmessage 事件发生时，将接收到的数据放入 id="result" 的元素中

检查浏览器支持

在上面的 TIY 示例中，有一些额外的代码行用于检查浏览器对服务器发送事件的支持：

if(typeof(EventSource) !== "undefined") {
  // 是！支持服务器发送事件！
  // 一些代码.....
} else {
  // 抱歉！不支持服务器发送事件...
}

服务器端代码示例

要使上面的示例正常工作，您需要一个能够发送数据更新的服务器（如 PHP 或 ASP）。

服务器端事件流的语法很简单。将 Content-Type 头设置为 "text/event-stream"。现在您可以开始发送事件流。

PHP 代码 (demo_sse.php)：

<?php
header('Content-Type: text/event-stream');
header('Cache-Control: no-cache');

$time = date('r');
echo "data: 服务器时间是：{$time}\n\n";
flush();
?>

ASP (VB) 代码 (demo_sse.asp)：

<%
Response.ContentType = "text/event-stream"
Response.Expires = -1
Response.Write("data: 服务器时间是：" & now())
Response.Flush()
%>

代码解释：

• 将 Content-Type 头设置为 "text/event-stream"
• 指定页面不应缓存
• 输出要发送的数据（始终以 "data: " 开头）
• 将输出数据刷新回网页

EventSource 对象

在上面的示例中，我们使用 onmessage 事件来获取消息。但还有其他可用的事件：