# 一些例子
## 例子一
### 協議定義
- 首部固定10個字節長度用來保存整個數據包長度,位數不夠補0
- 數據格式為xml
### 數據包樣本
```php
0000000121<?xml version="1.0" encoding="ISO-8859-1"?>
<request>
<module>user</module>
<action>getInfo</action>
</request>
```
其中0000000121代表整個數據包長度,后面緊跟xml數據格式的包體內容
### 協議實現
```php
namespace Protocols;
class XmlProtocol
{
public static function input($recv_buffer)
{
if(strlen($recv_buffer) < 10)
{
// 不夠10字節,返回0繼續等待數據
return 0;
}
// 返回包長,包長包含 頭部數據長度+包體長度
$total_len = base_convert(substr($recv_buffer, 0, 10), 10, 10);
return $total_len;
}
public static function decode($recv_buffer)
{
// 請求包體
$body = substr($recv_buffer, 10);
return simplexml_load_string($body);
}
public static function encode($xml_string)
{
// 包體+包頭的長度
$total_length = strlen($xml_string)+10;
// 長度部分湊足10字節,位數不夠補0
$total_length_str = str_pad($total_length, 10, '0', STR_PAD_LEFT);
// 返回數據
return $total_length_str . $xml_string;
}
}
```
## 例子二
### 協議定義
- 首部4字節網絡字節序unsigned int,標記整個包的長度
- 數據部分為Json字符串
### 數據包樣本
```
****{"type":"message","content":"hello all"}
```
其中首部四字節\*號代表一個網絡字節序的unsigned int數據,為不可見字符,緊接著是Json的數據格式的包體數據
### 協議實現
```php
namespace Protocols;
class JsonInt
{
public static function input($recv_buffer)
{
// 接收到的數據還不夠4字節,無法得知包的長度,返回0繼續等待數據
if(strlen($recv_buffer)<4)
{
return 0;
}
// 利用unpack函數將首部4字節轉換成數字,首部4字節即為整個數據包長度
$unpack_data = unpack('Ntotal_length', $recv_buffer);
return $unpack_data['total_length'];
}
public static function decode($recv_buffer)
{
// 去掉首部4字節,得到包體Json數據
$body_json_str = substr($recv_buffer, 4);
// json解碼
return json_decode($body_json_str, true);
}
public static function encode($data)
{
// Json編碼得到包體
$body_json_str = json_encode($data);
// 計算整個包的長度,首部4字節+包體字節數
$total_length = 4 + strlen($body_json_str);
// 返回打包的數據
return pack('N',$total_length) . $body_json_str;
}
}
```
## 例子三(使用二進制協議上傳文件)
### 協議定義
```php
struct
{
unsigned int total_len; // 整個包的長度,大端網絡字節序
char name_len; // 文件名的長度
char name[name_len]; // 文件名
char file[total_len - BinaryTransfer::PACKAGE_HEAD_LEN - name_len]; // 文件數據
}
```
### 協議樣本
` *****logo.png****************** `其中首部四字節\*號代表一個網絡字節序的unsigned int數據,為不可見字符,第5個\*是用一個字節存儲文件名長度,緊接著是文件名,接著是原始的二進制文件數據
### 協議實現
```php
namespace Protocols;
class BinaryTransfer
{
// 協議頭長度
const PACKAGE_HEAD_LEN = 5;
public static function input($recv_buffer)
{
// 如果不夠一個協議頭的長度,則繼續等待
if(strlen($recv_buffer) < self::PACKAGE_HEAD_LEN)
{
return 0;
}
// 解包
$package_data = unpack('Ntotal_len/Cname_len', $recv_buffer);
// 返回包長
return $package_data['total_len'];
}
public static function decode($recv_buffer)
{
// 解包
$package_data = unpack('Ntotal_len/Cname_len', $recv_buffer);
// 文件名長度
$name_len = $package_data['name_len'];
// 從數據流中截取出文件名
$file_name = substr($recv_buffer, self::PACKAGE_HEAD_LEN, $name_len);
// 從數據流中截取出文件二進制數據
$file_data = substr($recv_buffer, self::PACKAGE_HEAD_LEN + $name_len);
return array(
'file_name' => $file_name,
'file_data' => $file_data,
);
}
public static function encode($data)
{
// 可以根據自己的需要編碼發送給客戶端的數據,這里只是當做文本原樣返回
return $data;
}
}
```
### 服務端協議使用示例
```php
use Workerman\Worker;
require_once '/your/path/Workerman/Autoloader.php';
$worker = new Worker('BinaryTransfer://0.0.0.0:8333');
// 保存文件到tmp下
$worker->onMessage = function($connection, $data)
{
$save_path = '/tmp/'.$data['file_name'];
file_put_contents($save_path, $data['file_data']);
$connection->send("upload success. save path $save_path");
};
Worker::runAll();
```
### 客戶端文件 client.php (這里用php模擬客戶端上傳)
```php
<?php
/** 上傳文件客戶端 **/
// 上傳地址
$address = "127.0.0.1:8333";
// 檢查上傳文件路徑參數
if(!isset($argv[1]))
{
exit("use php client.php \$file_path\n");
}
// 上傳文件路徑
$file_to_transfer = trim($argv[1]);
// 上傳的文件本地不存在
if(!is_file($file_to_transfer))
{
exit("$file_to_transfer not exist\n");
}
// 建立socket連接
$client = stream_socket_client($address, $errno, $errmsg);
if(!$client)
{
exit("$errmsg\n");
}
// 設置成阻塞
stream_set_blocking($client, 1);
// 文件名
$file_name = basename($file_to_transfer);
// 文件名長度
$name_len = strlen($file_name);
// 文件二進制數據
$file_data = file_get_contents($file_to_transfer);
// 協議頭長度 4字節包長+1字節文件名長度
$PACKAGE_HEAD_LEN = 5;
// 協議包
$package = pack('NC', $PACKAGE_HEAD_LEN + strlen($file_name) + strlen($file_data), $name_len) . $file_name . $file_data;
// 執行上傳
fwrite($client, $package);
// 打印結果
echo fread($client, 8192),"\n";
```
### 客戶端使用示例
命令行中運行 ```php client.php <文件路徑>```
例如 ```php client.php abc.jpg```
## 例子四(使用文本協議上傳文件)
### 協議定義
json+換行,json中包含了文件名以及base64\_encode編碼(會增大1/3的體積)的文件數據
### 協議樣本
{"file\_name":"logo.png","file\_data":"PD9waHAKLyo......"}\\n
注意末尾為一個換行符,在PHP中用雙引號字符```"\\n"```標識
### 協議實現
```php
namespace Protocols;
class TextTransfer
{
public static function input($recv_buffer)
{
$recv_len = strlen($recv_buffer);
if($recv_buffer[$recv_len-1] !== "\n")
{
return 0;
}
return strlen($recv_buffer);
}
public static function decode($recv_buffer)
{
// 解包
$package_data = json_decode(trim($recv_buffer), true);
// 取出文件名
$file_name = $package_data['file_name'];
// 取出base64_encode后的文件數據
$file_data = $package_data['file_data'];
// base64_decode還原回原來的二進制文件數據
$file_data = base64_decode($file_data);
// 返回數據
return array(
'file_name' => $file_name,
'file_data' => $file_data,
);
}
public static function encode($data)
{
// 可以根據自己的需要編碼發送給客戶端的數據,這里只是當做文本原樣返回
return $data;
}
}
```
### 服務端協議使用示例
說明:寫法與二進制上傳寫法一樣,即能做到幾乎不用改動任何業務代碼便可以切換協議
```php
use Workerman\Worker;
require_once '/your/path/Workerman/Autoloader.php';
$worker = new Worker('TextTransfer://0.0.0.0:8333');
// 保存文件到tmp下
$worker->onMessage = function($connection, $data)
{
$save_path = '/tmp/'.$data['file_name'];
file_put_contents($save_path, $data['file_data']);
$connection->send("upload success. save path $save_path");
};
Worker::runAll();
```
### 客戶端文件 textclient.php (這里用php模擬客戶端上傳)
```php
<?php
/** 上傳文件客戶端 **/
// 上傳地址
$address = "127.0.0.1:8333";
// 檢查上傳文件路徑參數
if(!isset($argv[1]))
{
exit("use php client.php \$file_path\n");
}
// 上傳文件路徑
$file_to_transfer = trim($argv[1]);
// 上傳的文件本地不存在
if(!is_file($file_to_transfer))
{
exit("$file_to_transfer not exist\n");
}
// 建立socket連接
$client = stream_socket_client($address, $errno, $errmsg);
if(!$client)
{
exit("$errmsg\n");
}
stream_set_blocking($client, 1);
// 文件名
$file_name = basename($file_to_transfer);
// 文件二進制數據
$file_data = file_get_contents($file_to_transfer);
// base64編碼
$file_data = base64_encode($file_data);
// 數據包
$package_data = array(
'file_name' => $file_name,
'file_data' => $file_data,
);
// 協議包 json+回車
$package = json_encode($package_data)."\n";
// 執行上傳
fwrite($client, $package);
// 打印結果
echo fread($client, 8192),"\n";
```
### 客戶端使用示例
命令行中運行 ```php textclient.php <文件路徑>```
例如 ```php textclient.php abc.jpg```
- 序言
- 原理
- 開發必讀
- 入門指引
- 特性
- 簡單的開發示例
- 安裝
- 環境要求
- 下載安裝
- 啟動停止
- 開發流程
- 開發前必讀
- 目錄結構
- 開發規范
- 基本流程
- 通訊協議
- 通訊協議作用
- 定制通訊協議
- 一些例子
- Worker類
- 構造函數
- 屬性
- id
- count
- name
- protocol
- transport
- reusePort
- connections
- stdoutFile
- pidFile
- logFile
- user
- reloadable
- daemonize
- globalEvent
- 回調屬性
- onWorkerStart
- onWorkerReload
- onConnect
- onMessage
- onClose
- onBufferFull
- onBufferDrain
- onError
- 接口
- runAll
- stopAll
- listen
- TcpConnection類
- 屬性
- id
- protocol
- worker
- maxSendBufferSize
- defaultMaxSendBufferSize
- maxPackageSize
- 回調屬性
- onMessage
- onClose
- onBufferFull
- onBufferDrain
- onError
- 接口
- send
- getRemoteIp
- getRemotePort
- close
- destroy
- pauseRecv
- resumeRecv
- pipe
- AsyncTcpConnection類
- 構造函數
- connect
- reconnect
- transport
- Timer定時器類
- add
- del
- 定時器注意事項
- WebServer
- 調試
- 基本調試
- 查看運行狀態
- 網絡抓包
- 跟蹤系統調用
- 常用組件
- GlobalData數據共享組件
- GlobalDataServer
- GlobalDataClient
- Channel分布式通訊組件
- ChannelServer
- channelClient
- 例子-集群推送
- 例子-分組發送
- FileMonitor文件監控組件
- MySQL組件
- workerman/mysql
- swoole/mysql(異步)
- redis組件
- swoole/redis
- 異步http組件
- swoole/http-client
- 異步消息隊列組件
- react/zmq
- react/stomp
- 異步dns組件
- swoole/dns
- 常見問題
- 心跳
- 客戶端鏈接失敗原因
- 是否支持多線程
- 與其它框架整合
- 運行多個workerman
- 支持哪些協議
- 如何設置進程數
- 查看客戶端連接數
- 對象和資源的持久化
- 例子無法工作
- 啟動失敗
- 停止失敗
- 支持多少并發
- 更改代碼不生效
- 向指定客戶端發送數據
- 如何主動推送消息
- 在其它項目中推送
- 如何實現異步任務
- status里send_fail的原因
- Windows下開發Linux下部署
- 是否支持socket.io
- 終端關閉導致workerman關閉
- 與nginx apache的關系
- 禁用函數檢查
- 平滑重啟原理
- 為Flash開843端口
- 如何廣播數據
- 如何建立udp服務
- 監聽ipv6
- 關閉未認證的鏈接
- 傳輸加密-ssl/tsl
- 創建wss服務
- 創建https服務
- workerman作為客戶端
- 作為ws/wss客戶端
- PHP的幾種回調寫法
- 附錄
- Linux內核調優
- 壓力測試
- 安裝擴展
- websocket協議
- ws協議
- text協議
- frame協議
- 不支持的函數/特性
- 版權信息