Heim  >  Artikel  >  Backend-Entwicklung  >  PHP-API-Schnittstelle: So verwenden Sie WebSockets

PHP-API-Schnittstelle: So verwenden Sie WebSockets

WBOY
WBOYOriginal
2023-08-25 12:30:321813Durchsuche

PHP API接口:如何使用WebSockets

PHP ist eine serverseitige Open-Source-Skriptsprache, die häufig zum Erstellen dynamischer Websites und Webanwendungen verwendet wird. PHP-API-Schnittstellen werden normalerweise über das HTTP-Protokoll bereitgestellt, aber mit den steigenden Anforderungen moderner Webanwendungen ist die Echtzeitaktualisierung von Daten immer wichtiger geworden. Dies erfordert die Verwendung von WebSockets für die bidirektionale Kommunikation, um schneller auf Änderungen reagieren zu können.

WebSockets ist eine neue Art von Kommunikationskanal zwischen Client und Server in HTML5. Es ermöglicht eine bidirektionale Datenübertragung in Echtzeit, indem die Verbindung über einen langen Zeitraum aufrechterhalten wird. Im Gegensatz zu HTTP-Anfragen öffnen WebSockets einen TCP-Socket auf der WebSocket-Verbindung, anstatt bei jeder Anfrage einen zu erstellen. Dies bedeutet, dass WebSockets eine schnellere und einfachere Datenübertragung in Echtzeit ermöglichen als HTTP-Anfragen.

In diesem Artikel wird erläutert, wie Sie die PHP-API-Schnittstelle für die Kommunikation mit WebSockets verwenden, um Daten in Webanwendungen in Echtzeit zu aktualisieren.

1. Installieren Sie Ratchet
Um WebSockets verwenden zu können, müssen Sie Ratchet installieren, eine sehr beliebte WebSocket-Bibliothek in PHP. Sie können Ratchet von Github herunterladen und zu Ihrem Projekt hinzufügen oder es mit Composer installieren.

Wenn Sie Composer verwenden, können Sie den folgenden Befehl ausführen:

composer require cboden/ratchet

Dadurch wird Ratchet automatisch installiert. Nach der Installation können Sie mithilfe seiner WebSocket-Server-Klasse einen WebSocket-Server erstellen.

2. WebSocket-Server erstellen
Mit Ratchet können Sie einen WebSocket-Server für die Echtzeitkommunikation mit Clients erstellen. Das Folgende ist ein einfacher Beispielcode für einen WebSocket-Server:

use RatchetMessageComponentInterface;
use RatchetConnectionInterface;
use RatchetServerIoServer;
use RatchetWebSocketWsServer;

require_once(__DIR__ . '/vendor/autoload.php');

class MyWebSocket implements MessageComponentInterface
{
    public function onOpen(ConnectionInterface $conn)
    {
        // 当有新客户端连接时执行
        echo "New connection! ({$conn->resourceId})
";
    }

    public function onMessage(ConnectionInterface $from, $msg)
    {
        // 接收消息
        echo "Received message: {$msg}
";
    
        // 回复消息
        $from->send('Data received: ' . $msg);
    }

    public function onClose(ConnectionInterface $conn)
    {
        // 当客户端断开连接时执行
        echo "Connection {$conn->resourceId} has disconnected
";
    }

    public function onError(ConnectionInterface $conn, Exception $e)
    {
        // 当出现错误时执行
        echo "An error has occurred: {$e->getMessage()}
";
    
        $conn->close();
    }
}

// 创建WebSocket服务器
$server = IoServer::factory(
    new WsServer(
        new MyWebSocket()
    ),
    8080
);

// 启动WebSocket服务器
$server->run();

Der obige Code erstellt einen WebSocket-Server, der Clientverbindungen von Port 8080 akzeptieren kann. Es verfügt über keine echte Geschäftslogik, sondern druckt lediglich Verbindungs-, Nachrichten- und Verbindungsereignisse aus. Sie können dies als Ausgangspunkt verwenden und Ihre eigene WebSocket-Serverklasse nach Bedarf anpassen.

3. Der Client verwendet die WebSocket-API. Auf der Clientseite können Sie die WebSocket-API verwenden, um eine Verbindung mit dem Server herzustellen und Nachrichten zu senden und zu empfangen. Das Folgende ist das einfachste Client-WebSocket-Beispiel:

