Alcuni Esempi

Esempio Uno

Definizione del Protocollo

  • L'intestazione ha una lunghezza fissa di 10 byte per memorizzare la lunghezza dell'intero pacchetto di dati, riempiendo di 0 se non sufficiente
  • Il formato dei dati è xml

Campione di Pacchetto Dati

0000000121<?xml version="1.0" encoding="ISO-8859-1"?>
<request>
    <module>user</module>
    <action>getInfo</action>
</request>

Dove 0000000121 rappresenta la lunghezza dell'intero pacchetto, subito seguita dal contenuto del corpo del pacchetto nel formato di dati xml.

Implementazione del Protocollo

namespace Protocols;
class XmlProtocol
{
    public static function input($recv_buffer)
    {
        if(strlen($recv_buffer) < 10)
        {
            // Non ci sono abbastanza byte, restituire 0 e continuare ad attendere dati
            return 0;
        }
        // Restituisce la lunghezza del pacchetto, la lunghezza include la lunghezza dei dati dell'intestazione + la lunghezza del corpo del pacchetto
        $total_len = base_convert(substr($recv_buffer, 0, 10), 10, 10);
        return $total_len;
    }

    public static function decode($recv_buffer)
    {
        // Corpo della richiesta
        $body = substr($recv_buffer, 10);
        return simplexml_load_string($body);
    }

    public static function encode($xml_string)
    {
        // Lunghezza del corpo + lunghezza dell'intestazione
        $total_length = strlen($xml_string)+10;
        // Parte della lunghezza per riempire 10 byte, riempiamo di 0 se non sufficiente
        $total_length_str = str_pad($total_length, 10, '0', STR_PAD_LEFT);
        // Restituisce i dati
        return $total_length_str . $xml_string;
    }
}

Esempio Due

Definizione del Protocollo

  • L'intestazione è un unsigned int in ordine di byte di rete di 4 byte, che contrassegna la lunghezza dell'intero pacchetto
  • La parte dati è una stringa Json

Campione di Pacchetto Dati

****{"type":"message","content":"hello all"}

Dove i primi quattro byte * rappresentano un valore unsigned int in ordine di byte di rete, è un carattere invisibile, seguito dai dati del corpo nel formato di dati Json.

Implementazione del Protocollo

namespace Protocols;
class JsonInt
{
    public static function input($recv_buffer)
    {
        // I dati ricevuti non sono sufficienti a 4 byte, non possiamo conoscere la lunghezza del pacchetto, restituire 0 e continuare ad attendere dati
        if(strlen($recv_buffer)<4)
        {
            return 0;
        }
        // Utilizzare la funzione unpack per convertire i primi 4 byte dell'intestazione in un numero, i primi 4 byte dell'intestazione sono la lunghezza dell'intero pacchetto di dati
        $unpack_data = unpack('Ntotal_length', $recv_buffer);
        return $unpack_data['total_length'];
    }

    public static function decode($recv_buffer)
    {
        // Rimuovere i primi 4 byte dell'intestazione, ottenere i dati Json del corpo
        $body_json_str = substr($recv_buffer, 4);
        // decodifica json
        return json_decode($body_json_str, true);
    }

    public static function encode($data)
    {
        // Codifica Json per ottenere il corpo
        $body_json_str = json_encode($data);
        // Calcolare la lunghezza dell'intero pacchetto, 4 byte dell'intestazione + dimensione del corpo del pacchetto
        $total_length = 4 + strlen($body_json_str);
        // Restituisce i dati impacchettati
        return pack('N',$total_length) . $body_json_str;
    }
}

Esempio Tre (caricare un file utilizzando un protocollo binario)

Definizione del Protocollo

struct
{
  unsigned int total_len;  // La lunghezza dell'intero pacchetto, in big-endian
  char         name_len;   // La lunghezza del nome del file
  char         name[name_len]; // Nome del file
  char         file[total_len - BinaryTransfer::PACKAGE_HEAD_LEN - name_len]; // Dati del file
}

Campione di Protocollo

 *****logo.png****************** 

Dove i primi 4 byte rappresentano un valore unsigned int in ordine di byte di rete, è un carattere invisibile, il quinto è un byte che memorizza la lunghezza del nome del file, seguito dal nome del file e poi dai dati del file binario originali.

Implementazione del Protocollo

namespace Protocols;
class BinaryTransfer
{
    // lunghezza dell'intestazione del protocollo
    const PACKAGE_HEAD_LEN = 5;

    public static function input($recv_buffer)
    {
        // Se non ci sono abbastanza byte per la lunghezza dell'intestazione del protocollo, attendere
        if(strlen($recv_buffer) < self::PACKAGE_HEAD_LEN)
        {
            return 0;
        }
        // Disimballare
        $package_data = unpack('Ntotal_len/Cname_len', $recv_buffer);
        // Restituisce la lunghezza del pacchetto
        return $package_data['total_len'];
    }

