Verwenden von servergesendeten Ereignissen

Die API für servergesendete Ereignisse 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 Ereignisgeneratorskript auf einem anderen Ursprung gehostet wird, sollte ein neues EventSource-Objekt sowohl mit der URL als auch mit einem Optionsdiktat erstellt werden. Angenommen, 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 hört 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 im event-Feld angegebenen Namen empfangen. 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 parst dann das JSON im data-Feld und gibt diese Information 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 Neuzeilen abgeschlossen wird. Für Details zum Format des Ereignisstreams siehe Ereignisstream-Format.

Der PHP-Code für das hier verwendete Beispiel ist wie 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 beinhaltet, der dem Zeitpunkt entspricht, zu dem das Ereignis generiert wurde. In zufälligen Abständen wird eine einfache Nachricht (ohne Ereignistyp) gesendet. Die Schleife bleibt unabhängig vom Verbindungsstatus aktiv, daher wird eine Überprüfung eingefügt, um die Schleife zu unterbrechen, wenn die Verbindung geschlossen wurde (z. B. wenn der Client die Seite schließt).

Bei Problemen (wie einem Netzwerk-Timeout oder Fragen zum Zugriffskontrolle) wird ein Fehlerereignis generiert. Sie können darauf programmatisch reagieren, indem Sie den onerror-Callback des EventSource-Objekts implementieren:

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

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

evtSource.close();

Der Ereignisstream ist ein einfacher Stream von Textdaten, der mit UTF-8 codiert sein muss. Nachrichten im Ereignisstream sind durch ein Paar von Neuzeichen 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 repräsentiert, gefolgt von einem Doppelpunkt und den Textdaten für den Wert dieses Felds.

Jede empfangene Nachricht hat eine Kombination aus den folgenden Feldern, jeweils in einer eigenen Zeile:

event

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

data

Das Datenfeld für die Nachricht. Wenn der EventSource mehrere aufeinanderfolgende Zeilen erhält, die mit data: beginnen, fügt es sie zusammen und fügt zwischen jedem eine Neuzeichen ein. Nachfolgende Neuzeilen werden entfernt.

id

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

retry

Die Wiederverbindungszeit. Geht die Verbindung zum Server verloren, wartet der Browser die angegebene Zeit, bevor versucht wird, 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.

Daten-Only-Nachrichten

Im folgenden Beispiel werden drei Nachrichten gesendet. Die erste ist nur ein Kommentar, da sie mit einem Doppelpunkt beginnt. Wie bereits erwähnt, kann dies als Keep-Alive-Mechanismus nützlich sein, wenn Nachrichten 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 Neuzeichen 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 Feld event angegeben wird, und ein data-Feld, dessen Wert ein entsprechender JSON-String mit den Daten ist, die der Client für die Ausführung der Aktion benötigt. Das data-Feld könnte natürlich beliebige String-Daten 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 Anpassen

Sie müssen nicht nur unbenannte Nachrichten oder typisierte Ereignisse verwenden; Sie können sie innerhalb eines einzigen Ereignisstreams kombinieren.

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."}