所有活动的HTML5 EventSource监听器?

时间:2012-03-29 21:12:32

标签: javascript html5 server-sent-events

我使用EventSource在我的JavaScript客户端应用中推送通知。 我可以像这样附加事件监听器:

source.addEventListener('my_custom_event_type', function(e) {
  console.log(e.data);
}, false);

但是我想要监视从服务器推送的所有事件(主要用于调试),所以如果发送了一些事件但没有事件监听器,我可以很容易地找到它。我的意思是,我不想只是“忽略”没有eventListeners绑定的所有事件。

我希望做到这样的事情:

source.addEventListener('*', function(e) {
  console.debug('Event with no listener attached: ', e);
}, false);

但像html5rocks那样的规范和教程没有说明这是否可行。

另一方面,它可能是一些firefox / chrome扩展,允许监视所有服务器事件或其他东西。这些事情对于开发推送通知非常有帮助。

谢谢!

4 个答案:

答案 0 :(得分:27)

我自己找到了一个解决方案,这也大大改善了EventSource界面。

服务器端:不发送事件类型,只包括一个额外的数据字段(我总是使用json)。而不是

event: eventName
data: {mykey: 'myvalue'}

我从服务器发送此信息:

data: {mykey: 'myvalue', eventName: 'eventName'}

客户端:现在我可以使用EventSource onmessage回调,这会在没有事件类型的每条消息上触发。

对于绑定事件侦听器,我使用Backbone.Event功能创建了一个包装器类。结果:

// Server Sent Events (Event Source wrapper class)
var MyEventSource = (function() {

  function MyEventSource(url) {
    var self = this;
    _.extend(this, Backbone.Events);

    this.source = new EventSource(url);
    this.source.onmessage = function(event) {
      var data, eventName;
      var data = JSON.parse(event.data);
      var eventName = data.eventName; delete data.eventName;

      // Now we can monitor all server sent events
      console.log('app.server.on ', eventName, '. Data: ', data);

      self.trigger(eventName, data);
    };
  }

  return MyEventSource;
})();

现在有了这个包装类,我可以轻松扩展功能,所有服务器发送的事件都可以轻松监控,并且由于扩展了Backbone.Events,这个类中的事件处理功能更强大。

用法示例:

var source = new MyEventSource('url/of/source');

// Add event listener
source.on('eventName', function(data) {
  console.log(data);
});

// Fire a event (also very useful for testing and debugging!!)
source.trigger('eventName', { mykey: 'myvalue' });

// Unbind event listener (very important for complex applications)
source.off('eventName');

现在我有一个易于处理,扩展,调试和测试的组件。

答案 1 :(得分:0)

 <script src="//ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js" type="text/javascript"></script>  
  <script>
    var content = '';
    if(typeof(EventSource)!=="undefined")
    {
      var source = new EventSource("demo_sse.php");
      source.onmessage = function(event)
      {
        content+=event.data + "<br>";
        $("#result").html(content);
      };
    }
    else
    {
      $("#result").html("Sorry, your browser does not support server-sent events...");
    }
  </script>

答案 2 :(得分:0)

我知道这不是一个EventSource,但我一直在寻找同样的东西(一种在不知道其类型的情况下捕获所有传入事件的方法)。如果没有对发送这些事件的服务器的任何控制,我最终只是用XHR编写它,以防其他人遇到这个:

function eventStream(path, callback){
    //Create XHR object
    var xhr = new XMLHttpRequest();

    //initialize storage for previously fetched information
    var fetched='';

    //Set readystatechange handler
    xhr.onreadystatechange=function(){

        //If the connection has been made and we have 200, process the data
        if(xhr.readyState>2 && xhr.status==200){
            //save the current response text
            var newFetched=xhr.responseText;

            //this is a stream, so responseText always contains everything
            //from the start of the stream, we only want the latest
            var lastFetch=xhr.responseText.replace(fetched, '');

            //Set the complete response text to be removed next time 
            var fetched=newFetched;

            //callback to allow parsing of the fetched data
            callback(lastFetch);
        }
    };

    //open and send to begin the stream;
    xhr.open('GET', path, true);
    xhr.send();
}

parseEvents=function(response){
    var events=[];
    //split out by line break
    var lines=response.split("\n");

    //loop through the lines
    for(var i=0;i<lines.length;i++){

        //each event consists of 2 lines, one begins with
        //"name:", the other with "data"
        //if we hit data, process it and the previous line
        if(lines[i].substr(0, lines[i].indexOf(':'))=='data'){

            //add this event to our list for return
            events.push({

               //get the event name
               name: lines[i-1].split(':')[1].trim(),
               //parse the event data
               data: $.parseJSON(lines[i].substr(lines[i].indexOf(':')+1).trim())
            });
        }
    }
    //return the parsed events
    return events;
};

evenStream('http://example.com/myEventPath', function(response){
    var events=parseEvents(response);
});

答案 3 :(得分:0)

向我上面的用户tothemario致谢,以找出需要解决的线索。

您似乎可以使用自定义类型将事件发送回浏览器,但是要触发MESSAGE事件,必须将侦听器分配给新类型,而不是message类型。

如果您查看下面的客户端代码,将有望说明。

对于上下文,我的服务器发送一个自定义类型为CustomType的事件。因此,我订阅了该类型的事件监听器,并为message添加了另一个监听器,以捕获所有其他内容。

在此工作流程中,将触发CustomType不同的侦听器触发的浏览器事件。

 <script type="text/javascript">
    var CustomTypeList = [];

    function EventSystemOpen(e) {
        console.log("EventSystemOpen", e);
    }

    function EventSystemError(e) {
        console.log("EventSystemOpen", e);
        if (e.readyState == EventSource.CLOSED) {
            //
        }
    }

    function GotServerEventMessage(e) {
        console.log("GotServerEventMessage", e);
    }

    function GotCustomType(e) {
        CustomTypeList.push(JSON.parse(e.data));
        console.log("Added CustomType", e, JSON.parse(e.data), CustomTypeList);
    }

    if (!!window.EventSource) {
        var source = new EventSource('api/listen');
        source.addEventListener('open', EventSystemOpen, false);
        source.addEventListener('error', EventSystemError, false);
        source.addEventListener('message', GotServerEventMessage, false);
        source.addEventListener('CustomType', GotCustomType, false);
    }
 </script>