站長(zhǎng)資訊網(wǎng)
下面我畫了一個(gè)圖演示 client 和 server 之間建立 websocket 連接時(shí)握手部分，這個(gè)部分在 node 中可以十分輕松的完成，因?yàn)?node 提供的 net 模塊已經(jīng)對(duì) socket 套接字做了封裝處理，開發(fā)者使用的時(shí)候只需要考慮數(shù)據(jù)的交互而不用處理連接的建立。而 php 沒有，從 socket 的連接、建立、綁定、監(jiān)聽等，這些都需要我們自己去操作，所以有必要拿出來(lái)再說(shuō)一說(shuō)。
+--------+ 1.發(fā)送Sec-WebSocket-Key +---------+ | | --------------------------------> | | | | 2.加密返回Sec-WebSocket-Accept | | | client | <-------------------------------- | server | | | 3.本地校驗(yàn) | | | | --------------------------------> | | +--------+ +--------+
看了我寫的上一篇文章的同學(xué)應(yīng)該是對(duì)上圖有了比較全面的理解。① 和 ② 實(shí)際上就是一個(gè) HTTP 的請(qǐng)求和響應(yīng)，只不過(guò)我們?cè)谔幚淼倪^(guò)程中我們拿到的是沒有經(jīng)過(guò)解析的字符串。如：
GET /chat HTTP/1.1 Host: server.example.com Origin: http://example.com
我們往?？吹降恼?qǐng)求是這個(gè)樣子，當(dāng)這東西到了服務(wù)器端，我們可以通過(guò)一些代碼庫(kù)直接拿到這些信息。
一、php 中處理 websocket
WebSocket 連接是由客戶端主動(dòng)發(fā)起的，所以一切要從客戶端出發(fā)。第一步是要解析拿到客戶端發(fā)過(guò)來(lái)的 Sec-WebSocket-Key 字符串。
GET /chat HTTP/1.1 Host: server.example.com Upgrade: websocket Connection: Upgrade Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ== Origin: http://example.com Sec-WebSocket-Protocol: chat, superchat Sec-WebSocket-Version: 13
前文中也提到了 client 請(qǐng)求的格式（如上），首先 php 建立一個(gè) socket 連接，監(jiān)聽端口的信息。
1. socket 連接的建立
關(guān)于 socket 套接字的建立，相信很多大學(xué)修過(guò)計(jì)算機(jī)網(wǎng)絡(luò)的人都知道了，下面是一張連接建立的過(guò)程：
// 建立一個(gè) socket 套接字 $master = socket_create(AF_INET, SOCK_STREAM, SOL_TCP); socket_set_option($master, SOL_SOCKET, SO_REUSEADDR, 1); socket_bind($master, $address, $port); socket_listen($master);
相比 node，這個(gè)地方的處理實(shí)在是太麻煩了，上面幾行代碼并未建立連接，只不過(guò)這些代碼是建立一個(gè) socket 套接字必須要寫的東西。由于處理過(guò)程稍微有復(fù)雜，所以我把各種處理寫進(jìn)了一個(gè)類中，方便管理和調(diào)用。
//demo.php Class WS { var $master; // 連接 server 的 client var $sockets = array(); // 不同狀態(tài)的 socket 管理 var $handshake = false; // 判斷是否握手 function __construct($address, $port){ // 建立一個(gè) socket 套接字 $this->master = socket_create(AF_INET, SOCK_STREAM, SOL_TCP) or die("socket_create() failed"); socket_set_option($this->master, SOL_SOCKET, SO_REUSEADDR, 1) or die("socket_option() failed"); socket_bind($this->master, $address, $port) or die("socket_bind() failed"); socket_listen($this->master, 2) or die("socket_listen() failed"); $this->sockets[] = $this->master; // debug echo("Master socket : ".$this->master."n"); while(true) { //自動(dòng)選擇來(lái)消息的 socket 如果是握手 自動(dòng)選擇主機(jī) $write = NULL; $except = NULL; socket_select($this->sockets, $write, $except, NULL); foreach ($this->sockets as $socket) { //連接主機(jī)的 client if ($socket == $this->master){ $client = socket_accept($this->master); if ($client < 0) { // debug echo "socket_accept() failed"; continue; } else { //connect($client); array_push($this->sockets, $client); echo "connect clientn"; } } else { $bytes = @socket_recv($socket,$buffer,2048,0); if($bytes == 0) return; if (!$this->handshake) { // 如果沒有握手，先握手回應(yīng) //doHandShake($socket, $buffer); echo "shakeHandsn"; } else { // 如果已經(jīng)握手，直接接受數(shù)據(jù)，并處理 $buffer = decode($buffer); //process($socket, $buffer); echo "send filen"; } } } } } }
demo.php 握手連接測(cè)試代碼
上面這段代碼是經(jīng)過(guò)我調(diào)試了的，沒太大的問(wèn)題，如果想測(cè)試的話，可以在 cmd 命令行中鍵入 php /path/to/demo.php;當(dāng)然，上面只是一個(gè)類，如果要測(cè)試的話，還得新建一個(gè)實(shí)例。
$ws = new WS('localhost', 4000);
客戶端代碼可以稍微簡(jiǎn)單點(diǎn)：
var ws = new WebSocket("ws://localhost:4000"); ws.onopen = function(){ console.log("握手成功"); }; ws.onerror = function(){ console.log("error"); };
運(yùn)行服務(wù)器代碼，當(dāng)客戶端連接的時(shí)候，我們可以看到：
通過(guò)上面的代碼可以清晰的看到整個(gè)交流的過(guò)程。首先是建立連接，node 中這一步已經(jīng)封裝到了 net 和 http 模塊，然后判斷是否握手，如果沒有的話，就 shakeHands。這里的握手我直接就 echo 了一個(gè)單詞，表示進(jìn)行了這個(gè)東西，前文我們提到過(guò)握手算法，這里就直接寫了。
2. 提取 Sec-WebSocket-Key 信息
function getKey($req) { $key = null; if (preg_match("/Sec-WebSocket-Key: (.*)rn/", $req, $match)) { $key = $match[1]; } return $key; }
這里比較簡(jiǎn)單，直接正則匹配，websocket 信息頭一定包含 Sec-WebSocket-Key，所以我們匹配起來(lái)也比較快捷~
3. 加密 Sec-WebSocket-Key
function encry($req){ $key = $this->getKey($req); $mask = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"; return base64_encode(sha1($key . '258EAFA5-E914-47DA-95CA-C5AB0DC85B11', true)); }
將 SHA-1 加密后的字符串再進(jìn)行一次 base64 加密。如果加密算法錯(cuò)誤，客戶端在進(jìn)行校檢的時(shí)候會(huì)直接報(bào)錯(cuò)：
4. 應(yīng)答 Sec-WebSocket-Accept
function dohandshake($socket, $req){ // 獲取加密key $acceptKey = $this->encry($req); $upgrade = "HTTP/1.1 101 Switching Protocolsrn" . "Upgrade: websocketrn" . "Connection: Upgradern" . "Sec-WebSocket-Accept: " . $acceptKey . "rn" . "rn"; // 寫入socket socket_write(socket,$upgrade.chr(0), strlen($upgrade.chr(0))); // 標(biāo)記握手已經(jīng)成功，下次接受數(shù)據(jù)采用數(shù)據(jù)幀格式 $this->handshake = true; }
這里千萬(wàn)要注意，每一個(gè)請(qǐng)求和相應(yīng)的格式，最后有一個(gè)空行，也就是 rn，開始測(cè)試的時(shí)候把這東西給弄丟了，糾結(jié)了半天。
當(dāng)客戶端成功校檢key后，會(huì)觸發(fā) onopen 函數(shù)：
5. 數(shù)據(jù)幀處理
// 解析數(shù)據(jù)幀 function decode($buffer) { $len = $masks = $data = $decoded = null; $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 $decoded; }
這里涉及的編碼問(wèn)題在前文中已經(jīng)提到過(guò)了，這里就不贅述，php 對(duì)字符處理的函數(shù)太多了，也記得不是特別清楚，這里就沒有詳細(xì)的介紹解碼程序，直接把客戶端發(fā)送的數(shù)據(jù)原樣返回，可以算是一個(gè)聊天室的模式吧。
// 返回幀信息處理 function frame($s) { $a = str_split($s, 125); if (count($a) == 1) { return "x81" . chr(strlen($a[0])) . $a[0]; } $ns = ""; foreach ($a as $o) { $ns .= "x81" . chr(strlen($o)) . $o; } return $ns; } // 返回?cái)?shù)據(jù) function send($client, $msg){ $msg = $this->frame($msg); socket_write($client, $msg, strlen($msg)); }
客戶端代碼：
var ws = new WebSocket("ws://localhost:4000"); ws.onopen = function(){ console.log("握手成功"); }; ws.onmessage = function(e){ console.log("message:" + e.data); }; ws.onerror = function(){ console.log("error"); }; ws.send("李靖");
在連通之后發(fā)送數(shù)據(jù)，服務(wù)器原樣返回：
二、注意問(wèn)題
1. websocket 版本問(wèn)題
客戶端在握手時(shí)的請(qǐng)求中有Sec-WebSocket-Version: 13，這樣的版本標(biāo)識(shí)，這個(gè)是一個(gè)升級(jí)版本，現(xiàn)在的瀏覽器都是使用的這個(gè)版本。而以前的版本在數(shù)據(jù)加密的部分更加麻煩，它會(huì)發(fā)送兩個(gè)key：
GET /chat HTTP/1.1 Host: server.example.com Upgrade: websocket Connection: Upgrade Origin: http://example.com Sec-WebSocket-Protocol: chat, superchat Sec-WebSocket-Key1: xxxx Sec-WebSocket-Key2: xxxx
如果是這種版本（比較老，已經(jīng)沒在使用了），需要通過(guò)下面的方式獲取
function encry($key1,$key2,$l8b){ //Get the numbers preg_match_all('/([d]+)/', $key1, $key1_num); preg_match_all('/([d]+)/', $key2, $key2_num); $key1_num = implode($key1_num[0]); $key2_num = implode($key2_num[0]); //Count spaces preg_match_all('/([ ]+)/', $key1, $key1_spc); preg_match_all('/([ ]+)/', $key2, $key2_spc); if($key1_spc==0|$key2_spc==0){ $this->log("Invalid key");return; } //Some math $key1_sec = pack("N",$key1_num / $key1_spc); $key2_sec = pack("N",$key2_num / $key2_spc); return md5($key1_sec.$key2_sec.$l8b,1); }
只能無(wú)限吐槽這種驗(yàn)證方式！相比 nodeJs 的 websocket 操作方式：
//服務(wù)器程序 var crypto = require('crypto'); var WS = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11'; require('net').createServer(function(o){ var key; o.on('data',function(e){ if(!key){ //握手 key = e.toString().match(/Sec-WebSocket-Key: (.+)/)[1]; key = crypto.createHash('sha1').update(key + WS).digest('base64'); o.write('HTTP/1.1 101 Switching Protocolsrn'); o.write('Upgrade: websocketrn'); o.write('Connection: Upgradern'); o.write('Sec-WebSocket-Accept: ' + key + 'rn'); o.write('rn'); }else{ console.log(e); }; }); }).listen(8000);
多么簡(jiǎn)潔，多么方便！有誰(shuí)還愿意使用 php 呢。。。。
2. 數(shù)據(jù)幀解析代碼
本文沒有給出 decodeFrame 這樣數(shù)據(jù)幀解析代碼，前文中給出了數(shù)據(jù)幀的格式，解析純屬體力活。
3. 代碼下載
對(duì)這部分感興趣的同學(xué)，可以再去深究。提供了參考代碼下載。
4. 相關(guān)開源庫(kù)參考
socketo.me Ratchet 為 php 封裝的一個(gè) WebSockets 庫(kù)。 ]
Google 上搜索 php+websoket+class，也能找到不少相關(guān)的資料。
三、參考資料
- www.php.net/manual/zh/r… php manual
- www.rfc-editor.org/rfc/rfc6455… [RFC6455] WebSocket
推薦教程：《php教程》
