php+websocket 實現聊天室


一、配置 
開啟socket組建,否則會報 Fatal error: Call to undefined function socket_create() 錯誤
1、打開php.ini配置文件,搜索 extension=php_sockets.dll,把前面的‘;’分號刪掉。修改之后重啟服務。
注意:如果php版本多,一定要注意使用的哪個版本就要取修改哪個版本的php.ini文件,wamp開啟socket需要apache和php下面的php.ini一起修改,而phpstudy只需要修改一個php.ini.

2、檢查socket組建是否開啟
運行phpinfo.php查看,如果Sockets Support => enabled,就說明開啟成功了。

 3、設置cmd可以運行php文件
在“我的計算機->屬性->高級系統設置->高級->環境變量”,在用戶變量的PATH添加一條,指向php的路徑(注意版本要一致),在環境變量里的Path也需要添加一條,跟上面一樣

 4、測試socket和php是否配置成功
在項目下新建一個名叫start.php的文件
    

 if(extension_loaded('sockets')){
      echo "1";
    }else{
      echo "0";
    }

在cmd里輸入 php d:\phpstudy\www\start.php,如果輸出1,則說明配置正確,如果輸出0,則配置錯誤,需要仔細重新配置

二、實現流程

前端實現比較簡單,難點在后台,其邏輯如下:php主要就是接收加密key並返回其中完成套接字的創建和握手操作

 

  服務端的流程:
1、掛起一個socket套接字進程,等待連接
2、有socket連接之后,遍歷套接字數組
3、沒有握手的,進行握手操作,已經握手的,則把接收的數據解析並寫入緩沖區進行輸出。

三、前端代碼

<!DOCTYPE html>
    <html lang="en">
    <head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>websocket聊天室</title>
    <link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,600" rel="stylesheet">
    <link rel="stylesheet" href="/static/index/css/reset.min.css">
    <link rel="stylesheet" href="/static/index/css/chat.css">
    <link rel="stylesheet" href="/static/index/layui/layer/theme/default/layer.css">
    <style>
    .message img {
    float: left;
    width: 40px;
    height: 40px;
    margin-right: 12px;
    border-radius: 50%;
    }
    
    .you {
    margin-left: 60px;
    margin-top: -39px;
    }
    
    .me-header {
    float: right !important;
    margin-right: 0 !important;
    }
    
    .me {
    margin-right: 60px;
    margin-top: -39px;
    }
    
    .active-chat::-webkit-scrollbar, .left::-webkit-scrollbar {
    width: 2px;
    }
    </style>
    </head>
    <body>
    
    <div class="wrapper">
        <div class="container">
            <div class="left">
                <div class="top" style="padding: 20px 29px;height: auto;">
                    <div class="" style="font: 400 13.3333px Arial;font-weight: 400;">在線人數:<span id="numbers">0</span></div>
                </div>
                <ul class="people">
                </ul>
            </div>
            <div class="right">
                <div class="top"><span>Tips: <span class="name">PHP之websocket聊天室</span></span></div>
                <div class="chat active-chat" data-chat="person1"
                 style="height: auto;border-width: 0px;padding: 10px;height: 483px; padding: 10px;overflow-y: auto;scrollTop: 100px">
                </div>
                <div class="write">
                    <a href="javascript:;" class="write-link attach"></a>
                    <input type="text" id="input-value" onkeydown="confirm(event)"/>
                    <a href="javascript:;" class="write-link smiley"></a>
                    <a href="javascript:;" class="write-link send" onclick="send()"></a>
                </div>
            </div>
        </div>
    </div>
    
    <script src="/static/index/js/jquery-1.11.3.min.js"></script>
    <script src="/static/index/js/chat.js"></script>
    <script src="/static/index/layui/layer/layer.js"></script>
    <script>
    var uname = "user" + uuid(8, 11);
    layer.open({
        title: '您的用戶名如下',
        content: uname,
        closeBtn: 0,
        yes: function (index, layero) {
            layer.close(index);
        }
    });
    // 隨機選出一個頭像
    var avatar = ['a1.jpg', 'a2.jpg', 'a3.jpg', 'a4.jpg', 'a5.jpg', 'a6.jpg', 'a7.jpg', 'a8.jpg', 'a9.jpg', 'a10.jpg'];
    if (avatar[Math.round(Math.random() * 10)]) {
        var headerimg = "img/" + avatar[Math.round(Math.random() * 10)];
    } else {
        var headerimg = "img/" + avatar[0];
    }
    
    var ws = null;
    // 創建websocket連接
    connect();
    function connect() {
        // 創建一個 websocket 連接  ws://ip:端口號
        ws = new WebSocket("ws://127.0.0.1:1234");
        
        // 連接狀態 1已建立連接
        console.log(ws.readyState)
        
        //  連接建立時觸發
        ws.onopen = onopen;
        
        // 客戶端接收服務端數據時觸發
        ws.onmessage = onmessage;
        
        // 連接關閉時觸發
        ws.onclose = onclose;
        
        //  通信發生錯誤時觸發
        ws.onerror = onerror;
    }
    
    // 通信建立成功 
    function onopen()
    {
        var data = "系統消息:建立連接成功";
        console.log(data);
    }
    
    // 接收客戶端的數據,發送數據
    function onmessage(e)
    {
        var data = JSON.parse(e.data);
        console.log(data)
        
        switch (data.type) {
            case 'handShake':
                //首次登錄,發送登陸數據
                var user_info = {'type': 'login', 'msg': uname, 'headerimg': headerimg};
                sendMsg(user_info);
                break;
            case 'login':
                userList(data.user_list);
                systemMessage('系統消息: ' + data.msg + ' 已上線');
                break;
            case 'logout':
                userList(data.user_list);
                if (data.msg.length > 0) {
                systemMessage('系統消息: ' + data.msg + ' 已下線');
                }
                break;
            case 'user':
                messageList(data);
                break;
            case 'system':
                systemMessage();
                break;
        }
    }
    function onclose()
    {
        console.log("連接關閉,定時重連");
        connect();
    }
    
    // websocket 錯誤事件
    function onerror()
    {
        var data = "系統消息 : 出錯了,請退出重試.";
        console.log(data);
    }
    
    function confirm(event) {
        var key_num = event.keyCode;
        if (13 == key_num) {
            send();
        } else {
            return false;
        }
    }
    
    // 發送數據
    function send() {
        var msg = document.querySelector("input#input-value").value;
        var reg = new RegExp("\r\n", "g");
        msg = msg.replace(reg, "");
        sendMsg({type: "user", msg: msg});
        document.querySelector("input#input-value").value = "";
    }
    
    // 發送數據
    function sendMsg(msg) {
        var data = JSON.stringify(msg);
        ws.send(data);
    }
    
    
    // 追加數據 上下線的系統消息
    function systemMessage(msg) {
        var html = `<div class="conversation-start">
                <span>` + msg + `</span>
                </div>`;
        var active_chat = document.querySelector('div.active-chat');
        var oldHtml = active_chat.innerHTML;
        active_chat.innerHTML = oldHtml + html;
        active_chat.scrollTop = active_chat.scrollHeight;
    }
    
    // 追加從服務端返回的數據 左側在線人數列表
    function userList(user) {
        var html = '';
        for (var i = 0; i < user.length; i++) {
            html += `<li class="person" data-chat="person1">
                <img src="` + user[i].headerimg + `" alt=""/>
                <span class="name">` + user[i].username + `</span>
                <span class="time">` + user[i].login_time + `</span>
                <span class="preview" style="color: green;font-size: 7px;">在線</span>
                </li>`;
        }
        document.querySelector('ul.people').innerHTML = html;
        document.querySelector('span#numbers').innerHTML = user.length;
    }
    
    // 右側聊天記錄列表
    function messageList(data) {
    
       // 判讀是不是自己發送的消息,對應的樣式不同
        if (data.from == uname) {   
            // 如果當前用戶名和feom的用戶名相同,就說明時自己發送的消息
            var html = `<div class="message">
                    <img class="me-header" src="` + data.headerimg + `" alt=""/>
                    <div class="bubble me">` + data.msg + `</div>
                    </div>`;
        } else {
            // 別人發送的信息列表
            var html = `<div class="message">
                    <img src="` + data.headerimg + `" alt=""/>
                    <div class="bubble you">` + data.msg + `</div>
                    </div>`;
        }
        var active_chat = document.querySelector('div.active-chat');
        var oldHtml = active_chat.innerHTML;
        active_chat.innerHTML = oldHtml + html;
        active_chat.scrollTop = active_chat.scrollHeight;
    }
    
    /**
     * 生產一個全局唯一ID作為用戶名的默認值;
     *
     * @param len
     * @param radix
     * @returns {string}
     */
    function uuid(len, radix) {
        var chars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz'.split('');
        var uuid = [], i;
        radix = radix || chars.length;
        
        if (len) {
            for (i = 0; i < len; i++) uuid[i] = chars[0 | Math.random() * radix];
        } else {
            var r;
            
            uuid[8] = uuid[13] = uuid[18] = uuid[23] = '-';
            uuid[14] = '4';
            
            for (i = 0; i < 36; i++) {
                if (!uuid[i]) {
                    r = 0 | Math.random() * 16;
                    uuid[i] = chars[(i == 19) ? (r & 0x3) | 0x8 : r];
                }
            }
        }
        return uuid.join('');
    }
    </script>
    </body>
    </html>

 四、后端代碼

 

<?php
/**
 * Created by PhpStorm.
 * User: 25754
 * Date: 2019/4/23
 * Time: 14:13
 */

class socketServer
{

    const LISTEN_SOCKET_NUM = 9;
    const LOG_PATH = "./log/";  //日志
    private $_ip = "127.0.0.1"; //ip
    private $_port = 1234;  //端口 要和前端創建WebSocket連接時的端口號一致
    private $_socketPool = array(); //socket池,即存放套接字的數組
    private $_master = null;    //創建的套接字對象

    public function __construct()
    {
        $this->initSocket();
    }

    // 創建WebSocket連接
    private function initSocket()
    {
        try {
            //創建socket套接字
            $this->_master = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
            // 設置IP和端口重用,在重啟服務器后能重新使用此端口;
            socket_set_option($this->_master, SOL_SOCKET, SO_REUSEADDR, 1);
            //綁定地址與端口
            socket_bind($this->_master, $this->_ip, $this->_port);
            //listen函數使用主動連接套接口變為被連接套接口,使得一個進程可以接受其它進程的請求,從而成為一個服務器進程。在TCP服務器編程中listen函數把進程變為一個服務器,並指定相應的套接字變為被動連接,其中的能存儲的請求不明的socket數目。
            socket_listen($this->_master, self::LISTEN_SOCKET_NUM);
        } catch (Exception $e) {
            $this->debug(array("code: " . $e->getCode() . ", message: " . $e->getMessage()));
        }
        //將socket保存到socket池中  (將套接字放入數組)默認把當前用戶放在第一個
        $this->_socketPool[0] = array('resource' => $this->_master);
        $pid = getmypid();
        $this->debug(array("server: {$this->_master} started,pid: {$pid}"));
    }

    // 掛起進程遍歷套接字數組,對數據進行接收、處理、發送
    public function run()
    {
        // 死循環  直到socket斷開
        while (true) {
            try {
                
                $write = $except = NULL;
                // 從數組中取出resource列
                $sockets = array_column($this->_socketPool, 'resource');

               /* 
                $sockets 是一個存放文件描述符的數組。
                $write 是監聽是否客戶端寫數據,傳入NULL是不關心是否有寫變化
                $except 是$sockets里面要派粗話的元素,傳入null是監聽全部
                最后一個參數是超時時間,0立即結束 n>1則最多n秒后結束,如遇某一個連接有新動態,則提前返回  null如遇某一個連接有新動態,則返回
                */
                // 接收套接字數字,監聽他們的狀態就是有新消息到或有客戶端連接/斷開時,socket_select函數才會返回,繼續往下執行
                $read_num = socket_select($sockets, $write, $except, NULL);
                if (false === $read_num) {
                    $this->debug(array('socket_select_error', $err_code = socket_last_error(), socket_strerror($err_code)));
                    return;
                }

                // 遍歷套接字數組
                foreach ($sockets as $socket) {

                    // 如果有新的連接進來
                    if ($socket == $this->_master) {

                        // 接收一個socket連接
                        $client = socket_accept($this->_master);
                        if ($client === false) {
                            $this->debug(['socket_accept_error', $err_code = socket_last_error(), socket_strerror($err_code)]);
                            continue;
                        }
                        //連接 並放到socket池中
                        $this->connection($client);
                    } else {

                        //接收已連接的socket數據,返回的是從socket中接收的字節數。
                        // 第一個參數:socket資源,第二個參數:存儲接收的數據的變量,第三個參數:接收數據的長度
                        $bytes = @socket_recv($socket, $buffer, 2048, 0);

                        // 如果接收的字節數為0
                        if ($bytes == 0) {

                            // 斷開連接
                            $recv_msg = $this->disconnection($socket);
                        } else {

                            // 判斷有沒有握手,沒有握手進行握手,已經握手則進行處理
                            if ($this->_socketPool[(int)$socket]['handShake'] == false) {
                                // 握手
                                $this->handShake($socket, $buffer);
                                continue;
                            } else {
                                // 解析客戶端傳來的數據
                                $recv_msg = $this->parse($buffer);
                            }
                        }

                        // echo "<pre>";
                        // 業務處理,組裝返回客戶端的數據格式
                        $msg = $this->doEvents($socket, $recv_msg);
                        // print_r($msg);

                        socket_getpeername ( $socket  , $address ,$port );
                        $this->debug(array(
                            'send_success',
                            json_encode($recv_msg),
                            $address,
                            $port
                        ));
                        // 把服務端返回的數據寫入套接字
                        $this->broadcast($msg);
                    }
                }
            } catch (Exception $e) {
                $this->debug(array("code: " . $e->getCode() . ", message: " . $e->getMessage()));
            }

        }

    }

    /**
     * 數據廣播
     * @param $data
     */
    private function broadcast($data)
    {
        foreach ($this->_socketPool as $socket) {
            if ($socket['resource'] == $this->_master) {
                continue;
            }
            // 寫入套接字
            socket_write($socket['resource'], $data, strlen($data));
        }
    }

    /**
     * 業務處理,在這可以對數據庫進行操作,並返回客戶端數據;根據不同類型,組裝不同格式的數據
     * @param $socket
     * @param $recv_msg 客戶端傳來的數據
     * @return string
     */
    private function doEvents($socket, $recv_msg)
    {
        $msg_type = $recv_msg['type'];
        $msg_content = $recv_msg['msg'];
        $response = [];
        //echo "<pre>";
        switch ($msg_type) {
            case 'login':
            // 登陸上線信息
                $this->_socketPool[(int)$socket]['userInfo'] = array("username" => $msg_content, 'headerimg' => $recv_msg['headerimg'], "login_time" => date("h:i"));
                // 取得最新的名字記錄
                $user_list = array_column($this->_socketPool, 'userInfo');
                $response['type'] = 'login';
                $response['msg'] = $msg_content;
                $response['user_list'] = $user_list;
                //print_r($response);

                break;
            case 'logout':
            // 退出信息
                $user_list = array_column($this->_socketPool, 'userInfo');
                $response['type'] = 'logout';
                $response['user_list'] = $user_list;
                $response['msg'] = $msg_content;
                //print_r($response);
                break;
            case 'user':
            // 發送的消息
                $userInfo = $this->_socketPool[(int)$socket]['userInfo'];
                $response['type'] = 'user';
                $response['from'] = $userInfo['username'];
                $response['msg'] = $msg_content;
                $response['headerimg'] = $userInfo['headerimg'];
                //print_r($response);
                break;
        }

        return $this->frame(json_encode($response));
    }

