当前位置：首页 > news >正文

EventSource

news 来源：原创 2024/5/19 10:08:13

从服务端接受事件，下面是html代码

 1 <!DOCTYPE html>
 2 <html>
 3 <head>
 4     <title>comet</title>
 5 </head>
 6 <body>
 7 <ul></ul>
 8 <script>
 9     var eventList=document.body;
10     var evtSource = new EventSource("sendMessage");
11     //var evtSource = new EventSource("//api.example.com/ssedemo.php", { withCredentials: true } );
12     /*    evtSource.onmessage = function(e) {
13             var newElement = document.createElement("li");
14             newElement.innerHTML = "message: " + e.data;
15             eventList.appendChild(newElement);
16            // alert( "message: " + e.data);
17         }*/
18 
19     evtSource.addEventListener("ping", function(e) {
20         var newElement = document.createElement("li");
21 
22         var obj = JSON.parse(e.data);
23         newElement.innerHTML = "ping at " + obj.time;
24         eventList.appendChild(newElement);
25     }, false);
26 
27     evtSource.onerror = function(e) {
28         alert("EventSource failed.");
29     };
30 
31 </script>
32 </body>
33 </html>

View Code

注意eventSource对象的事件：

1.onopen：和服务器之间的链接打开时触发

2.onmessage：当接收到信息时触发

3.onerror:当发生错误时候触发
下面是php代码

 1 function sendMessage(){
 2         date_default_timezone_set("America/New_York");
 3         header("Content-Type: text/event-stream\n\n");
 4 
 5         $counter = rand(1, 10);
 6         while (1) {
 7             // Every second, sent a "ping" event.
 8 
 9             echo "event: ping\n";
10             $curDate = date(DATE_ISO8601);
11             echo 'data: {"time": "' . $curDate . '"}';
12             echo "\n\n";
13 
14             // Send a simple message at random intervals.
15 
16             $counter--;
17 
18             if (!$counter) {
19                 echo 'data: This is a message at time ' . $curDate . "\n\n";
20                 $counter = rand(1, 10);
21             }
22 
23             ob_end_flush();
24             flush();
25             sleep(1);
26         }
27     }

View Code

注意服务端代码一定要设置Content-Type为text/event-stream类型。

默认的事件会一直执行，所以你要手动的关闭

evtSource.close();

注意浏览器兼容性：

Feature	Chrome	Firefox (Gecko)	Internet Explorer	Opera	Safari
EventSource support	9	6.0 (6.0)	Not supported	11	5

当然，可以在代码执行的时候判断是否兼容

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

注意返回的数据的形式：

基本的形式如下:

data: My message\n\n

多行数据的话每一行前面都要data:之后加上一个\n，最后一行是两个\n。

data: first line\n
data: second line\n\n

上面返回的结果e.data是"first line\nsecond line"。接着e.data.split('\n').join('') 来去掉所有\n之后组成的新的string

//split(分割符)通过分割符将string变成数组

//jion将数组链接成string

发送json数据使用格式如下：

data: {\n
data: "msg": "hello world",\n data: "id": 12345\n data: }\n\n

在客户端使用如下：

source.addEventListener('message', function(e) {
  var data = JSON.parse(e.data);
  console.log(data.id, data.msg);
}, false);

在发送的数据中添加id

可以为每次推送的信息中添加唯一的id（添加在信息开始处）:

id: 12345\n
data: GOOG\n data: 556\n\n

设置id可以让浏览器追踪最后一次被触发的事件，因为e.lastEventId 属性存在。

控制重新链接的时间：浏览器会每3秒钟进行一次重新连接

可以在data之前设置"retry:重新链接的毫秒数\n"来自定义重新连接的毫秒数.

下面设置重新链接的时间是10秒：

retry: 10000\n
data: hello world\n\n

指定事件名称：

通过给事件名称可以让一个事件对象产生不同的时间类型。

"event:事件名"后面的data将和事件名相关联。

例如下面的服务器输出了三个事件类型，分别是：message，userlogon，update

data: {"msg": "First message"}\n\n event: userlogon\n data: {"username": "John123"}\n\n event: update\n data: {"username": "John123", "emotion": "happy"}\n\n

客户端的监听是：

source.addEventListener('message', function(e) {
  var data = JSON.parse(e.data);
  console.log(data.msg);
}, false);

source.addEventListener('userlogon', function(e) {
  var data = JSON.parse(e.data);
  console.log('User login:' + data.username);
}, false);

source.addEventListener('update', function(e) {
  var data = JSON.parse(e.data);
  console.log(data.username + ' is now ' + data.emotion);
}, false);