Einen WebSocket-Server in JavaScript (Deno) schreiben

Dieses Beispiel zeigt Ihnen, wie Sie einen WebSocket API-Server mit Deno erstellen können, zusammen mit einer begleitenden Webseite.

Deno ist eine JavaScript-Laufzeitumgebung, die das Kompilieren und Caching von TypeScript im laufenden Betrieb unterstützt. Deno verfügt über einen integrierten Formatter, Linter, Test Runner und mehr und implementiert außerdem viele Web-APIs. Da Deno mit den Webstandards konform ist, werden alle Deno-spezifischen APIs unter dem Deno-Namespace implementiert.

Die Deno-Website bietet Anweisungen zur Installation von Deno.

Deno-Version zum Zeitpunkt des Schreibens: 1.36.

Code

Der Code wird in zwei Dateien enthalten sein, eine für den Server und eine für den Client.

Server

Erstellen Sie eine main.js-Datei. Diese Datei enthält den Code für einen einfachen HTTP-Server, der auch das Client-HTML bereitstellt.

Deno.serve({
  port: 80,
  handler: async (request) => {
    // If the request is a websocket upgrade,
    // we need to use the Deno.upgradeWebSocket helper
    if (request.headers.get("upgrade") === "websocket") {
      const { socket, response } = Deno.upgradeWebSocket(request);

      socket.onopen = () => {
        console.log("CONNECTED");
      };
      socket.onmessage = (event) => {
        console.log(`RECEIVED: ${event.data}`);
        socket.send("pong");
      };
      socket.onclose = () => console.log("DISCONNECTED");
      socket.onerror = (error) => console.error("ERROR:", error);

      return response;
    } else {
      // If the request is a normal HTTP request,
      // we serve the client HTML file.
      const file = await Deno.open("./index.html", { read: true });
      return new Response(file.readable);
    }
  },
});

Deno.upgradeWebSocket() wertet die Verbindung zu einer WebSocket-Verbindung auf, was im Protokoll-Upgrade-Mechanismus näher erklärt wird.

Deno.serve() verwendet Deno.listen() und Deno.serveHttp() im Hintergrund und ist eine höherstufige Schnittstelle, um einfach einen HTTP-Server einzurichten. Ohne sie würde der Code ungefähr so aussehen.

for await (const conn of Deno.listen({ port: 80 })) {
  for await (const { request, respondWith } of Deno.serveHttp(conn)) {
    respondWith(handler(request));
  }
}

Client

Erstellen Sie eine index.html-Datei. Diese Datei enthält ein Skript, das den Server alle fünf Sekunden pingt, nachdem eine Verbindung hergestellt wurde.

html

<!doctype html>
<h2>WebSocket Test</h2>
<p>Sends a ping every five seconds</p>
<div id="output"></div>
<script>
  const wsUri = "ws://127.0.0.1/";
  const output = document.querySelector("#output");
  const websocket = new WebSocket(wsUri);
  let pingInterval;

  function writeToScreen(message) {
    output.insertAdjacentHTML("afterbegin", `<p>${message}</p>`);
  }

  function sendMessage(message) {
    writeToScreen(`SENT: ${message}`);
    websocket.send(message);
  }

  websocket.onopen = (e) => {
    writeToScreen("CONNECTED");
    sendMessage("ping");
    pingInterval = setInterval(() => {
      sendMessage("ping");
    }, 5000);
  };

  websocket.onclose = (e) => {
    writeToScreen("DISCONNECTED");
    clearInterval(pingInterval);
  };

  websocket.onmessage = (e) => {
    writeToScreen(`RECEIVED: ${e.data}`);
  };

  websocket.onerror = (e) => {
    writeToScreen(`ERROR: ${e.data}`);
  };
</script>

Den Code ausführen

Mit den beiden Dateien führen Sie die App mit Deno aus.

deno run --allow-net=0.0.0.0:80 --allow-read=./index.html main.js

Deno verlangt von uns, dass wir explizit Berechtigungen erteilen, für das, worauf wir auf dem Host-Rechner zugreifen können.

--allow-net=0.0.0.0:80 erlaubt der App, eine Verbindung zu localhost auf Port 80 herzustellen
--allow-read=./index.html erlaubt den Zugriff auf die HTML-Datei für den Client

Siehe auch

WebSocket-Server schreiben