Workerman 自定义的协议如何解决粘包拆包

北桥苏 2024-08-17

前言

由于最近在使用 workerman 实现 Unity3D 联机游戏的服务端，虽然也可以通过 TCP 协议直接通信，但是在实际测试的过程中发现了一些小问题。

比如双方的数据包都是字符串的方式吗，还有就因为是字符串就需要切割，而有时候在客户端或服务端接收时都会出现报错。

经过打印日志发现，两端接收到的包都有出现不是事先约定好的格式，这也就是 TCP 的粘包拆包现象。这个的解决方法很简单，网上也有很多，但是这里是想用自己实现的协议解决，暂且放到后面来说。

问题解答

关于网游的通信数据包格式的约定，我在网上也看过一些。如果不是用弱类型语言做服务端脚本，其实别人常用的是字节数组。

但是 PHP 在接收到字节数组时，其实就是字符串，但前提时该字节数组没有一些特定转换的。就拿 C# 来说，在解决粘包等问题会在字节数组前加入字节长度 (BitConverter.GetBytes (len))。

但是这个传递到 PHP 服务端接收时，字符串前 4 个字节就是显示不出来，用过很多方法进行转换都取不出来。

后来也想过用 Protobuf 数据方式，虽然 PHP 可以对数据可以转换，但是客户端 C# 我还不太熟就放弃了。

还一个问题是，其实别人做网游服务端实现帧同步大部分都是 UDP 协议，同时也有 TCP 和 UDP 共用。

但是如果只是小型多人在线游戏，用 PHP 做服务端，TCP 协议通信也完全可以的。接下来就回到 workerman 的自定义协议和粘包拆包问题吧。

自定义协议

workerman 对 PHP 的几个 socket 函数进行了封装 (关于 socket 函数，如果愿意折腾，php 也可以写一个文件传输的小工具的)，基于 TCP 之上也自带了几个应用层协议，比如 Http, Websocket, Frame 等。

也预留了用户自行定义协议的路口，只需要实现他的 ProtocolInterface 接口，以下就简单介绍以下接口需要实现的几个方法。

Input 方法

在这个方法里，可以在服务端接收前对数据包进行解包，检查包长度，过滤等。返回 0 就将数据包放入接收端的缓冲内继续等待，返回指定长度则表示取出缓冲区内长度。如果异常也可以返回 false 直接关闭该客户端连接。

encode 方法

该方法是服务端在发送数据包到客户端前，对数据包格式的处理，也就是封包，这个就要前后端约定好了。

decode 方法

这个方法也就是解包，就是从缓冲区里取出指定长度到 onMessage 接收前要进行处理的地方，比如进行逻辑调配等等。

粘包拆包产生现象

由于 TCP 是基于流的，且因为是传输层，在上层的应用通过 socket 套接字 (理解为接口) 通信时，他不知道传递过来的数据包开头结尾在哪。

只是根据 TCP 的一套拥塞算法机型粘合或拆解的发送。所以从字面上看，粘包就是几个数据包一起发送，原本应该是两个包，客户端只收到了一个包。而拆包是将一个数据包拆成了几个包，本应该是接收一个数据包，却只收到了一个。

所以如果不解决这个，前面提到了按约定字符串传输，就可能解包时报错的情况。

粘包拆包解决方法

首部加数据包长度

<?php
/**

This file is part of game.
Licensed under The MIT License
For full copyright and license information, please see the MIT-LICENSE.txt
Redistributions of files must retain the above copyright notice.
@author beiqiaosu
@link http://www.zerofc.cn
*/
namespace Workerman\Protocols;

use Workerman\Connection\TcpConnection;

