php读取二进制流（C语言结构体struct数据文件）

来源：http://bianbian.org/technology/295.html

尽管php是用C语言开发的，不过令我不解的是php没有提供对结构体struct的直接支持。
不过php提供了pack和unpack函数，用来进行二进制数据（binary data）和php内部数据的互转：

1. string pack ( string $format [, mixed $args [, mixed $...]] ) 
2. //Pack given arguments into binary string according to format.
3.  
4. array unpack ( string $format, string $data ) 
5. //Unpacks from a binary string into an array according to the given format

其中，$format跟perl里的pack格式类似，有如下一些（中文是我加的，有不准确的欢迎提出）：
a NUL-padded string，即“/0”作为“空字符”的表示形式
A SPACE-padded string，空格作为“空字符”的表示形式
h Hex string, low nibble first，升序位顺序
H Hex string, high nibble first，降序位顺序
c signed char，有符号单字节
C unsigned char，无符号单字节
s signed short (always 16 bit, machine byte order)
S unsigned short (always 16 bit, machine byte order)
n unsigned short (always 16 bit, big endian byte order)
v unsigned short (always 16 bit, little endian byte order)
i signed integer (machine dependent size and byte order)
I unsigned integer (machine dependent size and byte order)
l signed long (always 32 bit, machine byte order)
L unsigned long (always 32 bit, machine byte order)
N unsigned long (always 32 bit, big endian byte order)
V unsigned long (always 32 bit, little endian byte order)
f float (machine dependent size and representation)
d double (machine dependent size and representation)
x NUL byte，实际使用的时候作为跳过多少字节用，很有用
X Back up one byte，后退1字节
@ NUL-fill to absolute position，实际使用的时候作为从开头跳到某字节用，很有用

实际使用发现：C里的“/0”（即字符串终止符）在php里并不是终止符，而是作为了字符串的一部分。因此，必须对“/0”进行特殊处理，才能进行struct和php内部数据的完美互转。比如 char name[10]; 如果实际数据是“62 69 61 6E 00 62 69 61 6E 00”，在C语言里第5个位置有终止符，name应该是“bian”；而用了unpack转换以后在php里的name却是“bian/0bian/0”。
一开始我用了strpos函数找到“/0”的位置，然后进行substr截取：

1. $name = substr($name, 0, strpos($name, "/0"));

不过很Faint的事情发生了，不知道是strpos的bug还是substr的bug（其实测试一下就知道，懒得试），有些字符串没问题，有些字符串却只能得到空值（即$name == ”）。很是郁闷，后来找了个strtok函数，这下没有问题了：

1. $name = strtok($name, "/0");

难为大家看了那么多，下面写个完整的php读取二进制数据流（C语言结构体struct数据）文件的示例代码：
首先是C的struct定义示例，为了演示，我就写个简单点的，实际对照上面那个$format格式表应该没有问题：

1. struct BIANBIAN {
2.     char name[10];
3.     char pass[33];
4.     int  age;
5.     unsigned char flag;
6. };

比如有个“bianbian.org”文件，内容就是上面的N个BIANBIAN结构体构成的。读取的php代码：
//下面根据struct确定$format，注意int类型跟机器环境有关，我的32位Linux是4个长度

1. $format = 'a10name/a33pass/iage/Cflag';
2. //确定一个struct占用多少长度字节，如果只是读取单个结构体这是不需要的
3. $length = 10 + 33 + 4 + 1;
4. //也可以用fopen + fread + fclose，不过file_get_contents因为可以mmap，效率更高
5. $data = file_get_contents('bianbian.org', 'r');
6. for ($i = 0, $c = strlen($data); $i < $c; $i += $length) { 
7.     $bianbian = unpack("@$i/$format", $data);
8.     //reference传递是php 5才支持的，如果用php4，得用其他办法
9.     foreach ($bianbian as &$value) { 
10.         if (is_string($value)) { 
11.             $value = strtok($value, "/0");
12.         } 
13.     } 
14.     print_r($bianbian);
15. } 
16. //输出为array，即类似：
17. Array 
18. ( 
19.     [name] => 'bianbian' 
20.     [pass] => 'bianbian.org' 
21.     [age]  => 100 
22.     [flag] => 0 
23. ) 
24. ...

pack应该跟unpack相反。

===================================================

实际使用发现：C里的“/0”（即字符串终止符）在php里并不是终止符，而是作为了字符串的一部分。因此，必须对“/0”进行特殊处理，才能进行 struct和php内部数据的完美互转。比如 char name[10]; 如果实际数据是“62 69 61 6E 00 62 69 61 6E 00”，在C语言里第5个位置有终止符，name应该是“bian”；而用了unpack转换以后在php里的name却是“bian/0bian /0”。
一开始我用了strpos函数找到“/0”的位置，然后进行substr截取.
不过很Faint的事情发生了，不知道是strpos的bug还是substr的bug（其实测试一下就知道，懒得试），有些字符串没问题，有些字符串却只能得到空值（即$name == ”）。很是郁闷，后来找了个strtok函数，这下没有问题了.
难为大家看了那么多，下面写个完整的php读取二进制数据流（C语言结构体struct数据）文件的示例代码：
首先是C的struct定义示例，为了演示，我就写个简单点的，实际对照上面那个$format格式表应该没有问题：

struct TEST{
    char name[10];
    char pass[33];
    int  age;
    unsigned char flag;
};

 比如有个“file.dat”文件，内容就是上面的N个BIANBIAN结构体构成的。读取的php代码：

1. <?php   
2.  //下面根据struct确定$format，注意int类型跟机器环境有关，我的32位Linux是4个长度   
3.  $format = 'a10name/a33pass/iage/Cflag';   
4.  //确定一个struct占用多少长度字节，如果只是读取单个结构体这是不需要的   
5.  $length = 10 + 33 + 4 + 1;   
6.  //也可以用fopen + fread + fclose，不过file_get_contents因为可以mmap，效率更高   
7.  $data = file_get_contents('file.dat', 'r');   
8.  for ($i = 0, $c = strlen($data); $i < $c; $i += $length) {   
9.      $bianbian = unpack("$format", $data);   
10.      //reference传递是php 5才支持的，如果用php4，得用其他办法   
11.      foreach ($bianbian as &$value) {   
12.          if (is_string($value)) {   
13.              $value = strtok($value, "/0");   
14.          }   
15.      }   
16.      print_r($bianbian);   
17.  }   
18. ?> 

pack应该跟unpack相反。

顺便附上生成结构体文件的C语言代码：

1. #include <stdio.h>   
2. #include <string.h>   
3.     
4. struct example        
5. {       
6.     char name[10];   
7.     char pass[33];   
8.     int  age;   
9.     unsigned char flag;   
10. };   
11.     
12. int main()      
13. {   
14.     example test;   
15.     example read;      
16.     FILE *fp;   
17.     
18.     test.age = 111;      
19.     test.flag = 10;   
20.     strcpy(test.name, "Hello World!");   
21.     strcpy(test.pass, "zbl110119");   
22.     
23.     fp = fopen("file.dat", "w+");   
24.     if (!fp)   
25.     {   
26.         printf("open file error!");   
27.         return -1;   
28.     }   
29.     
30.     rewind(fp);   
31.     fwrite(&test, sizeof(example), 1, fp);   
32.     
33.     rewind(fp);   
34.     fread(&read, sizeof(example), 1, fp);   
35.     
36.     printf("%d, %s/n", read.age, read.name);   
37.     
38.     fclose(fp);   
39.     return 0;   
40. } 
    转自：http://bianbian.org