超级好用的C++实用库之字节流解析器

概述

字节流解析器是一种软件组件，它负责将接收到的原始二进制数据（字节流）转换为有意义的信息结构或格式。在计算机网络、文件处理和数据通信中，字节流是最基本的数据传输形式，但这些原始字节对于应用程序通常是没有直接意义的，需要通过特定的解析规则来解读。

在以下几种场景中，字节流解析器起着关键作用。

网络通信：服务端接收到客户端发送过来的HTTP请求或响应时，其中包含了按照HTTP协议编码的字节流，解析器会将这些字节解码成请求头、请求体等可操作的对象。

文件格式解析：如图像、音频、视频文件，或者像Java Class文件这样的编译后的字节码文件，都需要经过相应的字节流解析器进行解码，还原出文件内部的结构和内容。

数据协议解析：TCP/IP协议栈中的各种应用层协议，如MQTT、TCP分包重组、自定义二进制协议等，都会用到字节流解析器来识别消息边界和字段值。

序列化与反序列化：在跨进程通信或持久化数据时，使用了诸如JSON、XML、Protocol Buffers等序列化协议，解析器可以将字节流转回成对象模型。

CHP_ByteStreamParser类

为了使用面向对象的方式向上层提供简单、易用、统一的接口，我们需要封装自己的字节流解析器。字节流解析器一般用于网络通信时，解析获取自定义数据，支持获取整型数据、浮点型数据、字符串、buffer和对齐等。CHP_ByteStreamParser类的头文件，可参考下面的示例代码。

#pragma once

#include "HP_Types.h"

class CHP_ByteStreamParser
{
public:
    CHP_ByteStreamParser();
    ~CHP_ByteStreamParser();

    enum IHPByteOrderType
    { 
        HPByteOrderType_Default, 
        HPByteOrderType_ForceHost, 
        HPByteOrderType_ForceNetwork 
    };

    bool Init(const char *pStream, int nStreamLen, bool bNetworkByteOrder = false);

    const char *GetStream();

    int GetStreamLen();

    int GetCurPos();

    bool GetChar(char &cData);

    bool GetChar(unsigned char &ucData);

    bool GetShort(short &sData, IHPByteOrderType type = HPByteOrderType_Default);

    bool GetShort(unsigned short &usData, IHPByteOrderType type = HPByteOrderType_Default);

    bool GetInt(int &nData, IHPByteOrderType type = HPByteOrderType_Default);

    bool GetInt(unsigned int &uiData, IHPByteOrderType type = HPByteOrderType_Default);

    bool GetInt64(HP_U64 &ui64Data, IHPByteOrderType type = HPByteOrderType_Default);

    bool GetFloat(float &fData);

    bool GetDouble(double &dbData);

    bool GetStr(char *pszData, int nDataLen);

    bool GetBuf(char *pData, int nDataLen);

    bool GetPad(int nPad);

    bool Skip(int nLen);

    void Reset();

private:
    bool CheckParse(int nLen);
        
private:
    const char *m_pStream;
    int m_nStreamLen;
    int m_nCurPos;
    bool m_bNetworkByteOrder;
};

在上面的示例代码中，我们声明了一个枚举类型IHPByteOrderType。获取多字节数据时，可以指定字节序类型为以下三种。

HPByteOrderType_Default：默认字节序，以Init函数中传入的字节序为准。

HPByteOrderType_ForceHost：强制本地字节序。

HPByteOrderType_ForceNetwork：强制网络字节序。

下面，我们逐个介绍CHP_ByteStreamParser类导出的公共接口。

Init：初始化函数。参数pStream为要解析的流的指针，参数nStreamLen要解析的流的长度，参数bNetworkByteOrder表示解析数据时，是否使用网络字节序。返回值为true表示成功，否则失败。

GetStream：获取流的指针。返回值为流的指针。

GetStreamLen：获取流的长度。返回值为流的长度。

GetCurPos：获取流中解析数据的当前位置。返回值为流中解析数据的当前位置。

GetChar：获取字符型数据。参数cData或ucData为有符号字符型数据或无符号字符型数据，参数type为字节序类型，返回值为true表示成功，否则失败。

GetShort：获取短整型数据。参数sData或usData为有符号短整型数据或无符号短整型数据，参数type为字节序类型，返回值为true表示成功，否则失败。

GetInt：获取整型数据。参数nData或uiData为有符号整型数据或无符号整型数据，参数type为字节序类型，返回值为true表示成功，否则失败。

GetInt64：获取无符号64位整型数据。参数ui64Data为无符号64位整型数据，参数type为字节序类型，返回值为true表示成功，否则失败。

GetFloat：获取单精度浮点型数据。参数fData为单精度浮点型数据，返回值为true表示成功，否则失败。

GetDouble：获取双精度浮点型数据。参数dbData为双精度浮点型数据，返回值为true表示成功，否则失败。

GetStr：获取字符串型数据。参数pszData为字符串型数据buffer，参数nDataLen为字符串型数据buffer的最大长度，返回值为true表示成功，否则失败。

GetBuf：获取buffer数据。参数pData为buffer数据，参数nDataLen为buffer数据长度，返回值为true表示成功，否则失败。

GetPad：获取对齐。假如当前位置为11，若nPad为4，则会获取1个字节的对齐；若nPad为8，则会获取5个字节的对齐。参数nPad为对齐字节数，返回值为true表示成功，否则失败。

Skip：跳过指定长度的数据。参数nLen为要跳过数据的长度，返回值为true表示成功，否则失败。

Reset：重置流，重置后，当前位置为零，可以重新开始解析流。

总结

字节流解析器是一种用于解析字节流的工具或程序。字节流是由连续的字节组成的数据流，解析器会读取这些字节，并根据特定的规则或格式将它们转换成更有用的数据结构或信息。

字节流解析器的设计和实现，取决于要解析的数据的类型和格式。通常情况下，解析器可以用于读取和解码二进制文件、网络数据包、图像文件、音频文件、视频文件等。