PHP and WebSocket integration realize the development of real-time chat room

In the field of web development, real-time chat functions have become more and more popular. It helps users easily interact in real time and enhance communication and understanding. In order to implement real-time chat, we need to use the WebSocket protocol and need a programming language that can handle WebSocket requests. In this article, we will introduce how to implement the development of real-time chat rooms using PHP and WebSocket integration.

WebSocket is a full-duplex communication protocol that enables real-time data transmission between the browser and the server. Unlike HTTP requests, the server can push data to the browser after the WebSocket connection is established. Therefore, we can perform two-way data communication between the client and the server through WebSocket. When a user joins or exits the chat room, the message can be immediately pushed to other online users. This is the basic principle of real-time chat.

First, we need to create a PHP script on the server side to handle WebSocket requests. PHP's swoole extension can help us develop WebSocket servers. Next, we will implement our chat application step by step.

1. Install the swoole extension

To use the swoole extension, we need to install it first. Use the following command to install swoole in a Linux system:

pecl install swoole

If you use PHP in a Windows system, you can download and manually install the relevant DLL files from swoole's GitHub repository.

2. Set up the WebSocket server

Once we have successfully installed the swoole extension, we can start using it to create a WebSocket server. The following is the basic code to create a WebSocket server:

//创建WebSocket服务器
$server = new swoole_websocket_server("0.0.0.0", 9501);

//监听WebSocket连接打开事件
$server->on('open', function (swoole_websocket_server $server, $request) {
    echo "server: handshake success with fd{$request->fd}
";
});

//监听WebSocket消息事件
$server->on('message', function (swoole_websocket_server $server, $frame) {
    echo "receive from {$frame->fd}:{$frame->data},opcode:{$frame->opcode},fin:{$frame->finish}
";
    $server->push($frame->fd, json_encode(["hello", "world"]));
});

//监听WebSocket连接关闭事件
$server->on('close', function ($ser, $fd) {
    echo "client {$fd} closed
";
});

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

In this code snippet, we create a WebSocket server and register the event handler function. In the "open" event we will print out the message that the WebSocket connection is open. In the "message" event, we will print out information about the WebSocket session and send a message to the client. In the "close" event we will print the message that the WebSocket connection is closed.

3. Set up the chat room logic

Now we have successfully created the WebSocket server and set up the event handling function. Next, we can start implementing our chat room logic.

We need to set up a message broadcast function to notify all online users when a user joins or exits the chat room. The following is the code of the message broadcast function:

//广播消息
function broadcast($server, $frame, $users) {
    $data = json_decode($frame->data, true);
    switch ($data['type']) {
        case 'enter':
            $users[$frame->fd] = $data['name'];
            $msg = $data['name'] . ' joined the room.';
            break;
        case 'leave':
            $name = $users[$frame->fd];
            unset($users[$frame->fd]);
            $msg = $name . ' left the room.';
            break;
        case 'msg':
            $name = $users[$frame->fd];
            $msg = $name . ': ' . $data['msg'];
            break;
    }
    foreach ($server->connections as $fd) {
        $server->push($fd, json_encode(['type' => 'msg', 'msg' => $msg]));
    }
}

In this code snippet, we use switch statements to handle different types of messages. When a user joins or leaves the chat room, we update the user list and send a notification message. When a user sends a message, we will prefix the message with the username and broadcast it to all online users.

4. Complete chat room code

Now that we have all the necessary components ready, we can start writing the complete chat room code. The following is a complete chat room code:

//创建WebSocket服务器
$server = new swoole_websocket_server("0.0.0.0", 9501);

//定义用户列表
$users = [];

//广播消息
function broadcast($server, $frame, $users) {
    $data = json_decode($frame->data, true);
    switch ($data['type']) {
        case 'enter':
            $users[$frame->fd] = $data['name'];
            $msg = $data['name'] . ' joined the room.';
            break;
        case 'leave':
            $name = $users[$frame->fd];
            unset($users[$frame->fd]);
            $msg = $name . ' left the room.';
            break;
        case 'msg':
            $name = $users[$frame->fd];
            $msg = $name . ': ' . $data['msg'];
            break;
    }
    foreach ($server->connections as $fd) {
        $server->push($fd, json_encode(['type' => 'msg', 'msg' => $msg]));
    }
}

//监听WebSocket连接打开事件
$server->on('open', function (swoole_websocket_server $server, $request) {
    echo "server: handshake success with fd{$request->fd}
";
});

//监听WebSocket消息事件
$server->on('message', function (swoole_websocket_server $server, $frame) use ($users) {
    broadcast($server, $frame, $users);
});

//监听WebSocket连接关闭事件
$server->on('close', function ($ser, $fd) use ($users) {
    unset($users[$fd]);
    echo "client {$fd} closed
";
});

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

In this code snippet, we save the information of all online users in the $users array. We will update this array when a user joins or exits the chat room. In the WebSocket message event, we will broadcast the message using the broadcast() function. In the WebSocket connection close event, we will remove the disconnected user from the $users array.

5. Test your chat room

Now we have successfully created our chat room application. We can test it in all browsers that support WebSocket, such as Google Chrome, Firefox and Safari, etc. Here are the steps on how to test your chat room:

1. Run the above code using a PHP command
2. Open the index.html file in a browser
3. Enter the user name and click the "Enter Chat Room" button
4. Enter your message in the chat box and click the "Send" button

You should be able to see your message in all online users' chats Broadcast in the box.

Summary

In this article, we introduced how to use PHP and WebSocket integration to implement the development of real-time chat rooms. We used the swoole extension to create a WebSocket server and wrote a simple chat room application. Through this article, you can learn how to use the WebSocket protocol to establish a real-time data transmission connection, implement a WebSocket server in PHP, and use it to implement a chat room application.

The above is the detailed content of PHP and WebSocket integration realize the development of real-time chat room. For more information, please follow other related articles on the PHP Chinese website!