Verwendung von server-sent events

Die server-sent event API ist in der EventSource Schnittstelle enthalten.

Um eine Verbindung zum Server zu öffnen und mit dem Empfang von Ereignissen zu beginnen, erstellen Sie ein neues EventSource-Objekt mit der URL eines Skripts, das die Ereignisse generiert. Zum Beispiel:

const evtSource = new EventSource("sse-demo.php");

Wenn das Ereignis-Generator-Skript auf einem anderen Ursprung gehostet wird, sollte ein neues EventSource-Objekt mit sowohl der URL als auch einem Optionswörterbuch erstellt werden. Zum Beispiel, vorausgesetzt, das Client-Skript befindet sich auf example.com:

const evtSource = new EventSource("//api.example.com/sse-demo.php", {
  withCredentials: true,
});

Nachrichten, die vom Server gesendet werden und kein event-Feld haben, werden als message-Ereignisse empfangen. Um Nachrichtenereignisse zu empfangen, fügen Sie einen Handler für das message-Ereignis hinzu:

evtSource.onmessage = (event) => {
  const newElement = document.createElement("li");
  const eventList = document.getElementById("list");

  newElement.textContent = `message: ${event.data}`;
  eventList.appendChild(newElement);
};

Dieser Code lauscht auf eingehende Nachrichtenereignisse und fügt den Nachrichtentext einer Liste im HTML-Dokument hinzu.

Nachrichten vom Server, die ein definiertes event-Feld haben, werden als Ereignisse mit dem Namen empfangen, der im event angegeben ist. Zum Beispiel:

evtSource.addEventListener("ping", (event) => {
  const newElement = document.createElement("li");
  const eventList = document.getElementById("list");
  const time = JSON.parse(event.data).time;
  newElement.textContent = `ping at ${time}`;
  eventList.appendChild(newElement);
});

Dieser Code wird aufgerufen, wann immer der Server eine Nachricht mit dem event-Feld ping sendet; er analysiert dann das JSON im data-Feld und gibt diese Informationen aus.

Das serverseitige Skript, das Ereignisse sendet, muss mit dem MIME-Typ text/event-stream antworten. Jede Benachrichtigung wird als Textblock gesendet, der durch ein Paar von neuen Zeilen abgeschlossen wird. Einzelheiten zum Format des Ereignisstreams finden Sie unter Event stream format.

Der PHP-Code für das hier verwendete Beispiel folgt:

date_default_timezone_set("America/New_York");
header("X-Accel-Buffering: no");
header("Content-Type: text/event-stream");
header("Cache-Control: no-cache");

$counter = rand(1, 10);
while (true) {
  // Every second, send a "ping" event.

  echo "event: ping\n";
  $curDate = date(DATE_ISO8601);
  echo 'data: {"time": "' . $curDate . '"}';
  echo "\n\n";

  // Send a simple message at random intervals.

  $counter--;

  if (!$counter) {
    echo 'data: This is a message at time ' . $curDate . "\n\n";
    $counter = rand(1, 10);
  }

  if (ob_get_contents()) {
      ob_end_flush();
  }
  flush();

  // Break the loop if the client aborted the connection (closed the page)

  if (connection_aborted()) break;

  sleep(1);
}

Der obige Code generiert jede Sekunde ein Ereignis mit dem Ereignistyp "ping". Die Daten jedes Ereignisses sind ein JSON-Objekt, das den ISO 8601-Zeitstempel enthält, der dem Zeitpunkt entspricht, zu dem das Ereignis generiert wurde. In zufälligen Abständen wird eine einfache Nachricht (ohne Ereignistyp) gesendet. Die Schleife wird unabhängig von der Verbindungsstatus weiterlaufen, weshalb eine Überprüfung enthalten ist, um die Schleife zu beenden, wenn die Verbindung geschlossen wurde (z.B. der Client schließt die Seite).

Wenn Probleme auftreten (wie ein Netzwerk-Timeout oder Probleme im Zusammenhang mit Zugriffskontrolle), wird ein Fehlerereignis generiert. Sie können darauf programmatisch reagieren, indem Sie die onerror-Callback-Funktion im EventSource-Objekt implementieren:

