بعض الأمثلة

المثال الأول

تعريف البروتوكول

• رأس ثابت طوله 10 بايت لحفظ طول الحزمة بأكملها، وفي حالة عدم كفاية الأرقام يتم تعويضها بـ 0
• صيغة البيانات هي 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 بايت، وفي حالة عدم كفاية الأرقام يتم تعويضها بـ 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.

تنفيذ البروتوكول

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 بايت في الرأس رأس بسبب المعلومات التصريحية للشبكة، ويمثل الحرف الخامس طول اسم الملف، يتبعه اسم الملف ثم البيانات الثنائية الأصلية للملف.

تنفيذ البروتوكول

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);
// بيانات الملف الثنائية
$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 لاستعادة بيانات الملف الثنائية الأصلية
        $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