var connection = new WebSocket('ws://localhost:8080');

connection.onopen = function () {
    console.log('WebSocket connected');
  
    // 发送消息
    connection.send('Hello, WebSocket server!');
};

connection.onmessage = function (event) {
    console.log('Received message: ' + event.data);
};

connection.onclose = function (event) {
    console.log('WebSocket connection closed with code ' + event.code + ' and reason: ' + event.reason);
};

connection.onerror = function (error) {
    console.log('WebSocket error: ' + error.message);
};

Dieser Code wird versuchen, eine Verbindung zum WebSocket-Server herzustellen, den wir gerade geschrieben haben. Wenn ein Verbindungsereignis empfangen wird, wird eine Nachricht gesendet. Wenn eine Nachricht vom Server empfangen wird, protokolliert er die Nachricht in der Konsole. Behandelt auch Verbindungsabbrüche und Fehlersituationen.

4. Verwendung von WebSockets über die PHP-API-Schnittstelle

Betrachten wir nun die Kommunikation mit WebSockets über die PHP-API-Schnittstelle. Sie können einen herkömmlichen API-Router verwenden, um WebSocket-Anfragen zu verarbeiten. Wenn ein Client eine Verbindung zu einem WebSocket-Server herstellt, können Sie die ConnectionInterface-Schnittstelle von Ratchet WebSocket verwenden, um relevante Informationen abzurufen. Sie können diese Informationen auch verwenden, um Verbindungen zu authentifizieren und sicherzustellen, dass nur authentifizierte Benutzer eine Verbindung zum WebSocket-Server herstellen können.

Hier ist der Beispielcode:

use RatchetMessageComponentInterface;
use RatchetConnectionInterface;
use RatchetServerIoServer;
use RatchetWebSocketWsServer;

require_once(__DIR__ . '/vendor/autoload.php');

// 自定义WebSocket服务器类
class MyWebSocket implements MessageComponentInterface
{
    protected $clients;

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

    public function onOpen(ConnectionInterface $conn)
    {
        // 将新连接存储到$clients
        $this->clients->attach($conn);
    
        // 获取客户端地址
        $client_ip = $conn->remoteAddress;
    
        // 处理新连接(验证身份、发送欢迎消息等)
        // ...
    }

    public function onMessage(ConnectionInterface $from, $msg)
    {
        // 处理收到的消息
        // ...
    }

    public function onClose(ConnectionInterface $conn)
    {
        // 从$clients中删除关闭连接
        $this->clients->detach($conn);

        // 处理关闭连接
        // ...
    }

    public function onError(ConnectionInterface $conn, Exception $e)
    {
        // 处理WebSocket错误
        // ...
        
        // 关闭连接
        $conn->close();
    }
}

// 创建WebSocket服务器
$server = IoServer::factory(
    new WsServer(
        new MyWebSocket()
    ),
    8080
);

// 启动WebSocket服务器
$server->run();

In der onOpen-Methode können wir einige Verarbeitungen durchführen, z. B. die Verbindung überprüfen, eine Willkommensnachricht an den Client senden und die neue Verbindung protokollieren. In der onClose-Methode können wir das Ereignis des Schließens der Verbindung verarbeiten, z. B. das Entfernen der Verbindung aus der Liste und das Senden von Offline-Benachrichtigungen an andere Clients.

In der onMessage-Methode können wir die vom WebSocket-Client gesendete Nachricht verarbeiten. Da WebSocket ein bidirektionaler Kommunikationskanal ist, bedeutet dies, dass der Client auch Nachrichten an den Server senden kann und nicht nur der Server Nachrichten an den Client sendet, was die Fähigkeit der Anwendung zum Senden und Empfangen von Daten erheblich verbessert.

Durch die Kommunikation mit WebSockets über die PHP-API-Schnittstelle können Sie Daten in Echtzeit aktualisieren, was für Echtzeitanwendungen wie Echtzeittransaktionen, Nachrichten-Push und Spieleanwendungen von großer Bedeutung ist.

Das obige ist der detaillierte Inhalt vonPHP-API-Schnittstelle: So verwenden Sie WebSockets. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!

Stellungnahme:
Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn