服务器发送事件(eventsource)与标准的asp.net mvc导致错误

时间:2016-02-25 15:45:31

标签: asp.net-mvc server-sent-events eventsource

我正在尝试服务器发送的事件,但我无法让它在MVC项目(而不是WebAPI)中工作。我还没有在网上找到好样品。

这是我尝试过的服务器端代码(包括各个帖子的几次失败尝试):

Function GetRows() as ActionResult
    Dim ret = New HttpResponseMessage
    ' ret.Content.w
    ' Return ret

    Response.ContentType = "text/event-stream"
    Response.Write("data: " & "aaaa")
    Dim flag = False
    If flag Then
        For i = 0 To 100
            Response.Write("data: " & i)
        Next
    End If
    Response.Flush()
    'Return Content("Abv")
    'Return Content(("data: {0}\n\n" & DateTime.Now.ToString(), "text/event-stream")
End Function

这是Javascript

var source = new EventSource("/Tool/GetRows");
source.onmessage = function (event) {
    document.getElementById("messages").innerHTML += event.data + "<br>";
};
source.onerror = function (e) {
    console.log(e);
};

出于某种原因,它总是进入onerror,并且没有任何信息可能会出现什么类型的错误。

我做错了什么?

顺便说一句,我不认为这个动作应该真正返回任何内容,因为我的理解是它应该只是通过字符串写入流字符串。

1 个答案:

答案 0 :(得分:10)

EventSource expects a specific format,如果信息流与该格式不匹配,则会引发onerror - 由:分隔的一组字段/值对,每一行以换行符结尾:

field: value
field: value

field可以是dataeventidretry中的一个,也可以是空的评论(将被EventSource忽略)。< / p>

data可以跨越多行,但每行都必须以data:开头

每个事件触发器都必须以双换行结束

data: 1
data: second line of message

data: 2
data: second line of second message

注意:如果您使用VB.NET编写,则无法使用\n转义序列来编写换行符;您必须使用vbLfChr(10)

另外,EventSource应该与服务器保持开放连接。来自MDN(强调我的):

  

EventSource 界面用于接收服务器发送的事件。它通过HTTP连接到服务器,并以文本/事件流格式接收事件,而不关闭连接

一旦控制退出MVC控制器方法,结果将被打包并发送到客户端,连接将被关闭。 EventSource的一部分是客户端将尝试重新打开连接,服务器将立即再次关闭该连接;得到的关闭 - &gt;重新开放循环也可以看作here

该方法不应退出该方法,而应该具有某种循环,该循环将持续写入Response流。

VB.NET中的示例

Imports System.Threading
Public Class HomeController
    Inherits Controller

    Sub Message()
        Response.ContentType= "text/event-stream"
        Dim i As Integer
        Do
            i += 1
            Response.Write("data: DateTime = " & Now & vbLf)
            Response.Write("data: Iteration = " & i & vbLf)
            Response.Write(vbLf)
            Response.Flush

            'The timing of data sent to the client is determined by the Sleep interval (and latency)
            Thread.Sleep(1000) 
        Loop
    End Sub
End Class

C#

中的示例

客户端:

<input type="text" id="userid" placeholder="UserID" /><br />
<input type="button" id="ping" value="Ping" />

<script>
    var es = new EventSource('/home/message');
    es.onmessage = function (e) {
        console.log(e.data);
    };
    es.onerror = function () {
        console.log(arguments);
    };

    $(function () {
        $('#ping').on('click', function () {
            $.post('/home/ping', {
                UserID: $('#userid').val() || 0
            });
        });
    });
</script>

服务器端:

using System;
using System.Collections.Concurrent;
using System.Threading;
using System.Web.Mvc;
using Newtonsoft.Json;

namespace EventSourceTest2.Controllers {
    public class PingData {
        public int UserID { get; set; }
        public DateTime Date { get; set; } = DateTime.Now;
    }

    public class HomeController : Controller {
        public ActionResult Index() {
            return View();
        }

        static ConcurrentQueue<PingData> pings = new ConcurrentQueue<PingData>();

        public void Ping(int userID) {
            pings.Enqueue(new PingData { UserID = userID });
        }

        public void Message() {
            Response.ContentType = "text/event-stream";
            do {
                PingData nextPing;
                if (pings.TryDequeue(out nextPing)) {
                    Response.Write("data:" + JsonConvert.SerializeObject(nextPing, Formatting.None) + "\n\n");
                }
                Response.Flush();
                Thread.Sleep(1000);
            } while (true);
        }
    }
}