HTML SSE API


服务器发送事件 (SSE) 允许网页从服务器获取更新。


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

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

这在以前也是可能的,但是网页必须询问是否有可用的更新。通过服务器发送的事件,更新会自动进行。

示例:Facebook/Twitter 更新、股票价格更新、新闻源、体育赛事结果等。


浏览器支持

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

API
SSE 6.0 79.0 6.0 5.0 11.5

接收服务器发送的事件通知

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

示例

var source = new EventSource("demo_sse.html");
source.onmessage = function(event) {
  document.getElementById("result").innerHTML += event.data + "<br>";
};
亲自试一试 »

示例解释:

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

检查服务器发送的事件支持

在上面的 tryit 示例中,有一些额外的代码行来检查浏览器对服务器发送事件的支持:

if(typeof(EventSource) !== "undefined") {
  // Yes! Server-sent events support!
  // Some code.....
} else {
  // Sorry! No server-sent events support..
}


服务器端代码示例

为了使上面的示例正常工作,您需要一个能够发送数据更新的服务器(例如 PHP 或 ASP)。

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

PHP 代码(demo_sse.html):

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

$time = date('r');
echo "data: The server time is: {$time}\n\n";
flush();
?>

ASP (VB) 中的代码 (demo_sse.html):

<%
Response.ContentType = "text/event-stream"
Response.Expires = -1
Response.Write("data: The server time is: " & now())
Response.Flush()
%>

代码解释:

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

事件源对象

在上面的示例中,我们使用 onmessage 事件来获取消息。但也可以参加其他活动:

Events Description
onopen When a connection to the server is opened
onmessage When a message is received
onerror When an error occurs