pack、unpack自制二进制“数据库”

引言

pack、unpack函数，如果没有接触过socket，这个可能会比较陌生，这两个函数在socket交互的作用是组包，将数据装进一个二进制字符串，和对二进制字符串中的数据进行解包，这个里面有好多种格式，具体的格式可以去查查官方的手册（或者等看完本篇文章之后，去调用接口查看），我这里主要用了pack(“N”,int),pack(“a”,str)以及他们两个对应的解包函数，N在手册中的解释是下面这个，占4个字节，大端方式（其实就是低位在前还是在后的问题）。a是对字符串进行打包，不够指定的数值的时候用NULL（\0，或者说assic码0对应的字符）填充。

N - unsigned long (always 32 bit, big endian byte order)

a - NUL-padded string

我将用这个打包解包函数做一个函数手册查询小工具，或者可以说是一个自制小型二进制数据库。

设计数据格式

在做这个二进制文件数据库的时候我会创建两个文件，一个是索引文件，一个是要查询的数据的文件，分别看看他们的结构：

说明中括号内的数字为所占字节(bytes)数，"~"波浪线表示所占字节数不确定

数据文件，第一个php是一个正式的字符串"php"，占4个字节，后面跟着版本说明，长度不确定（这个长度可以从后面的index文件中获取），接下来后面是存储信息的主体了。首先是一个函数名长度lenName占4个字节，接下来是函数名称，长度不确定，有前面的lenName对应的值确定，接下来是lenVal占4个字节，后面跟的是具体的函数说明内容，长度有前面的lenVal对应的值确定。

          内容存储格式定义
++++++++++++++++++++++++++++++++++++++
|php()        |版本说明(~)           |
++++++++++++++++++++++++++++++++++++++
|lenName()    |函数名称(~)           |
++++++++++++++++++++++++++++++++++++++
|lenVal()     |函数内容(~)           |
++++++++++++++++++++++++++++++++++++++
            ......

索引文件，索引文件就比较简单了，其中全部存储了上面的存储文件中每个函数开始的指针位置，每个位置占用4个字节。

索引格式定义
++++++++++++++++++++++++++++++++++++++
|position()                         |
++++++++++++++++++++++++++++++++++++++
            ......

查询的实现

由于存储文件中的内容是按照函数名顺序排序存储的，索引也是按照函数存储的顺序存储的，所以获取起来很方便，直接使用二分法就可以很轻松的获取到想要的函数

在查询的时候主要使用了下面几个方法：

第一、从制定位置获取一条索引的值（也就是对应的函数存储文件的指针位置）

/**
 * 从索引文件中获取一条记录的位置
 * @param 索引文件中的开始位置，从开始位置获取四个字节为一个函数说明的开始位置
 * @return 返回该索引位置所对应的存储位置指针偏移量
 */
private function _getOneIndex($pos)
{
    fseek($this->_indexHandle, $pos);
    $len = unpack("Nlen", fread($this->_indexHandle, 4));
    return $len['len'];
}

第二、从指定的指针偏移位置获取一条len(4)+val(~)格式的内容

/**
 * 从制定的指针偏移量获取一个len+val型的内容
 * @param $pos 文件的指针偏移量
 * @return 返回数组，包括长度和值
 */
private function _getStoreLenValFormat($pos){
    fseek($this->_storeHandle, $pos);
    $len = unpack("Nlen", fread($this->_storeHandle, 4));
    $len = $len['len'];
    $val = fread($this->_storeHandle, $len);
    return array
    (
        'len' => $len,
        'value' => $val,
    );
}

第三、获取制定函数的说明，这个也是最主要的一部分，使用二分法从数据文件中获取一条记录

/**
 * 获取函数内容
 * @param 要查找的函数名称
 * @return 返回函数说明的json字符串
 */
public function get($func)
{
    if(!$this->isInit())
        return;
    $begin = 0;
    $end = filesize($this->_indexFile)/4;
    $ret = '[]';
    while($begin < $end){
        $mid = floor(($begin + $end)/2);
        $pos = $mid*4; //$mid只是指针变量的位置，还需要乘上指针的长度4
        $pos = $this->_getOneIndex($pos);
        $name = $this->_getStoreLenValFormat($pos);
        $flag = strcmp($func, $name['value']);
        if($flag == 0){
            $val = $this->_getStoreLenValFormat($pos+4+$name['len']);
            $ret = $val['value'];
            break;
        }elseif($flag < 0){
            $end = $end == $mid ? $mid-1 : $mid;
        }else{
            $begin = $begin == $mid ? $mid+1 : $mid;
        }
    }
    return $ret;
}

使用很简单，只需包含类库文件和存储文件数据库，然后调用几句代码就可以

<?php
include_once("./manual/phpManual.php");

$t = new phpManual();
$t->init('zh');
echo $t->get("unpack");

输出的是json字符串，转化后如下所示，其中有详细的说明，以及简洁的例子

{
    "name": "unpack",
    "desc": "Unpack data from binary string.",
    "long_desc": "Unpacks from a binary string into an array according to the given `format`.\\n\\nThe unpacked data is stored in an associative array. To accomplish this you have to name the different format codes and separate them by a slash /. If a repeater argument is present, then each of the array keys will have a sequence number behind the given name.",
    "ver": "PHP 4, PHP 5",
    "ret_desc": "Returns an associative array containing unpacked elements of binary string.",
    "seealso": [
        "pack"
    ],
    "url": "function.unpack",
    "class": null,
    "params": [
        {
            "list": [
                {
                    "type": "string",
                    "var": "$format",
                    "beh": 0,
                    "desc": "See pack() for an explanation of the format codes."
                },
                {
                    "type": "string",
                    "var": "$data",
                    "beh": 0,
                    "desc": "The packed data."
                }
            ],
            "ret_type": "array"
        }
    ],
    "examples": [
        {
            "title": "unpack() example",
            "source": "$binarydata = \"\\x04\\x00\\xa0\\x00\";\n$array = unpack(\"cchars/nint\", $binarydata);",
            "output": null
        },
        {
            "title": "unpack() example with a repeater",
            "source": "$binarydata = \"\\x04\\x00\\xa0\\x00\";\n$array = unpack(\"c2chars/nint\", $binarydata);",
            "output": null
        },
        {
            "title": "unpack() example with unnamed keys",
            "source": "$binarydata = \"\\x32\\x42\\x00\\xa0\";\n$array = unpack(\"c2/n\", $binarydata);\nvar_dump($array);",
            "output": null
        }
    ]
}

最后再附上目录结构：

+phpManual
    +manual
        +phpManual
            +zh
                |_manualIndex
                |_manualStore
        |_phpManual.php
    |_test.php

这个是程序的完整地址：

完整例子地址

参考

https://github.com/aizuyan/php-doc-parser 从这里拿到的phpmanual的全部数据

　　

本文版权归作者iforever(luluyrt@163.com)所有，未经作者本人同意禁止任何形式的转载，转载文章之后必须在文章页面明显位置给出作者和原文连接，否则保留追究法律责任的权利。