php unpack

unpack 是 PHP 中一个非常有用的函数，主要用于将二进制数据解包为 PHP 的变量。这个函数在处理二进制数据、网络协议、文件格式等方面非常有用。本文将详细介绍 unpack 函数的使用方法、参数、返回值以及一些实际应用场景。

1. unpack 函数的基本语法

unpack 函数的基本语法如下：

array unpack ( string $format , string $data [, int $offset = 0 ] )

• $format：指定解包格式的字符串。这个字符串由格式代码组成，每个格式代码对应一个解包的数据类型。
• $data：需要解包的二进制数据。
• $offset：可选参数，指定从数据的哪个位置开始解包，默认值为 0。

2. 格式代码

unpack 函数的 $format 参数由一系列格式代码组成，每个格式代码对应一个数据类型。以下是一些常用的格式代码：

• a：以 NUL 填充的字符串
• A：以空格填充的字符串
• h：十六进制字符串，低位在前
• H：十六进制字符串，高位在前
• c：有符号字符
• C：无符号字符
• s：有符号短整型（16位，机器字节序）
• S：无符号短整型（16位，机器字节序）
• n：无符号短整型（16位，大端字节序）
• v：无符号短整型（16位，小端字节序）
• i：有符号整型（机器字节序和大小）
• I：无符号整型（机器字节序和大小）
• l：有符号长整型（32位，机器字节序）
• L：无符号长整型（32位，机器字节序）
• N：无符号长整型（32位，大端字节序）
• V：无符号长整型（32位，小端字节序）
• q：有符号长长整型（64位，机器字节序）
• Q：无符号长长整型（64位，机器字节序）
• J：无符号长长整型（64位，大端字节序）
• P：无符号长长整型（64位，小端字节序）
• f：浮点数（机器相关大小和表示）
• d：双精度浮点数（机器相关大小和表示）
• x：空字节
• X：回退一个字节
• @：*定位

3. 返回值

unpack 函数返回一个关联数组，数组的键是格式代码指定的名称，值是对应的解包数据。如果格式代码没有指定名称，则使用默认的 1, 2, 3, ... 作为键。

4. 使用示例

4.1 解包简单的二进制数据

假设我们有一个二进制字符串，包含一个无符号短整型和一个无符号长整型：

$data = "\x01\x00\x00\x00\x02\x00\x00\x00";
$result = unpack('vshort/Nlong', $data);
print_r($result);

输出：

Array
(
    [short] => 1
    [long] => 2
)

在这个例子中，v 格式代码解包了一个无符号短整型，N 格式代码解包了一个无符号长整型。

4.2 解包复杂的二进制数据

假设我们有一个二进制字符串，包含一个字符串、一个无符号短整型和一个浮点数：

$data = "Hello\x00\x00\x00\x01\x00\x40\x48\x00\x00";
$result = unpack('a5str/vshort/ffloat', $data);
print_r($result);

输出：

Array
(
    [str] => Hello
    [short] => 1
    [float] => 3.125
)

在这个例子中，a5 格式代码解包了一个 5 字节的字符串，v 格式代码解包了一个无符号短整型，f 格式代码解包了一个浮点数。

4.3 使用偏移量

unpack 函数的第三个参数 $offset 可以指定从数据的哪个位置开始解包。例如：

$data = "\x01\x00\x00\x00\x02\x00\x00\x00";
$result = unpack('vshort/Nlong', $data, 4);
print_r($result);

输出：

Array
(
    [short] => 2
    [long] => 0
)

在这个例子中，我们从第 4 个字节开始解包，因此 v 格式代码解包的是 \x02\x00，而 N 格式代码解包的是 \x00\x00\x00\x00。

5. 实际应用场景

5.1 处理网络协议

在网络编程中，数据通常以二进制格式传输。unpack 函数可以用于解析这些二进制数据。例如，解析一个 TCP 数据包：

$packet = "\x45\x00\x00\x28\x00\x00\x40\x00\x40\x06\x00\x00\xc0\xa8\x01\x01\xc0\xa8\x01\x02";
$result = unpack('Cversion/Cheader_length/nlength/nid/nflags_offset/Cttl/Cprotocol/nchecksum/Nsrc_ip/Ndst_ip', $packet);
print_r($result);

输出：

Array
(
    [version] => 69
    [header_length] => 0
    [length] => 40
    [id] => 0
    [flags_offset] => 16384
    [ttl] => 64
    [protocol] => 6
    [checksum] => 0
    [src_ip] => 3232235777
    [dst_ip] => 3232235778
)

在这个例子中，我们解析了一个 TCP 数据包的头部信息。

5.2 处理文件格式

unpack 函数也可以用于解析二进制文件格式。例如，解析一个 BMP 文件头：

$file = fopen('example.bmp', 'rb');
$header = fread($file, 14);
$result = unpack('vtype/Vsize/vreserved1/vreserved2/Voffset', $header);
print_r($result);
fclose($file);

输出：

Array
(
    [type] => 19778
    [size] => 123456
    [reserved1] => 0
    [reserved2] => 0
    [offset] => 54
)

在这个例子中，我们解析了一个 BMP 文件头的部分信息。

6. 注意事项

• unpack 函数在处理二进制数据时，需要确保格式代码与数据的实际类型匹配，否则可能导致解包错误。
• unpack 函数返回的数组中的值类型取决于格式代码，例如 C 格式代码返回的是无符号字符，N 格式代码返回的是无符号长整型。
• unpack 函数在处理大端字节序和小端字节序时，需要注意格式代码的选择，例如 n 和 v 分别用于大端和小端的无符号短整型。

7. 总结

unpack 函数是 PHP 中处理二进制数据的重要工具，通过合理的格式代码选择，可以轻松地将二进制数据解包为 PHP 的变量。在网络编程、文件处理等领域，unpack 函数有着广泛的应用。掌握 unpack 函数的使用方法，可以帮助我们更高效地处理二进制数据。