最近有个任务需要php程序向一个Socket Server传输数据,server端提供的有效信息为:传输协议、监听方式:TCP ip:port 和 unix:sock 两种方式
接下来的工作方向很清晰
- 写一个php socket client。 常用的函数包括:socket_create、socket_connect、socket_set_option、socket_set_nonblock、socket_write、socket_read
- 按照Socket Server 所采用的通讯协议,对待传输的数据(json字符串)进行编码
第一个步骤,照着PHP官方文档就能写粗来,略过
接下来重点介绍第二个步骤
字节序
当前服务端的通讯协议 (参考地址:https://github.com/henrylee2cn/teleport/tree/v5/socket )
默认协议RawProto—— 大端序(Big Endian) :
实现以上协议,必须了解计算机字节码的存储顺序,即字节序,指的是多字节的数据在内存中的存放顺序。
多字节对象都被存储为连续的字节序列。例如:如果C/C++中的一个int型变量 a 的起始地址是&a = 0x100,那么 a 的四个字节将被存储在存储器的0x100, 0x101, 0x102, 0x103位置。根据整数 a 在连续的 4 byte 内存中的存储顺序,字节序被分为大端序(Big Endian) 与 小端序(Little Endian)两类。 然后就牵涉出两大CPU派系:
Motorola 6800,PowerPC 970,SPARC(除V9外)等处理器采用 Big Endian方式存储数据;
x86系列,VAX,PDP-11等处理器采用Little Endian方式存储数据。
另外,还有一些处理器像ARM, DEC Alpha的字节序是可配置的。
基于以上的原因,所以我们在进行多传输多字节表示的数据时(比如int32、int64),必须明确大端序还是小端序,以避免接受数据时避免不同的CPU架构导致的乱序问题。
注:字节内部顺序不变,只是字节间的顺序和倒序之分
以小端序为例,值0x12345678 在内存中实际上存储的形式如下:
简记:大端序就是人们阅读的顺序存放数据的; 小端序与之相反; 共同点是字节内部顺序不变
编码
编码和解码用到的库函数为pack()、unpack();
1. 遍历要传输的json字符串,对字符串切割转成字节数组
2. 对每个字节进行打包 pack('c', $byte) 转为ascii码,并按其在字节数组中的顺序重新拼接一个字符串,参考地址:https://segmentfault.com/a/1190000008305573
由于本例中服务端除了协议中长度的定义以外其他均逐个按序接受字节码,所以,c有符号字符、C无符号字符任意一种编码格式均可
原理说了那么多,能不能来点直观的?
字节处理类
<?php
/**
* 字符串与字节互转服务
*/
class Byte
{
//字节按指定格式编码后的字符串
private $byte='';
//字节码数组
private $byteArr = [];
private static $instance = null;
private function __construct()
{
}
public static function getInstance()
{
if(! self::$instance instanceof self){
self::$instance = new self();
}
return self::$instance;
}
public function reset()
{
$this->byteArr = [];
$this->byte = '';
return $this;
}
public function getByteString(){
return $this->byte;
}
public function getByteArr(){
return $this->byteArr;
}
/**
* 追加单个字节
* @param $byte
*/
public function writeByte($byte){
$this->byteArr[] = $byte;
}
/**
* 追加一个字节数组
* @param array $byteArr
*/
public function write($byteArr=array())
{
$this->byteArr = array_merge($this->byteArr, $byteArr);
}
/**
* 16位无符号数字转大端序
* @param int $uint16
* @return array
*/
public function bigEndianInt16($uint16=0)
{
$arr = [];
$arr[0] = ($uint16 >> 8) & 0xff;
$arr[1] = $uint16 & 0xff;
return $arr;
}
/**
* 32位无符号数字转大端序
* @param int $uint32
* @return array
*/
public function bigEndianInt32($uint32=0)
{
$arr = [];
$arr[0] = ($uint32 >> 24) & 0xff;
$arr[1] = ($uint32 >> 16) & 0xff;
$arr[2] = ($uint32 >> 8) & 0xff;
$arr[3] = $uint32 & 0xff;
return $arr;
}
/**
* 前四个字节存储整个字节数组的长度, 字节数组总长度不变
* @return $this|bool
*/
public function putBigEndianInt32()
{
$uint32 = count($this->byteArr);
if($uint32 < 3){
return false;
}
$this->byteArr[0] = ($uint32 >> 24) & 0xff;
$this->byteArr[1] = ($uint32 >> 16) & 0xff;
$this->byteArr[2] = ($uint32 >> 8) & 0xff;
$this->byteArr[3] = $uint32 & 0xff;
return $this;
}
function stringToByteArray($str)
{
$bytes = array_map('ord',str_split($str));
return $bytes;
}
function byteArrayToString($bytes)
{
$bytes = array_map('chr',$bytes);
$str = implode('',$bytes);
return $str;
}
function toByteString()
{
foreach($this->byteArr as $byte){
$this->byte .= pack('c', $byte);
}
return $this->byte;
}
function getLength()
{
return count($this->byteArr);
}
}
协议处理类:
<?php
/**
* 通信协议
*
* -----------------------------------------
* 可以和golang的kafkaProxy 进行数据传输
* -----------------------------------------
*
* socket服务端为:https://github.com/henrylee2cn/teleport/tree/v5/socket
* 协议类型:默认
*/
class SocketMsg
{
//要发送的字符串
private $message = '';
private $strLen = 0; //数据打包后的长度
private static $instance = null;
private function __construct()
{
}
public static function getInstance()
{
if(! self::$instance instanceof self){
self::$instance = new self();
}
return self::$instance;
}
public function setMsg($msg="")
{
$this->message = $msg;
}
/**
* 解码
* @param $byteStr
* @return string
*/
function upack($byteStr)
{
$bytes = unpack('c*', $byteStr);
$byte = Byte::getInstance();
return $byte->byteArrayToString(array_slice($bytes, 14));
}
/**
* 数据打包
*/
function pack(){
$byte = Byte::getInstance()->reset();
//传输字节数
$byte->write($byte->bigEndianInt32(0));
//编码方式
$byte->write($byte->stringToByteArray('r'));
$byte->writeByte(0);
//消息头
$byte->write($byte->bigEndianInt16(0));
$byte->writeByte(0);
$byte->write($byte->bigEndianInt16(0));
$byte->write($byte->bigEndianInt16(0));
//消息体
$byte->writeByte(0);
$byte->write($byte->stringToByteArray($this->message));
$byte->putBigEndianInt32();
$this->strLen = $byte->getLength();
return $byte->toByteString();
}
public function getLength()
{
return $this->strLen;
}
}
由于我的业务需求只需要把数据发送出去,所以并没有实现接收数据的部分,有兴趣的同学可以尝试下练练手
总结:通讯协议重点就是:哪些是标志位字节,标志的内容一共有多少个字节; 以及把多个这样的(标记+内容)组合起来