    /**
     * socket握手
     * @param $socket
     * @param $buffer  客戶端接收的數據
     * @return bool
     */
    public function handShake($socket, $buffer)
    {
        $acceptKey = $this->encry($buffer);
        $upgrade = "HTTP/1.1 101 Switching Protocols\r\n" .
            "Upgrade: websocket\r\n" .
            "Connection: Upgrade\r\n" .
            "Sec-WebSocket-Accept: " . $acceptKey . "\r\n\r\n";

        // 將socket寫入緩沖區
        socket_write($socket, $upgrade, strlen($upgrade));
        // 標記握手已經成功,下次接受數據采用數據幀格式
        $this->_socketPool[(int)$socket]['handShake'] = true;
        socket_getpeername ( $socket  , $address ,$port );
        $this->debug(array(
            'hand_shake_success',
            $socket,
            $address,
            $port
        ));
        //發送消息通知客戶端握手成功
        $msg = array('type' => 'handShake', 'msg' => '握手成功');
        $msg = $this->frame(json_encode($msg));
        socket_write($socket, $msg, strlen($msg));
        return true;
    }

    /**
     * 幀數據封裝
     * @param $msg
     * @return string
     */
    private function frame($msg)
    {
        $frame = [];
        $frame[0] = '81';
        $len = strlen($msg);
        if ($len < 126) {
            $frame[1] = $len < 16 ? '0' . dechex($len) : dechex($len);
        } else if ($len < 65025) {
            $s = dechex($len);
            $frame[1] = '7e' . str_repeat('0', 4 - strlen($s)) . $s;
        } else {
            $s = dechex($len);
            $frame[1] = '7f' . str_repeat('0', 16 - strlen($s)) . $s;
        }
        $data = '';
        $l = strlen($msg);
        for ($i = 0; $i < $l; $i++) {
            $data .= dechex(ord($msg{$i}));
        }
        $frame[2] = $data;
        $data = implode('', $frame);
        return pack("H*", $data);
    }

    /**
     * 解析客戶端的數據
     * @param $buffer
     * @return mixed
     */
    private function parse($buffer)
    {
        $decoded = '';
        $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);
        }
        for ($index = 0; $index < strlen($data); $index++) {
            $decoded .= $data[$index] ^ $masks[$index % 4];
        }
        return json_decode($decoded, true);
    }

    //提取 Sec-WebSocket-Key 信息並加密
    private function encry($req)
    {
        $key = null;
        if (preg_match("/Sec-WebSocket-Key: (.*)\r\n/", $req, $match)) {
            $key = $match[1];
        }
        // 加密
        return base64_encode(sha1($key . '258EAFA5-E914-47DA-95CA-C5AB0DC85B11', true));
    }

    /**
     * 連接socket
     * @param $client
     */
    public function connection($client)
    {
        socket_getpeername ( $client  , $address ,$port );
        $info = array(
            'resource' => $client,
            'userInfo' => '',
            'handShake' => false,
            'ip' => $address,
            'port' => $port,
        );
        $this->_socketPool[(int)$client] = $info;
        $this->debug(array_merge(['socket_connect'], $info));
    }

    /**
     * 斷開連接
     * @param $socket
     * @return array
     */
    public function disconnection($socket)
    {
        $recv_msg = array(
            'type' => 'logout',
            'msg' => @$this->_socketPool[(int)$socket]['userInfo']['username'],
        );
        unset($this->_socketPool[(int)$socket]);
        return $recv_msg;
    }

    /**
     * 日志
     * @param array $info
     */
    private function debug(array $info)
    {
        $time = date('Y-m-d H:i:s');
        array_unshift($info, $time);
        $info = array_map('json_encode', $info);
        file_put_contents(self::LOG_PATH . 'websocket_debug.log', implode(' | ', $info) . "\r\n", FILE_APPEND);
    }
}

// 類外實例化
$sk = new socketServer();
// 運行
$sk -> run();

 

五、運行php

建立start.bat文件,運行php,也可以在cmd里輸入命令運行php

 

php ./socketServer.php
pause

 

運行結果如下:

注意:start.bat要一直運行,如果關了,就表示socket也關了,就不能通信了,所有需要start.bat一直運行

 項目地址:https://github.com/zhxiangfei/php-websocket-


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM