Некоторые примеры
Пример один
Определение протокола
- Заголовок фиксированной длины 10 байт используется для сохранения общей длины пакета, недостаточные биты заполняются нулями
- Формат данных — xml
Пример пакета данных
0000000121<?xml version="1.0" encoding="ISO-8859-1"?>
<request>
<module>user</module>
<action>getInfo</action>
</request>Где 0000000121 представляет собой общую длину пакета, за которым следует содержимое пакета в формате xml.
Реализация протокола
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 байт, недостаточные биты заполняются нулями
$total_length_str = str_pad($total_length, 10, '0', STR_PAD_LEFT);
// Возвращает данные
return $total_length_str . $xml_string;
}
}Пример два
Определение протокола
- Заголовок 4 байта в сетевом порядке байтов, обозначающий длину всего пакета
- Данные в виде строки Json
Пример пакета данных
****{"type":"message","content":"hello all"}
Где первые четыре байта * представляют собой данные типа unsigned int в сетевом порядке байтов, это невидимые символы, и за ними следует содержимое пакета в формате Json.
Реализация протокола
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;
}
}Пример три (использование бинарного протокола для загрузки файла)
Определение протокола
struct
{
unsigned int total_len; // Общая длина пакета, великий порядок байтов сети
char name_len; // Длина имени файла
char name[name_len]; // Имя файла
char file[total_len - BinaryTransfer::PACKAGE_HEAD_LEN - name_len]; // Бинарные данные файла
}Пример протокола
*****logo.png******************
Где первые 4 байта представляют собой данные типа unsigned int в сетевом порядке байтов, это невидимые символы, пятый - это один байт, который хранит длину имени файла, за которым следует имя файла, затем идут оригинальные бинарные данные файла.
Реализация протокола
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;
}
}Пример использования протокола на сервере
use Workerman\Worker;
use Workerman\Connection\TcpConnection;
require_once __DIR__ . '/vendor/autoload.php';
$worker = new Worker('BinaryTransfer://0.0.0.0:8333');
// Сохранение файла в tmp
$worker->onMessage = function(TcpConnection $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
/** Клиент для загрузки файлов **/
// Адрес загрузки
$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");
}
// Установка сокет-соединения
$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".
Реализация протокола
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;
}
}
Пример использования протокола на сервере
Примечание: запись схожа с записью для бинарной загрузки, т.е. вы можете переключить протокол почти без изменений в любом бизнес-коде.
use Workerman\Worker;
use Workerman\Connection\TcpConnection;
require_once __DIR__ . '/vendor/autoload.php';
$worker = new Worker('TextTransfer://0.0.0.0:8333');
// Сохранение файла в tmp
$worker->onMessage = function(TcpConnection $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
/** Клиент для загрузки файлов **/
// Адрес загрузки
$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");
}
// Установка сокет-соединения
$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