/**

Frame Protocol.
*/
class Game
{
/**
- Check the integrity of the package.
- @param string $buffer
- @param TcpConnection $connection
- @return int
  */
  public static function input($buffer, TcpConnection $connection)
  {
  // 数据包前4个字节
  $bodyLen = intval(substr($buffer, 0 , 4));
  $totalLen = strlen($buffer);
  
  if ($totalLen < 4) {
  return 0;
  }
  
  if ($bodyLen <= 0) {
  return 0;
  }
  
  if ($bodyLen > strlen(substr($buffer, 4))) {
  return 0;
  }
  
  return $bodyLen + 4;
  }
/**
- Decode.
- @param string $buffer
- @return string
  */
  public static function decode($buffer)
  {
  return substr($buffer, 4);
  }
/**
- Encode.
- @param string $buffer
- @return string
  */
  public static function encode($buffer)
  {
  // 对数据包长度向左补零
  $bodyLen = strlen($buffer);
  $headerStr = str_pad($bodyLen, 4, 0, STR_PAD_LEFT);
  
  return $headerStr . $buffer;
  }
  }
```
2. 特定字符分割
```php
  <?php
```

namespace Workerman\Protocols;

use Workerman\Connection\ConnectionInterface;

/**

Text Protocol.
*/
class Tank
{
/**
- Check the integrity of the package.
- @param string $buffer
- @param ConnectionInterface $connection
- @return int
  */
  public static function input($buffer, ConnectionInterface $connection)
  {
  
  if (isset($connection->maxPackageSize) && \strlen($buffer) >= $connection->maxPackageSize) {
  $connection->close();
  return 0;
  }
  
  $pos = \strpos($buffer, "#");
  
  if ($pos === false) {
  return 0;
  }
  
  // 返回当前包长
  return $pos + 1;
  }
/**
- Encode.
- @param string $buffer
- @return string
  */
  public static function encode($buffer)
  {
  return $buffer . "#";
  }
/**
- Decode.
- @param string $buffer
- @return string
  */
  public static function decode($buffer)
  {
  return \rtrim($buffer, "#");
  }
  }

粘包拆包测试

这里就只演示特定字符串分割的解决方法，因为上面首页 4 字节加包长的还是存在问题。就是第一次发送不带包长，后面模拟粘包还是拆包都会停留在缓冲区，下面演示可以参照上面代码查看。

服务开启和客户端连接

服务业务端代码

数据包格式说明一下，字符串以逗号分割，数据包以 #分割，逗号分割第一组是业务方法，如 Login 表示登陆传递，Pos 表示坐标传递，后面带的就是对应方法需要的参数了。

<?php

use Workerman\Worker;

require_once __DIR__ . '/vendor/autoload.php';

// #### create socket and listen 1234 port ####
$worker = new Worker('tank://0.0.0.0:1234');

// 4 processes
//$worker->count = 4;

$worker->onWorkerStart = function ($connection) {
    echo "游戏协议服务启动……";
};

// Emitted when new connection come
$worker->onConnect = function ($connection) {
    echo "New Connection\n";
    $connection->send("address: " . $connection->getRemoteIp() . " " . $connection->getRemotePort());
};

// Emitted when data received
$worker->onMessage = function ($connection, $data) use ($worker, $stream) {

    echo "接收的数据：" . $data . "\n";

    // 简单实现接口分发
    $arr = explode(",", $data);

    if (!is_array($arr) || !count($arr)) {
        $connection->close("数据格式错误", true);
    }

    $func = strtoupper($arr[0]);
    $client = $connection->getRemoteAddress();

    switch($func) {
        case "LOGIN":
            $sendData = "Login1";
            break;
        case "POS":
            $positionX = $arr[1] ?? 0;
            $positionY = $arr[2] ?? 0;
            $positionZ = $arr[3] ?? 0;

            $sendData = "POS,$client,$positionX,$positionY,$positionZ";
            break;
    }

    $connection->send($sendData);
};

// Emitted when connection is closed
$worker->onClose = function ($connection) {
    echo "Connection closed\n";
};

// 接收缓冲区溢出回调
$worker->onBufferFull = function ($connection) {
    echo "清理缓冲区吧";
};

Worker::runAll();

?>