Using WebSocket in ThinkPHP6

With the rapid development of mobile Internet technology, users' demand for instant messaging and real-time interaction has gradually increased. As an important protocol for real-time communication on the Web, the WebSocket protocol has the characteristics of full-duplex communication, real-time push, and low latency, and has become the preferred protocol in real-time interaction scenarios. Therefore, in web development, we need to master how to use WebSocket to achieve real-time communication.

In PHP, we can use the Swoole extension to implement WebSocket functionality. However, it takes a lot of time and effort to deploy and set up Swoole. For some developers who are unfamiliar with Swoole, the learning cost is also relatively high.

Today, we are going to introduce how to use WebSocket in ThinkPHP6.

1. Install the extension

Before using WebSocket in ThinkPHP6, we need to install the topthink/thinker extension.

composer require topthink/thinker:dev-master

topthink/thinker is a command line tool for running PHP code and managing asynchronous tasks in ThinkPHP6.

2. Configure WebSocket

We need to configure WebSocket in the project configuration file config/socket.php.

<?php
return [
    // WebSocket服务器地址，使用内网穿透时填写内网地址
    'server' => '127.0.0.1:9501',

    // WebSocket的应用类，需要实现     hinkworkerServer 接口
    'worker_class' => 'appcontrollerWebSocket',
];

We need to specify the address of server and the class worker_class that implements the Server interface. Here we will implement the controller class of the WebSocket function. Name it WebSocket and place it in the appcontroller directory.

3. Implement WebSocket

We create a controller named WebSocket in the appcontroller directory and implement in the controller Server interface.

<?php
namespace appcontroller;

use thinkworkerServer;

class WebSocket implements Server
{
    protected $socket = 'websocket://127.0.0.1:9501';

    public function onMessage($connection, $data)
    {
        foreach ($this->worker->connections as $conn) {
            $conn->send('user ' . $connection->id . ' said: ' . $data);
        }
    }

    public function onConnect($connection)
    {
        echo "new connection from ip " . $connection->getRemoteIp() . "
";
    }

    public function onClose($connection)
    {
        echo "connection closed: " . $connection->id . "
";
    }

    public function onWorkerStart($worker)
    {
        // 初始化
    }
}

In the WebSocket controller class, we need to implement onMessage, onConnect, onClose and onWorkerStart Four methods.

• onMessage: When the client sends data, the onMessage method will be triggered. The parameter $connection represents the client’s connection object. $data represents the data sent by the client.
• onConnect: The onConnect method will be triggered when the client connects. The parameter $connection represents the client's connection object.
• onClose: The onClose method will be triggered when the client disconnects. The parameter $connection represents the client's connection object.
• onWorkerStart: The onWorkerStart method will be triggered when the worker process starts. The parameter $worker represents the object of the current worker process.

4. Run WebSocket

After configuring WebSocket, we can use the think command to start WebSocket.

php think worker:start

The above command will start a WebSocket service and output the running log on the console.

5. Test WebSocket

After WebSocket is implemented, we can use the WebSocket client for testing. We can use the Chrome browser and install the Simple WebSocket Client plug-in for testing. Enter the address of the WebSocket server in the plug-in and click Connect to start using WebSocket communication.

In Simple WebSocket Client, we can enter characters and click send, and we can see the output log in the background console, indicating that WebSocket communication can work normally.

Summary

In this article, we introduced how to use WebSocket in ThinkPHP6. The WebSocket protocol is the preferred protocol for real-time communication and its use scenarios are very wide. In actual development, we can use WebSocket to easily implement real-time communication functions according to needs and improve user experience.

The above is the detailed content of Using WebSocket in ThinkPHP6. For more information, please follow other related articles on the PHP Chinese website!