Home Backend Development PHP Tutorial pack, unpack homemade binary 'database'

pack, unpack homemade binary 'database'

Aug 08, 2016 am 09:30 AM
array this

引言

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对应的值确定。

<span>          内容存储格式定义
</span>++++++++++++++++++++++++++++++++++++++
|php(<span>4</span>)        |版本说明(~)           |
++++++++++++++++++++++++++++++++++++++
|lenName(<span>4</span>)    |函数名称(~)           |
++++++++++++++++++++++++++++++++++++++
|lenVal(<span>4</span>)     |函数内容(~)           |
++++++++++++++++++++++++++++++++++++++<span>
            ......</span>
Copy after login

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

<span>索引格式定义
</span>++++++++++++++++++++++++++++++++++++++
|position(<span>4</span>)                         |
++++++++++++++++++++++++++++++++++++++<span>
            ......</span>
Copy after login

查询的实现

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

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

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

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

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

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

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

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

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

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

</span><span>$t</span> = <span>new</span><span> phpManual();
</span><span>$t</span>->init('zh'<span>);
</span><span>echo</span> <span>$t</span>->get("unpack");
Copy after login

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

<span>{
    </span>"name": "unpack"<span>,
    </span>"desc": "Unpack data from binary string."<span>,
    </span>"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."<span>,
    </span>"ver": "PHP 4, PHP 5"<span>,
    </span>"ret_desc": "Returns an associative array containing unpacked elements of binary string."<span>,
    </span>"seealso"<span>: [
        </span>"pack"<span>
    ],
    </span>"url": "function.unpack"<span>,
    </span>"class": <span>null</span><span>,
    </span>"params"<span>: [
        {
            </span>"list"<span>: [
                {
                    </span>"type": "string"<span>,
                    </span>"var": "$format"<span>,
                    </span>"beh": 0<span>,
                    </span>"desc": "See pack() for an explanation of the format codes."<span>
                },
                {
                    </span>"type": "string"<span>,
                    </span>"var": "$data"<span>,
                    </span>"beh": 0<span>,
                    </span>"desc": "The packed data."<span>
                }
            ],
            </span>"ret_type": "array"<span>
        }
    ],
    </span>"examples"<span>: [
        {
            </span>"title": "unpack() example"<span>,
            </span>"source": "$binarydata = \"\\x04\\x00\\xa0\\x00\";\n$array = unpack(\"cchars/nint\", $binarydata);"<span>,
            </span>"output": <span>null</span><span>
        },
        {
            </span>"title": "unpack() example with a repeater"<span>,
            </span>"source": "$binarydata = \"\\x04\\x00\\xa0\\x00\";\n$array = unpack(\"c2chars/nint\", $binarydata);"<span>,
            </span>"output": <span>null</span><span>
        },
        {
            </span>"title": "unpack() example with unnamed keys"<span>,
            </span>"source": "$binarydata = \"\\x32\\x42\\x00\\xa0\";\n$array = unpack(\"c2/n\", $binarydata);\nvar_dump($array);"<span>,
            </span>"output": <span>null</span><span>
        }
    ]
}</span>
Copy after login

最后再附上目录结构:

+<span>phpManual
    </span>+<span>manual
        </span>+<span>phpManual
            </span>+<span>zh
                </span>|<span>_manualIndex
                </span>|<span>_manualStore
        </span>|<span>_phpManual.php
    </span>|_test.php
Copy after login

这个是程序的完整地址:

完整例子地址

参考

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

  

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

以上就介绍了pack、unpack自制二进制“数据库”,包括了方面的内容,希望对PHP教程有兴趣的朋友有所帮助。

Statement of this Website
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

AI Hentai Generator

AI Hentai Generator

Generate AI Hentai for free.

Hot Article

Repo: How To Revive Teammates
1 months ago By 尊渡假赌尊渡假赌尊渡假赌
R.E.P.O. Energy Crystals Explained and What They Do (Yellow Crystal)
2 weeks ago By 尊渡假赌尊渡假赌尊渡假赌
Hello Kitty Island Adventure: How To Get Giant Seeds
1 months ago By 尊渡假赌尊渡假赌尊渡假赌

Hot Tools

Notepad++7.3.1

Notepad++7.3.1

Easy-to-use and free code editor

SublimeText3 Chinese version

SublimeText3 Chinese version

Chinese version, very easy to use

Zend Studio 13.0.1

Zend Studio 13.0.1

Powerful PHP integrated development environment

Dreamweaver CS6

Dreamweaver CS6

Visual web development tools

SublimeText3 Mac version

SublimeText3 Mac version

God-level code editing software (SublimeText3)

Sort array using Array.Sort function in C# Sort array using Array.Sort function in C# Nov 18, 2023 am 10:37 AM

Title: Example of using the Array.Sort function to sort an array in C# Text: In C#, array is a commonly used data structure, and it is often necessary to sort the array. C# provides the Array class, which has the Sort method to conveniently sort arrays. This article will demonstrate how to use the Array.Sort function in C# to sort an array and provide specific code examples. First, we need to understand the basic usage of the Array.Sort function. Array.So

Simple and clear method to use PHP array_merge_recursive() function Simple and clear method to use PHP array_merge_recursive() function Jun 27, 2023 pm 01:48 PM

When programming in PHP, we often need to merge arrays. PHP provides the array_merge() function to complete array merging, but when the same key exists in the array, this function will overwrite the original value. In order to solve this problem, PHP also provides an array_merge_recursive() function in the language, which can merge arrays and retain the values ​​of the same keys, making the program design more flexible. array_merge

How to use the array_combine function in PHP to combine two arrays into an associative array How to use the array_combine function in PHP to combine two arrays into an associative array Jun 26, 2023 pm 01:41 PM

In PHP, there are many powerful array functions that can make array operations more convenient and faster. When we need to combine two arrays into an associative array, we can use PHP's array_combine function to achieve this operation. This function is actually used to combine the keys of one array as the values ​​of another array into a new associative array. Next, we will explain how to use the array_combine function in PHP to combine two arrays into an associative array. Learn about array_comb

Detailed explanation of PHP array_fill() function usage Detailed explanation of PHP array_fill() function usage Jun 27, 2023 am 08:42 AM

In PHP programming, array is a very important data structure that can handle large amounts of data easily. PHP provides many array-related functions, array_fill() is one of them. This article will introduce in detail the usage of the array_fill() function, as well as some tips in practical applications. 1. Overview of the array_fill() function The function of the array_fill() function is to create an array of a specified length and composed of the same values. Specifically, the syntax of this function is

An article that understands this point and catches up with 70% of front-end people An article that understands this point and catches up with 70% of front-end people Sep 06, 2022 pm 05:03 PM

A colleague got stuck due to a bug pointed by this. Vue2’s this pointing problem caused an arrow function to be used, resulting in the inability to get the corresponding props. He didn't know it when I introduced it to him, and then I deliberately looked at the front-end communication group. So far, at least 70% of front-end programmers still don't understand it. Today I will share with you this link. If everything is wrong If you haven’t learned it yet, please give me a big mouth.

How to use the Array module in Python How to use the Array module in Python May 01, 2023 am 09:13 AM

The array module in Python is a predefined array, so it takes up much less space in memory than a standard list, and can also perform fast element-level operations such as adding, deleting, indexing, and slicing. In addition, all elements in the array are of the same type, so you can use the efficient numerical operation functions provided by the array, such as calculating the average, maximum, and minimum values. In addition, the array module also supports writing and reading array objects directly into binary files, which makes it more efficient when processing large amounts of numerical data. Therefore, if you need to process a large amount of homogeneous data, you may consider using Python's array module to optimize the execution efficiency of your code. To use the array module, you first need to

What are the common causes of ArrayStoreException in Java? What are the common causes of ArrayStoreException in Java? Jun 25, 2023 am 09:48 AM

In Java programming, array is an important data structure. Arrays can store multiple values ​​in a single variable, and more importantly each value can be accessed using an index. But while working with arrays, some exceptions may occur, one of them is ArrayStoreException. This article will discuss common causes of ArrayStoreException exceptions. 1. Type mismatch The element type must be specified when the array is created. When we try to store incompatible data types into an array, it throws

What are the common causes of ArrayIndexOutOfBoundsException in Java? What are the common causes of ArrayIndexOutOfBoundsException in Java? Jun 24, 2023 pm 10:39 PM

Java is a very powerful programming language that is widely used in various development fields. However, during Java programming, developers often encounter ArrayIndexOutOfBoundsException exceptions. So, what are the common causes of this anomaly? ArrayIndexOutOfBoundsException is a common runtime exception in Java. It means that when accessing data, the array subscript exceeds the range of the array. Common reasons include

See all articles