如何定制协议

实际上制定自己的协议是比较简单的事情。简单的协议一般包含两部分:

  • 区分数据边界的标识
  • 数据格式定义

一个例子

协议定义

这里假设区分数据边界的标识为换行符”\n”（注意请求数据本身内部不能包含换行符），数据格式为Json，例如下面是一个符合这个规则的请求包。

  1. {"type":"message","content":"hello"}
  2.  

注意上面的请求数据末尾有一个换行字符(在PHP中用双引号字符串”\n”表示)，代表一个请求的结束。

实现步骤

在WorkerMan中如果要实现上面的协议，假设协议的名字叫JsonNL，所在项目为MyApp，则需要以下步骤

1、协议文件放到项目的Protocols文件夹，例如文件MyApp/Protocols/JsonNL.php

2、实现JsonNL类，以namespace Protocols;为命名空间，必须实现三个静态方法分别为 input、encode、decode

具体实现

MyApp/Protocols/JsonNL.php的实现

  1. namespace Protocols;
  2. class JsonNL
  3. {
  4.     /**
  5.      * 检查包的完整性
  6.      * 如果能够得到包长，则返回包的在buffer中的长度，否则返回0继续等待数据
  7.      * 如果协议有问题，则可以返回false，当前客户端连接会因此断开
  8.      * @param string $buffer
  9.      * @return int
  10.      */
  11.     public static function input($buffer)
  12.     {
  13.         // 获得换行字符"\n"位置
  14.         $pos = strpos($buffer, "\n");
  15.         // 没有换行符，无法得知包长，返回0继续等待数据
  16.         if($pos === false)
  17.         {
  18.             return 0;
  19.         }
  20.         // 有换行符，返回当前包长（包含换行符）
  21.         return $pos+1;
  22.     }
  24.     /**
  25.      * 打包，当向客户端发送数据的时候会自动调用
  26.      * @param string $buffer
  27.      * @return string
  28.      */
  29.     public static function encode($buffer)
  30.     {
  31.         // json序列化，并加上换行符作为请求结束的标记
  32.         return json_encode($buffer)."\n";
  33.     }
  35.     /**
  36.      * 解包，当接收到的数据字节数等于input返回的值（大于0的值）自动调用
  37.      * 并传递给onMessage回调函数的$data参数
  38.      * @param string $buffer
  39.      * @return string
  40.      */
  41.     public static function decode($buffer)
  42.     {
  43.         // 去掉换行，还原成数组
  44.         return json_decode(trim($buffer), true);
  45.     }
  46. }

至此，JsonNL协议实现完毕，可以在MyApp项目中使用，使用方法例如下面

文件：MyApp\start.php

  1. use Workerman\Worker;
  2. require_once '/your/path/Workerman/Autoloader.php'
  3. $json_worker = new Worker('JsonNL://0.0.0.0:1234');
  4. $json_worker->onMessage = ...
  5. ...

协议接口说明

在WorkerMan中开发的协议类必须实现三个静态方法，input、encode、decode，协议接口说明见Workerman/Protocols/ProtocolInterface.php，定义如下：

  1. namespace Workerman\Protocols;
  3. use \Workerman\Connection\ConnectionInterface;
  5. /**
  6.  * Protocol interface
  7. * @author walkor <walkor@workerman.net>
  8.  */
  9. interface ProtocolInterface
  10. {
  11.     /**
  12.      * 用于在接收到的recv_buffer中分包
  13.      *
  14.      * 如果可以在$recv_buffer中得到请求包的长度则返回整个包的长度
  15.      * 否则返回0，表示需要更多的数据才能得到当前请求包的长度
  16.      * 如果返回false或者负数，则代表错误的请求，则连接会断开
  17.      *
  18.      * @param ConnectionInterface $connection
  19.      * @param string $recv_buffer
  20.      * @return int|false
  21.      */
  22.     public static function input($recv_buffer, ConnectionInterface $connection);
  24.     /**
  25.      * 用于请求解包
  26.      *
  27.      * input返回值大于0，并且WorkerMan收到了足够的数据，则自动调用decode
  28.      * 然后触发onMessage回调，并将decode解码后的数据传递给onMessage回调的第二个参数
  29.      * 也就是说当收到完整的客户端请求时，会自动调用decode解码，无需业务代码中手动调用
  30.      * @param ConnectionInterface $connection
  31.      * @param string $recv_buffer
  32.      */
  33.     public static function decode($recv_buffer, ConnectionInterface $connection);
  35.     /**
  36.      * 用于请求打包
  37.      *
  38.      * 当需要向客户端发送数据即调用$connection->send($data);时
  39.      * 会自动把$data用encode打包一次，变成符合协议的数据格式，然后再发送给客户端
  40.      * 也就是说发送给客户端的数据会自动encode打包，无需业务代码中手动调用
  41.      * @param ConnectionInterface $connection
  42.      * @param mixed $data
  43.      */
  44.     public static function encode($data, ConnectionInterface $connection);
  45. }

注意：

Workerman中没有严格要求协议类必须基于ProtocolInterface实现，实际上协议类只要类包含了input、encode、decode三个静态方法即可。