evtSource.onerror = (err) => {
  console.error("EventSource failed:", err);
};

Standardmäßig, wenn die Verbindung zwischen dem Client und dem Server geschlossen wird, wird die Verbindung neu gestartet. Die Verbindung wird mit der .close()-Methode beendet.

evtSource.close();

Der Ereignisstream ist ein einfacher Textdatenstream, der mit UTF-8 codiert werden muss. Nachrichten im Ereignisstream sind durch ein Paar neue Zeilenzeichen getrennt. Ein Doppelpunkt als erstes Zeichen einer Zeile ist im Wesentlichen ein Kommentar und wird ignoriert.

Jede Nachricht besteht aus einer oder mehreren Textzeilen, die die Felder für diese Nachricht auflisten. Jedes Feld wird durch den Feldnamen dargestellt, gefolgt von einem Doppelpunkt und den Textdaten für den Wert dieses Feldes.

Jede empfangene Nachricht hat eine Kombination der folgenden Felder, eines pro Zeile:

event

Ein String, der den Typ des beschriebenen Ereignisses identifiziert. Wenn dies angegeben ist, wird im Browser ein Ereignis an den Listener für den angegebenen Ereignisnamen gesendet; der Quellcode der Website sollte addEventListener() verwenden, um auf benannte Ereignisse zu lauschen. Der onmessage-Handler wird aufgerufen, wenn kein Ereignisname für eine Nachricht angegeben ist.

data

Das Datenfeld für die Nachricht. Wenn die EventSource mehrere aufeinanderfolgende Zeilen empfängt, die mit data: beginnen, fasst sie diese zusammen und fügt dazwischen ein neues Zeilenzeichen ein. Nachgestellte neue Zeilen werden entfernt.

id

Die Ereignis-ID, um den Wert der letzten Ereignis-ID des EventSource-Objekts festzulegen.

retry

Die Wiederverbindungszeit. Wenn die Verbindung zum Server verloren geht, wartet der Browser die angegebene Zeit, bevor er versucht, die Verbindung wiederherzustellen. Dies muss eine ganze Zahl sein, die die Wiederverbindungszeit in Millisekunden angibt. Wenn ein nicht-ganzzahliger Wert angegeben ist, wird das Feld ignoriert.

Alle anderen Feldnamen werden ignoriert.

Nachrichten nur mit Daten

Im folgenden Beispiel werden drei Nachrichten gesendet. Die erste ist nur ein Kommentar, da sie mit einem Doppelpunktzeichen beginnt. Wie bereits erwähnt, kann dies zweckmäßig als Mechanismus zur Standbyverbindung genutzt werden, wenn Nachrichten eventuell nicht regelmäßig gesendet werden.

Die zweite Nachricht enthält ein Datenfeld mit dem Wert "some text". Die dritte Nachricht enthält ein Datenfeld mit dem Wert "another message\nwith two lines". Beachten Sie das spezielle neue Zeilenzeichen im Wert.

: this is a test stream

data: some text

data: another message
data: with two lines

Benannte Ereignisse

Dieses Beispiel sendet benannte Ereignisse. Jedes hat einen Ereignisnamen, der durch das event-Feld angegeben ist, und ein data-Feld, dessen Wert ein geeigneter JSON-String mit den Daten ist, die der Client zum Agieren auf das Ereignis benötigt. Das data-Feld könnte natürlich auch beliebige Stringdaten enthalten; es muss kein JSON sein.

event: userconnect
data: {"username": "bobby", "time": "02:33:48"}

event: usermessage
data: {"username": "bobby", "time": "02:34:11", "text": "Hi everyone."}

event: userdisconnect
data: {"username": "bobby", "time": "02:34:23"}

event: usermessage
data: {"username": "sean", "time": "02:34:36", "text": "Bye, bobby."}

Mischen und Kombinieren

Sie müssen nicht nur unbenannte Nachrichten oder typisierte Ereignisse verwenden; Sie können sie in einem einzigen Ereignisstream mischen.

event: userconnect
data: {"username": "bobby", "time": "02:33:48"}

data: Here's a system message of some kind that will get used
data: to accomplish some task.

event: usermessage
data: {"username": "bobby", "time": "02:34:11", "text": "Hi everyone."}