WebSocket-Bibliothek Ratchet für PHP: Vollständige Anleitung

Bibliothek Ratchet für WebSocket in PHP

In der modernen Webentwicklung wird immer häufiger ein Datenaustausch in Echtzeit benötigt: Chats, Benachrichtigungen, Online-Spiele, gemeinsame Dokumentenbearbeitung. Traditionelles HTTP ist für solche Aufgaben ungeeignet, da es nach dem „Anfrage-Antwort“-Schema funktioniert. Hier kommt das WebSocket-Protokoll zur Hilfe, das eine dauerhafte bidirektionale Verbindung zwischen Client und Server herstellt.

Für PHP ist eine der beliebtesten und ausgereiftesten Bibliotheken für die Arbeit mit WebSocket Ratchet. Sie bietet eine benutzerfreundliche API zur Erstellung von WebSocket-Servern, die viele gleichzeitige Verbindungen verarbeiten können. In diesem Artikel werden wir im Detail besprechen, wie man Ratchet installiert, einen einfachen Server und Client erstellt und typische Anwendungsszenarien betrachtet.

Was ist Ratchet?

Ratchet ist eine PHP-Bibliothek, die auf ReactPHP (asynchroner Event-Loop) basiert. Sie ermöglicht die Erstellung von WebSocket-Servern, die in Echtzeit arbeiten, ohne dass zusätzliche Module (wie ext-sockets oder ext-event) erforderlich sind. Die Bibliothek unterstützt den Standard RFC 6455 (WebSocket) und lässt sich leicht in jede PHP-Anwendung integrieren.

Hauptfunktionen von Ratchet:

• Unterstützung des WebSocket-Protokolls (Version 13 und niedriger).
• Möglichkeit zur Erstellung eigener Controller für die Nachrichtenverarbeitung.
• Integrierte Unterstützung für WAMP (WebSocket Application Messaging Protocol) für Pub/Sub (Publisher-Subscriber) und RPC (Remote Procedure Call).
• Einfache Integration mit Frameworks (Laravel, Symfony) über separate Pakete.
• Hohe Leistung dank der asynchronen Architektur von ReactPHP.

Installation von Ratchet

Die Installation erfolgt über Composer. Führen Sie dazu im Stammverzeichnis Ihres Projekts den folgenden Befehl aus:

composer require cboden/ratchet

Nach der Installation erscheint in Ihrem Projekt ein Verzeichnis vendor mit der Bibliothek und ihren Abhängigkeiten (einschließlich ReactPHP). Stellen Sie sicher, dass Sie PHP Version 7.1 oder höher installiert haben.

Erstellen eines einfachen WebSocket-Servers

Wir schreiben einen einfachen Server, der Nachrichten von Clients empfängt und zurücksendet (Echo-Server). Erstellen Sie eine Datei server.php:

<?phprequire __DIR__ . '/vendor/autoload.php';

use Ratchet\\MessageComponentInterface;use Ratchet\\ConnectionInterface;use Ratchet\\Server\\IoServer;use Ratchet\\Http\\HttpServer;use Ratchet\\WebSocket\\WsServer;

class EchoServer implements MessageComponentInterface {    public function onOpen(ConnectionInterface $conn) {        echo "Neue Verbindung: {$conn->resourceId}";    }

    public function onMessage(ConnectionInterface $from, $msg) {        echo "Nachricht empfangen von {$from->resourceId}: {$msg}";        // Sende die Nachricht zurück an den Absender        $from->send("Echo: {$msg}");    }

    public function onClose(ConnectionInterface $conn) {        echo "Verbindung {$conn->resourceId} geschlossen";    }

    public function onError(ConnectionInterface $conn, \\Exception $e) {        echo "Fehler: {$e->getMessage()}";        $conn->close();    }}

// Server auf Port 8080 starten$server = IoServer::factory(    new HttpServer(        new WsServer(            new EchoServer()        )    ),    8080);

echo "WebSocket-Server gestartet auf Port 8080";$server->run();

Starten Sie den Server mit dem Befehl php server.php. Er lauscht auf eingehende WebSocket-Verbindungen auf Port 8080.

Erstellen eines Clients (JavaScript)

Erstellen Sie zum Testen eine einfache HTML-Datei mit einem JavaScript-Client:

<!DOCTYPE html><html><head>    <title>WebSocket-Client</title></head><body>    <h1>WebSocket-Client Test</h1>    <div id="output"></div>    <script>        var conn = new WebSocket('ws://localhost:8080');        conn.onopen = function(e) {            console.log("Verbindung hergestellt!");            conn.send('Hallo Server!');        };        conn.onmessage = function(e) {            console.log('Nachricht vom Server: ' + e.data);            document.getElementById('output').innerHTML += '<p>' + e.data + '</p>';        };        conn.onclose = function(e) {            console.log('Verbindung geschlossen');        };    </script></body></html>

Öffnen Sie diese HTML-Datei in einem Browser. Der Client stellt eine Verbindung zum Server her, sendet eine Nachricht und zeigt die Echo-Antwort an.

Arbeiten mit mehreren Clients

Ratchet verwaltet alle Verbindungen über den Event-Loop. Um Nachrichten an alle verbundenen Clients zu senden (z. B. für einen Chat), können Sie ein Array von Verbindungen speichern:

class ChatServer implements MessageComponentInterface {    protected $clients;

    public function __construct() {        $this->clients = new \\SplObjectStorage;    }

    public function onOpen(ConnectionInterface $conn) {        $this->clients->attach($conn);        echo "Neue Verbindung: {$conn->resourceId}";    }

    public function onMessage(ConnectionInterface $from, $msg) {        foreach ($this->clients as $client) {            if ($from !== $client) {                $client->send($msg);            }        }    }

    public function onClose(ConnectionInterface $conn) {        $this->clients->detach($conn);        echo "Verbindung {$conn->resourceId} geschlossen";    }

    public function onError(ConnectionInterface $conn, \\Exception $e) {        echo "Fehler: {$e->getMessage()}";        $conn->close();    }}

Dieser Server sendet eingehende Nachrichten an alle anderen verbundenen Clients – die Grundlage für einen einfachen Chat.

Integration mit Frameworks

Ratchet kann in Laravel über das Paket laravel-websockets von BeyondCode integriert werden. Für Symfony gibt es das Bundle gos/web-socket-bundle. Diese Pakete bieten eine bequeme Möglichkeit, WebSocket-Funktionalität in Ihre Anwendung zu integrieren, ohne die Serverlogik manuell schreiben zu müssen.

Fazit

Ratchet ist eine leistungsstarke und flexible Bibliothek für die Arbeit mit WebSocket in PHP. Sie eignet sich hervorragend für die Erstellung von Echtzeitanwendungen wie Chats, Benachrichtigungen und Online-Spielen. Dank der asynchronen Architektur von ReactPHP kann Ratchet Tausende gleichzeitiger Verbindungen effizient verarbeiten. Probieren Sie es aus und erweitern Sie Ihre PHP-Anwendungen um Echtzeit-Funktionalität!