php - tcp 粘包/拆包实例

tcp 长链接模式下，使用固定消息头长度的方式进行消息拆包，解决粘包问题。

固定消息头协议

将消息头的前N个字节固定为消息长度位，结合业务场景，2bytes 或 4bytes，读取消息时先读取消息长度位，即可按具体的消息长度读取消息内容。

pack/unpack 可以打包数值至二进制/解包二进制至数值，具体的模式可以参考 pack/unpack 详细用法，这里我们选用固定头长度为2bytes来表示消息体长度，最大能表示2^16 - 1长度的消息体，不够你就上4bytes好了。

组包

<?php
// msg protocol
// | ---- dataLen ---- | data |
// | - fixed 2bytes  - |

// 模拟客户端连续发送2条消息
$foo = "hello world";
$bar = "i am sqrt_cat";

$package = "";

// 使用 n 打包 固定2bytes
$fooLenn = pack("n", strlen($foo));
$package = $fooLenn . $foo;

$barLenn = pack("n", strlen($bar));
$package .= $barLenn . $bar;

粘包

// send
// 传输 $package 由 $foo $bar 两条消息组成 模拟粘包场景
// receive

拆包

<?php
// 解析第1条消息 取前 2bytes 按 n 解包
$fooLen = unpack("n", substr($package, 0, 2))[1];
// 使用包消息体长度定义读取消息体
// 从第 3byte 开始读 前 2bytes表示长度
$foo = substr($package, 2, $fooLen);
echo $foo . PHP_EOL;

// 解析第2条消息 取前 2bytes 按 n 解包
// 0 ~ (2 + fooLen) - 1 字节序为 fooLen . foo
// (2 + fooLen) ~ (2 + fooLen) + 2 - 1 为 barLen
$barLen = unpack("n", substr($package, (2 + $fooLen), 2))[1];
$bar    = substr($package, (2 + $fooLen) + 2, $barLen);
echo $bar . PHP_EOL;

日常工作中经常遇到的tcp场景可能是短连接单个消息的模式，客户端发送一条消息后便关闭连接，服务端循环读取到EOF即可得到一条完整的消息。但如果是短连接多个消息或长链接模式下，就可能会发生粘包，客户端不关闭服务端无法通过EOL确定消息读取完毕的问题。这就需要定义协议和拆包。