    public static function decode($recv_buffer)
    {
        // Disimballare
        $package_data = unpack('Ntotal_len/Cname_len', $recv_buffer);
        // lunghezza del nome del file
        $name_len = $package_data['name_len'];
        // Estrarre il nome del file dal flusso di dati
        $file_name = substr($recv_buffer, self::PACKAGE_HEAD_LEN, $name_len);
        // Estrarre i dati binari del file dal flusso di dati
        $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)
    {
        // Puoi codificare i dati da inviare al client come desideri, qui restituiamo semplicemente il testo originale
        return $data;
    }
}

Esempio di Utilizzo del Protocollo sul Server

use Workerman\Worker;
use Workerman\Connection\TcpConnection;
require_once __DIR__ . '/vendor/autoload.php';

$worker = new Worker('BinaryTransfer://0.0.0.0:8333');
// Salva il file nella cartella 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();

File Client: client.php (simulazione del client per il caricamento)

<?php
/** Client per il caricamento dei file **/
// Indirizzo per il caricamento
$address = "127.0.0.1:8333";
// Controlla il parametro del percorso del file da caricare
if(!isset($argv[1]))
{
   exit("use php client.php \$file_path\n");
}
// Percorso del file da caricare
$file_to_transfer = trim($argv[1]);
// Il file da caricare non esiste localmente
if(!is_file($file_to_transfer))
{
    exit("$file_to_transfer not exist\n");
}
// Stabilire una connessione socket
$client = stream_socket_client($address, $errno, $errmsg);
if(!$client)
{
    exit("$errmsg\n");
}
// Imposta come bloccante
stream_set_blocking($client, 1);
// Nome del file
$file_name = basename($file_to_transfer);
// Lunghezza del nome del file
$name_len = strlen($file_name);
// Dati binari del file
$file_data = file_get_contents($file_to_transfer);
// Lunghezza dell'intestazione del protocollo 4 byte lunghezza del pacchetto + 1 byte lunghezza del nome del file
$PACKAGE_HEAD_LEN = 5;
// Pacchetto del protocollo
$package = pack('NC', $PACKAGE_HEAD_LEN  + strlen($file_name) + strlen($file_data), $name_len) . $file_name . $file_data;
// Esegui il caricamento
fwrite($client, $package);
// Stampa il risultato
echo fread($client, 8192),"\n";

Esempio di Utilizzo del Client

Esegui nel terminale php client.php <percorso del file>

Ad esempio php client.php abc.jpg

Esempio Quattro (utilizzare un protocollo di testo per caricare file)

Definizione del Protocollo

json + newline, il json contiene il nome del file e i dati del file codificati in base64_encode (che aumenteranno di 1/3 il volume).

Campione di Protocollo

{"file_name":"logo.png","file_data":"PD9waHAKLyo......"}\n

Nota: termina con un carattere di newline, che in PHP è indicato con il carattere di doppio apice "\n".

Implementazione del Protocollo

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)
    {
        // Disimballare
        $package_data = json_decode(trim($recv_buffer), true);
        // Estrarre il nome del file
        $file_name = $package_data['file_name'];
        // Estrarre i dati del file codificati in base64
        $file_data = $package_data['file_data'];
        // Decodifica base64 per ripristinare i dati binari originali del file
        $file_data = base64_decode($file_data);
        // Restituisci i dati
        return array(
             'file_name' => $file_name,
             'file_data' => $file_data,
         );
    }

    public static function encode($data)
    {
        // Puoi codificare i dati da inviare al client come desideri, qui restituiamo semplicemente il testo originale
        return $data;
    }
}

Esempio di Utilizzo del Protocollo sul Server

Nota: la scrittura è simile a quella del caricamento binario, il che consente di passare da un protocollo all'altro quasi senza modificare alcun codice di business.

use Workerman\Worker;
use Workerman\Connection\TcpConnection;
require_once __DIR__ . '/vendor/autoload.php';

$worker = new Worker('TextTransfer://0.0.0.0:8333');
// Salva il file nella cartella 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();

File Client: textclient.php (simulazione del client per il caricamento)

<?php
/** Client per il caricamento dei file **/
// Indirizzo per il caricamento
$address = "127.0.0.1:8333";
// Controlla il parametro del percorso del file da caricare
if(!isset($argv[1]))
{
   exit("use php client.php \$file_path\n");
}
// Percorso del file da caricare
$file_to_transfer = trim($argv[1]);
// Il file da caricare non esiste localmente
if(!is_file($file_to_transfer))
{
    exit("$file_to_transfer not exist\n");
}
// Stabilire una connessione socket
$client = stream_socket_client($address, $errno, $errmsg);
if(!$client)
{
    exit("$errmsg\n");
}
stream_set_blocking($client, 1);
// Nome del file
$file_name = basename($file_to_transfer);
// Dati binari del file
$file_data = file_get_contents($file_to_transfer);
// Codifica in base64
$file_data = base64_encode($file_data);
// Pacchetto dati
$package_data = array(
    'file_name' => $file_name,
    'file_data' => $file_data,
);
// Pacchetto del protocollo json + newline
$package = json_encode($package_data)."\n";
// Esegui il caricamento
fwrite($client, $package);
// Stampa il risultato
echo fread($client, 8192),"\n";

Esempio di Utilizzo del Client

Esegui nel terminale php textclient.php <percorso del file>

Ad esempio php textclient.php abc.jpg