PHP+Socket系列之實作websocket聊天室

藏色散人
發布: 2023-04-11 10:22:02
轉載
4144 人瀏覽過

本篇文章為大家帶來了關於php socket的相關知識,其中主要介紹了怎麼使用php原生socket實作一個簡易的web聊天室?有興趣的朋友下面一起來看一下,希望對大家有幫助。

php原生socket實作websocket聊天室

前言

這篇文章實作了使用php原生socket實作了一個簡易的web聊天室,最終程式碼在文章最底部。

不出意外的話這應該是這個系列文章的最後一篇了,寫這個系列文章時本以為是很簡單的東西,但實際幾篇寫下來使我幾乎通讀了workerman 的代碼,所以永遠不要眼高手低,一定還是要自己嘗試,最好是寫出來,才能證明自己真正的弄懂了一件事情

websocket介紹

webSocket 協議是一種網路通訊協議,在2008 年誕生,2011 年成為國際標準,RFC6455 定義了它的通訊標準,如今所有瀏覽器都已支援了該協定。 webSocket 是 HTML5 開始提供的一種在單一 TCP 連線上進行全雙工[^1]通訊的協議,伺服器可以主動向客戶端推送訊息,客戶端也可以主動向服務端發送訊息。
webSocket 約定了一個通訊協定的規範,透過握手機制,客戶端(瀏覽器)和伺服器(webserver)之間能建立一個類似 tcp 的連接,從而方便 cs 通訊。

為什麼需要websocket

HTTP 協定是一種無狀態的、無連線的、單向的應用層協定。它採用了請求=> 回應 模型,通訊請求只能由客戶端發起,服務端對請求做出應答處理,這種通訊模型有一個弊端:無法實現服務端主動向客戶端發起訊息。傳統的HTTP 請求,其並發能力都是依賴同時發起多個TCP 連線存取伺服器實現的而websocket 則允許我們在一條ws 連線上同時並發多個請求,即在A 請求發出後A 回應還未到達,就可以繼續發出B 請求。由於 TCP 的慢啟動特性,以及連線本身的握手損耗,都使得 websocket 協定的這項特性有很大的效率提升。

PHP+Socket系列之實作websocket聊天室

特點

  • 建立在TCP 協定之上,服務端的實作相對比較容易

  • 與HTTP 協定有良好的兼容性,預設連接埠也是80 和443,握手階段採用HTTP 協議,因此握手時不容易被屏蔽,能通過各種HTTP 代理伺服器。

  • 資料格式比較輕量,效能開銷小,通訊高效。

  • 可以傳送文本,也可以傳送二進位資料。

  • 沒有同源限制,客戶端可以與任意伺服器進行通訊。

  • 協定標識符是 ws(如果加密則為 wss),服務位址就是 URL。

PHP實作websocket

用戶端與服務端握手

websocket 協定在連線前需要握手[^2] ,通常握手方式有以下幾種方式

  • 基於flash 的握手協定(不建議)

  • 基於md5 加密方式的握手協定

    較早的握手方法,有兩個key,使用md5 加密

  • #基於sha1 加密方式的握手協議

    當前主要的握手協議,本文將以此協定為主

    • 取得用戶端上報的Sec-WebSocket-key

    • 拼接key 258EAFA5-E914-47DA-95CA-C5AB0DC85B11

    • ##對字串做

      SHA1 計算,再把得到的結果透過base64 加密,最後再傳回給客戶端

#客戶端請求資訊如下:

GET /chat HTTP/1.1Host: server.example.com
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==Origin: http://example.com
Sec-WebSocket-Protocol: chat, superchat
Sec-WebSocket-Version: 13
登入後複製
客戶端需傳回以下資料:

HTTP/1.1 101 Switching Protocols
Upgrade: websocket
Sec-WebSocket-Version: 13Connection: Upgrade
Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=
登入後複製
我們根據此協定透過PHP 方式實作:

<?php

$socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
socket_set_option($socket, SOL_SOCKET, SO_REUSEADDR, true);
socket_bind($socket, 0, 8888);
socket_listen($socket);

while (true) {
    $conn_sock = socket_accept($socket);
    $request = socket_read($conn_sock, 102400);

    $new_key = getShaKey($request);

    $response = "HTTP/1.1 101 Switching Protocols\r\n";
    $response .= "Upgrade: websocket\r\n";
    $response .= "Sec-WebSocket-Version: 13\r\n";
    $response .= "Connection: Upgrade\r\n";
    $response .= "Sec-WebSocket-Accept: {$new_key}\r\n\r\n";

    socket_write($conn_sock, $response);
}

function getShaKey($request)
{
    // 获取 Sec-WebSocket-key
    preg_match("/Sec-WebSocket-Key: (.*)\r\n/", $request, $match);

    // 拼接 key + 258EAFA5-E914-47DA-95CA-C5AB0DC85B11
    $new_key = trim($match[1]) . &#39;258EAFA5-E914-47DA-95CA-C5AB0DC85B11&#39;;

    // 对字符串做 `SHA1` 计算,再把得到的结果通过 `base64` 加密
    return base64_encode(sha1($new_key, true));
}
登入後複製

相關語法解釋可參考

先前的文章,本文章不做詳細介紹。

使用前端測試,開啟我們的任意瀏覽器控制台(console)輸入以下內容,傳回的websocket 物件的readyState 為1 即為握手成功,此為前端內容,本文不多做介紹,詳情可參考

菜鳥教學

console.log(new WebSocket(&#39;ws://192.162.2.166:8888&#39;));
// 运行后返回:
WebSocket {
    binaryType: "blob"
    bufferedAmount: 0
    extensions: ""
    onclose: null
    onerror: null
    onmessage: null
    onopen: null
    protocol: ""
    readyState: 1
    url: "ws://192.162.2.166:8888/"}
登入後複製

發送資料與接收資料#

使用 websocket 协议传输协议需要遵循特定的格式规范,详情请参考 datatracker.ietf.org/doc/html/rfc6...

PHP+Socket系列之實作websocket聊天室

为了方便,这里直接贴出加解密代码,以下代码借鉴与 workermansrc/Protocols/Websocket.php 文件:

// 解码客户端发送的消息
function decode($buffer)
{
    $len = \ord($buffer[1]) & 127;
    if ($len === 126) {
        $masks = \substr($buffer, 4, 4);
        $data = \substr($buffer, 8);
    } else {
        if ($len === 127) {
            $masks = \substr($buffer, 10, 4);
            $data = \substr($buffer, 14);
        } else {
            $masks = \substr($buffer, 2, 4);
            $data = \substr($buffer, 6);
        }
    }
    $dataLength = \strlen($data);
    $masks = \str_repeat($masks, \floor($dataLength / 4)) . \substr($masks, 0, $dataLength % 4);
    return $data ^ $masks;
}

// 编码发送给客户端的消息
function encode($buffer)
{
    if (!is_scalar($buffer)) {
        throw new \Exception("You can&#39;t send(" . \gettype($buffer) . ") to client, you need to convert it to a string. ");
    }
    $len = \strlen($buffer);

    $first_byte = "\x81";

    if ($len <= 125) {
        $encode_buffer = $first_byte . \chr($len) . $buffer;
    } else {
        if ($len <= 65535) {
            $encode_buffer = $first_byte . \chr(126) . \pack("n", $len) . $buffer;
        } else {
            $encode_buffer = $first_byte . \chr(127) . \pack("xxxxN", $len) . $buffer;
        }
    }

    return $encode_buffer;
}
登入後複製

我们修改刚才 客户端与服务端握手 阶段的代码,修改后全代码全文如下,该段代码实现了将客户端发送的消息转为大写后返回给客户端(当然只是为了演示):

<?php

$socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
socket_set_option($socket, SOL_SOCKET, SO_REUSEADDR, true);
socket_bind($socket, 0, 8888);
socket_listen($socket);

while (true) {
    $conn_sock = socket_accept($socket);
    $request = socket_read($conn_sock, 102400);

    $new_key = getShaKey($request);

    $response = "HTTP/1.1 101 Switching Protocols\r\n";
    $response .= "Upgrade: websocket\r\n";
    $response .= "Sec-WebSocket-Version: 13\r\n";
    $response .= "Connection: Upgrade\r\n";
    $response .= "Sec-WebSocket-Accept: {$new_key}\r\n\r\n";

    // 发送握手数据
    socket_write($conn_sock, $response);

    // 新增内容,获取客户端发送的消息并转为大写还给客户端
    $msg = socket_read($conn_sock, 102400);
    socket_write($conn_sock, encode(strtoupper(decode($msg))));
}

function getShaKey($request)
{
    // 获取 Sec-WebSocket-key
    preg_match("/Sec-WebSocket-Key: (.*)\r\n/", $request, $match);

    // 拼接 key + 258EAFA5-E914-47DA-95CA-C5AB0DC85B11
    $new_key = trim($match[1]) . &#39;258EAFA5-E914-47DA-95CA-C5AB0DC85B11&#39;;

    // 对字符串做 `SHA1` 计算,再把得到的结果通过 `base64` 加密
    return base64_encode(sha1($new_key, true));
}

function decode($buffer)
{
    $len = \ord($buffer[1]) & 127;
    if ($len === 126) {
        $masks = \substr($buffer, 4, 4);
        $data = \substr($buffer, 8);
    } else {
        if ($len === 127) {
            $masks = \substr($buffer, 10, 4);
            $data = \substr($buffer, 14);
        } else {
            $masks = \substr($buffer, 2, 4);
            $data = \substr($buffer, 6);
        }
    }
    $dataLength = \strlen($data);
    $masks = \str_repeat($masks, \floor($dataLength / 4)) . \substr($masks, 0, $dataLength % 4);
    return $data ^ $masks;
}

function encode($buffer)
{
    if (!is_scalar($buffer)) {
        throw new \Exception("You can&#39;t send(" . \gettype($buffer) . ") to client, you need to convert it to a string. ");
    }
    $len = \strlen($buffer);

    $first_byte = "\x81";

    if ($len <= 125) {
        $encode_buffer = $first_byte . \chr($len) . $buffer;
    } else {
        if ($len <= 65535) {
            $encode_buffer = $first_byte . \chr(126) . \pack("n", $len) . $buffer;
        } else {
            $encode_buffer = $first_byte . \chr(127) . \pack("xxxxN", $len) . $buffer;
        }
    }

    return $encode_buffer;
}
登入後複製

使用 在线测试工具 进行测试,可以看到消息已经可以正常发送接收,接下来的文章将继续优化代码,实现简易聊天室,敬请关注:

PHP+Socket系列之實作websocket聊天室

实现web聊天室

我们紧接着上文的代码继续优化,以实现简易的web聊天室

多路复用

其实就是加一下 socket_select() 函数 PHP+Socket系列之實作websocket聊天室 ,本文就不写原理与语法了,详情可参考 之前的文章,以下代码修改自前文 PHP+Socket系列之實作websocket聊天室

...

socket_listen($socket);

+$sockets[] = $socket;
+$user = [];
while (true) {
+   $tmp_sockets = $sockets;
+   socket_select($tmp_sockets, $write, $except, null);

+   foreach ($tmp_sockets as $sock) {
+       if ($sock == $socket) {
+           $sockets[] = socket_accept($socket);
+           $user[] = [&#39;socket&#39; => $socket, &#39;handshake&#39; => false];
+       } else {
+           $curr_user = $user[array_search($sock, $user)];
+           if ($curr_user[&#39;handshake&#39;]) { // 已握手
+               $msg = socket_read($sock, 102400);
+               echo &#39;客户端发来消息&#39; . decode($msg);
+               socket_write($sock, encode(&#39;这是来自服务端的消息&#39;));
+           } else {
+               // 握手
+           }
+       }
+   }

-   $conn_sock = socket_accept($socket);
-   $request = socket_read($conn_sock, 102400);

...
登入後複製

实现聊天室

最终成果演示

PHP+Socket系列之實作websocket聊天室

我们将上述代码改造成类,并在类变量储存用户信息,添加消息处理等逻辑,最后贴出代码,建议保存下来自己尝试一下,也许会有全新的认知,后端代码:

<?php

new WebSocket();

class Websocket
{
    /**
     * @var resource
     */
    protected $socket;

    /**
     * @var array 用户列表
     */
    protected $user = [];

    /**
     * @var array 存放所有 socket 资源
     */
    protected $socket_list = [];

    public function __construct()
    {
        $this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
        socket_set_option($this->socket, SOL_SOCKET, SO_REUSEADDR, true);
        socket_bind($this->socket, 0, 8888);
        socket_listen($this->socket);

        // 将 socket 资源放入 socket_list
        $this->socket_list[] = $this->socket;

        while (true) {
            $tmp_sockets = $this->socket_list;
            socket_select($tmp_sockets, $write, $except, null);

            foreach ($tmp_sockets as $sock) {
                if ($sock == $this->socket) {
                    $conn_sock = socket_accept($sock);
                    $this->socket_list[] = $conn_sock;
                    $this->user[] = [&#39;socket&#39; => $conn_sock, &#39;handshake&#39; => false, &#39;name&#39; => &#39;无名氏&#39;];
                } else {
                    $request = socket_read($sock, 102400);
                    $k = $this->getUserIndex($sock);

                    if (!$request) {
                        continue;
                    }

                    // 用户端断开连接
                    if ((\ord($request[0]) & 0xf) == 0x8) {
                        $this->close($k);
                        continue;
                    }

                    if (!$this->user[$k][&#39;handshake&#39;]) {
                        // 握手
                        $this->handshake($k, $request);
                    } else {
                        // 已握手
                        $this->send($k, $request);
                    }
                }
            }
        }
    }

    /**
     * 关闭连接
     *
     * @param $k
     */
    protected function close($k)
    {
        $u_name = $this->user[$k][&#39;name&#39;] ?? &#39;无名氏&#39;;
        socket_close($this->user[$k][&#39;socket&#39;]);
        $socket_key = array_search($this->user[$k][&#39;socket&#39;], $this->socket_list);
        unset($this->socket_list[$socket_key]);
        unset($this->user[$k]);

        $user = [];
        foreach ($this->user as $v) {
            $user[] = $v[&#39;name&#39;];
        }
        $res = [
            &#39;type&#39; => &#39;close&#39;,
            &#39;users&#39; => $user,
            &#39;msg&#39; => $u_name . &#39;已退出&#39;,
            &#39;time&#39; => date(&#39;Y-m-d H:i:s&#39;)
        ];
        $this->sendAllUser($res);
    }

    /**
     * 获取用户索引
     *
     * @param $socket
     * @return int|string
     */
    protected function getUserIndex($socket)
    {
        foreach ($this->user as $k => $v) {
            if ($v[&#39;socket&#39;] == $socket) {
                return $k;
            }
        }
    }

    /**
     * 握手
     * @param $k
     * @param $request
     */
    protected function handshake($k, $request)
    {
        preg_match("/Sec-WebSocket-Key: (.*)\r\n/", $request, $match);
        $key = base64_encode(sha1($match[1] . &#39;258EAFA5-E914-47DA-95CA-C5AB0DC85B11&#39;, true));

        $response = "HTTP/1.1 101 Switching Protocols\r\n";
        $response .= "Upgrade: websocket\r\n";
        $response .= "Connection: Upgrade\r\n";
        $response .= "Sec-WebSocket-Accept: {$key}\r\n\r\n";
        socket_write($this->user[$k][&#39;socket&#39;], $response);
        $this->user[$k][&#39;handshake&#39;] = true;
    }

    /**
     * 接收并处理消息
     *
     * @param $k
     * @param $msg
     */
    public function send($k, $msg)
    {
        $msg = $this->decode($msg);
        $msg = json_decode($msg, true);

        if (!isset($msg[&#39;type&#39;])) {
            return;
        }

        switch ($msg[&#39;type&#39;]) {
            case &#39;login&#39;: // 登录
                $this->user[$k][&#39;name&#39;] = $msg[&#39;name&#39;] ?? &#39;无名氏&#39;;
                $users = [];
                foreach ($this->user as $v) {
                    $users[] = $v[&#39;name&#39;];
                }
                $res = [
                    &#39;type&#39; => &#39;login&#39;,
                    &#39;name&#39; => $this->user[$k][&#39;name&#39;],
                    &#39;msg&#39; => $this->user[$k][&#39;name&#39;] . &#39;: login success&#39;,
                    &#39;users&#39; => $users,
                ];
                $this->sendAllUser($res);
                break;
            case &#39;message&#39;: // 接收并发送消息
                $res = [
                    &#39;type&#39; => &#39;message&#39;,
                    &#39;name&#39; => $this->user[$k][&#39;name&#39;] ?? &#39;无名氏&#39;,
                    &#39;msg&#39; => $msg[&#39;msg&#39;],
                    &#39;time&#39; => date(&#39;H:i:s&#39;),
                ];
                $this->sendAllUser($res);
                break;
        }
    }

    /**
     * 发送给所有人
     *
     */
    protected function sendAllUser($msg)
    {
        if (is_array($msg)) {
            $msg = json_encode($msg);
        }

        $msg = $this->encode($msg);

        foreach ($this->user as $k => $v) {
            socket_write($v[&#39;socket&#39;], $msg, strlen($msg));
        }
    }

    /**
     * 解码
     *
     * @param $buffer
     * @return string
     */
    protected function decode($buffer)
    {
        $len = \ord($buffer[1]) & 127;
        if ($len === 126) {
            $masks = \substr($buffer, 4, 4);
            $data = \substr($buffer, 8);
        } else {
            if ($len === 127) {
                $masks = \substr($buffer, 10, 4);
                $data = \substr($buffer, 14);
            } else {
                $masks = \substr($buffer, 2, 4);
                $data = \substr($buffer, 6);
            }
        }
        $dataLength = \strlen($data);
        $masks = \str_repeat($masks, \floor($dataLength / 4)) . \substr($masks, 0, $dataLength % 4);
        return $data ^ $masks;
    }

    protected function encode($buffer)
    {
        if (!is_scalar($buffer)) {
            throw new \Exception("You can&#39;t send(" . \gettype($buffer) . ") to client, you need to convert it to a string. ");
        }
        $len = \strlen($buffer);

        $first_byte = "\x81";

        if ($len <= 125) {
            $encode_buffer = $first_byte . \chr($len) . $buffer;
        } else {
            if ($len <= 65535) {
                $encode_buffer = $first_byte . \chr(126) . \pack("n", $len) . $buffer;
            } else {
                $encode_buffer = $first_byte . \chr(127) . \pack("xxxxN", $len) . $buffer;
            }
        }

        return $encode_buffer;
    }
}
登入後複製

前端代码如下(前端内容不在本文讨论范围之内,具体可参考 菜鸟教程):

<!doctype html>
<html>
<head>
    <meta charset="UTF-8">
    <meta name="viewport"
          content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>Document</title>
</head>
<style>
    * {
        margin: 0;
        padding: 0;
    }
    h3 {
        display: flex;
        justify-content: center;
        margin: 30px auto;
    }
    .but-box {
        border-radius: 5px;
        display: flex;
        justify-content: center;
        align-items: center;
        margin-top: 10px;
    }
    #box {
        display: flex;
        margin: 5px auto;
        border-radius: 5px;
        border: 1px #ccc solid;
        height: 400px;
        width: 700px;
        overflow-y: auto;
        overflow-x: hidden;
        position: relative;
    }
    #msg-box {
        width: 480px;
        margin-right: 111px;
        height: 100%;
        overflow-y: auto;
        overflow-x: hidden;
    }
    #user-box {
        width: 110px;
        overflow-y: auto;
        overflow-x: hidden;
        float: left;
        border-left: 1px #ccc solid;
        height: 100%;
        background-color: #F1F1F1;
    }
    button {
        float: right;
        width: 80px;
        height: 35px;
        font-size: 18px;
    }
    input {
        width: 100%;
        height: 30px;
        padding: 2px;
        line-height: 20px;
        outline: none;
        border: solid 1px #CCC;
    }
    .but-box p {
        margin-right: 160px;
    }
</style>
<body>

<h3>这是一个php socket实现的web聊天室</h3>

<div id="box">
    <div id="msg-box"></div>
    <div id="user-box"></div>
</div>

<div>

    <p><textarea cols="60" rows="3" style="resize:none;pedding: 10px"    id="content"> </textarea></p>
    <button id="send">发送</button>
</div>
<script src="https://cdn.bootcss.com/jquery/2.2.1/jquery.min.js"></script>
<script>
    let ws = new WebSocket(&#39;ws://124.222.85.67:8888&#39;);

    ws.onopen = function (event) {
        console.log(&#39;连接成功&#39;);

        var name = prompt(&#39;请输入用户名:&#39;);

        ws.send(JSON.stringify({
            type: &#39;login&#39;,
            name: name
        }));

        if (!name) {
            alert(&#39;好你个坏蛋,竟然没有输入用户名&#39;);
        }
    };
    ws.onmessage = function (event) {
        let data = JSON.parse(event.data);
        console.log(data);

        switch (data.type) {
            case &#39;close&#39;:
            case &#39;login&#39;:
                $("#user-box").html(&#39;&#39;);
                data.users.forEach(function (item) {
                    $("#user-box").append(`<p style="color: grey;">${item}</p>`);
                });
                if (data.msg) {
                    $("#msg-box").append(`<p style="color: grey;">${data.msg}</p>`);
                }
                break;
            case &#39;message&#39;:
                $("#msg-box").append(`<p><span style="color: #0A89FF">${data.time}</span><span style="color: red">${data.name}</span>${data.msg}</p>`);
                break;
        }
    };

    ws.onclose = function (event) {
        alert(&#39;连接关闭&#39;);
    };

    document.onkeydown = function (event) {
        if (event.keyCode == 13) {
            send();
        }
    }

    $("#send").click(function () {
        send();
    });

    function send() {
        let content = $("#content").val();
        $("#content").val(&#39;&#39;);
        if (!content) {
            return;
        }
        ws.send(JSON.stringify({
            type: &#39;message&#39;,
            msg: content
        }));
    }
</script>
</body>
</html>
登入後複製

[^1]:是通讯传输的一个术语。 通信允许数据在两个方向上同时传输,它在能力上相当于两个单工通信方式的结合
[^2]:  为了建立 websocket 连接,需要通过浏览器发出请求,之后服务器进行回应,这个过程通常称为“握手”(Handshaking)

推荐学习:《PHP视频教程》                                            

以上是PHP+Socket系列之實作websocket聊天室的詳細內容。更多資訊請關注PHP中文網其他相關文章!

相關標籤:
來源:learnku.com
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板
關於我們 免責聲明 Sitemap
PHP中文網:公益線上PHP培訓,幫助PHP學習者快速成長!