设计自己的小传输协议导论与概念

1：聊一聊协议头设计

早在《TCP/IP详解》中的第一句话中，我们就知道协议的含义是这样的：协议是通信双方共同遵守的一套规则，提供格式定义、语义解释等，使不同设备或软件能够正确交换信息。但是，就像我们的写邮件，需要有一定的格式，告知首发地址，收信人和送信人一样，我们的网络协议一样要有协议头，来告诉我们解析收发程序如何正确的收发包。

网络协议常使用分层封装，每一层都在数据上加上专属 header。发送端按层封装，接收端逐层拆解，各层只解析自身字段，互不干扰。

这里，我们简单说说几个设计协议的重要的要点：

1. 简洁高效

头部字段应尽量少，减少带宽与解析开销；例如 IPv4 头部仅最低 20 字节

2. 必要的元数据字段

包含版本号（version）、类型/协议字段（protocol/type）、长度（length）、源/目的标识（address/fileId）、状态或标志（state/flags）等；
可选校验字段如 checksum 或 CRC，提高传输可靠性，但应指明 CRC 多项式、初始值、Byte／bit 顺序等细节。

3. 长度与分包管理

包括 payload 或 name 等可变长度字段长度（如 nameLen、payloadSize）防止粘包／拆包，支持分段重组和安全边界解析

4. 一致的字节序

多平台交互时需明确使用大端（big‑endian）或小端格式，将所有多字节字段统一转换至 network-order。避免跨平台字节解释错误。

5. 完整性校验

校验头部或 header+payload 的完整性。指定 CRC 类型（如 CRC‑32C 等），明确是否 checksum／remainder 等处理规则。

6. 可扩展性与兼容性

设计协议版本机制，当协议升级时，旧版能忽略未知字段或拒绝解析。此外可预留扩展字段或 flags，以支持未来功能扩展。

7. 解析流程明确安全防护

明确状态机控制字段（如 current_state），规范包开始／数据／结束阶段；避免 payload 中数据干扰 header 标识时，引入同步或转义机制避免误识包边界。

我的设计：

笔者在这里，就是用了这样的包来表达自己的设计：

#pragma pack(push, 1)
struct DataHeader {quint32 header_magic;quint16 protocol_version;quint8 current_state;quint64 fileId;quint64 offset;quint64 totalSize;quint32 nameLen;quint32 payloadSize;quint32 header_crc;
};
#pragma pack(pop)

这样的设计比较的紧凑，其实说真的，对我们的CPU字节对齐访问实际上还不太友好，需要一定的Alighment，这样访问是最好的实际上。

static constexpr const unsigned intDATAHEADER_SIZE= sizeof(DataHeader);static constexpr quint32 HEADER_MAGIC = 0x00114514; // Magic Number
static constexpr quint16 HEADER_VERSION = 1; // header version
static constexpr const unsigned int DEF_CHUNK_SZ = 16 * 1024; // default chunkable sizeenum class OperationState : quint8 {Start = 1, ///< At header stageData = 2,End = 3 ///< OK finished
};enum class CurrentState {ReadingHeader,ReadingName,ReadingPayload
};

这里就是进一步的明细我们的状态机设计。OperationState说明了我们当前解析的Steps到达那一步，CurrentState实际上是复杂了一些，因为我们还需要进一步consume具体的header name来做处理，这里算是设计的失误部分（这是笔者从最开始的文件传输脱胎出来的。）

CRC校验

在数据传输或存储过程中，误码是不可避免的。为了检测这些错误，工程上常用 CRC（Cyclic Redundancy Check，循环冗余校验）。这里笔者简单说一下CRC

1. CRC 校验是什么？

CRC 是一种差错检测算法。它的本质是利用一个固定的“生成多项式”，把原始数据看作一个二进制多项式，通过模 2 除法求出“余数”作为校验值。
简单理解：

发送端：计算数据的 CRC 余数，把它附在数据后面一起发出去。
接收端：收到数据后重新算一遍 CRC，如果结果为 0，就认为数据正确，否则说明数据出错。

模 2 除法的特点

加减法用 异或 (XOR) 代替，无进位。
计算过程只涉及移位和异或，速度快且易于硬件实现。

2. CRC 工作流程

发送端：

选择一个生成多项式 $G (x)$ ，例如 10011（对应 x⁴ + x + 1）。
在原始数据末尾补上 n 个 0（n 为 G(x) 的阶数）。
用补零后的数据模 2 除 G(x)，得到余数 R。
把 R 作为校验码附在原始数据末尾发送。

接收端：

收到数据后，用同样的 G(x) 进行模 2 除法。
余数若为 0，说明数据无误；否则数据被破坏。

3. CRC 计算示例

假设：

数据：1101011011
生成多项式：10011

计算步骤：

数据补 4 个 0：1101011011 0000
用 10011 逐位模 2 除，得到余数 1110。
发送数据：1101011011 1110。

接收端用 10011 除 11010110111110，结果余数为 0，数据正确。

4. CRC-32 高效实现（查表法）

CRC-32 是应用最广的 CRC 变种之一（如 PNG、ZIP、以太网等都使用它）。
直接按位计算 CRC 效率不高，常用 查表法：提前计算好 256 个字节对应的 CRC 值，然后逐字节查表加速。

下面是一个典型的 CRC-32 查表法 C++ 实现：

static const unsigned int crc32_table[] = {0x00000000, 0x04c11db7, 0x09823b6e, 0x0d4326d9,0x130476dc, 0x17c56b6b, 0x1a864db2, 0x1e475005,0x2608edb8, 0x22c9f00f, 0x2f8ad6d6, 0x2b4bcb61,0x350c9b64, 0x31cd86d3, 0x3c8ea00a, 0x384fbdbd,0x4c11db70, 0x48d0c6c7, 0x4593e01e, 0x4152fda9,0x5f15adac, 0x5bd4b01b, 0x569796c2, 0x52568b75,0x6a1936c8, 0x6ed82b7f, 0x639b0da6, 0x675a1011,0x791d4014, 0x7ddc5da3, 0x709f7b7a, 0x745e66cd,0x9823b6e0, 0x9ce2ab57, 0x91a18d8e, 0x95609039,0x8b27c03c, 0x8fe6dd8b, 0x82a5fb52, 0x8664e6e5,0xbe2b5b58, 0xbaea46ef, 0xb7a96036, 0xb3687d81,0xad2f2d84, 0xa9ee3033, 0xa4ad16ea, 0xa06c0b5d,0xd4326d90, 0xd0f37027, 0xddb056fe, 0xd9714b49,0xc7361b4c, 0xc3f706fb, 0xceb42022, 0xca753d95,0xf23a8028, 0xf6fb9d9f, 0xfbb8bb46, 0xff79a6f1,0xe13ef6f4, 0xe5ffeb43, 0xe8bccd9a, 0xec7dd02d,0x34867077, 0x30476dc0, 0x3d044b19, 0x39c556ae,0x278206ab, 0x23431b1c, 0x2e003dc5, 0x2ac12072,0x128e9dcf, 0x164f8078, 0x1b0ca6a1, 0x1fcdbb16,0x018aeb13, 0x054bf6a4, 0x0808d07d, 0x0cc9cdca,0x7897ab07, 0x7c56b6b0, 0x71159069, 0x75d48dde,0x6b93dddb, 0x6f52c06c, 0x6211e6b5, 0x66d0fb02,0x5e9f46bf, 0x5a5e5b08, 0x571d7dd1, 0x53dc6066,0x4d9b3063, 0x495a2dd4, 0x44190b0d, 0x40d816ba,0xaca5c697, 0xa864db20, 0xa527fdf9, 0xa1e6e04e,0xbfa1b04b, 0xbb60adfc, 0xb6238b25, 0xb2e29692,0x8aad2b2f, 0x8e6c3698, 0x832f1041, 0x87ee0df6,0x99a95df3, 0x9d684044, 0x902b669d, 0x94ea7b2a,0xe0b41de7, 0xe4750050, 0xe9362689, 0xedf73b3e,0xf3b06b3b, 0xf771768c, 0xfa325055, 0xfef34de2,0xc6bcf05f, 0xc27dede8, 0xcf3ecb31, 0xcbffd686,0xd5b88683, 0xd1799b34, 0xdc3abded, 0xd8fba05a,0x690ce0ee, 0x6dcdfd59, 0x608edb80, 0x644fc637,0x7a089632, 0x7ec98b85, 0x738aad5c, 0x774bb0eb,0x4f040d56, 0x4bc510e1, 0x46863638, 0x42472b8f,0x5c007b8a, 0x58c1663d, 0x558240e4, 0x51435d53,0x251d3b9e, 0x21dc2629, 0x2c9f00f0, 0x285e1d47,0x36194d42, 0x32d850f5, 0x3f9b762c, 0x3b5a6b9b,0x0315d626, 0x07d4cb91, 0x0a97ed48, 0x0e56f0ff,0x1011a0fa, 0x14d0bd4d, 0x19939b94, 0x1d528623,0xf12f560e, 0xf5ee4bb9, 0xf8ad6d60, 0xfc6c70d7,0xe22b20d2, 0xe6ea3d65, 0xeba91bbc, 0xef68060b,0xd727bbb6, 0xd3e6a601, 0xdea580d8, 0xda649d6f,0xc423cd6a, 0xc0e2d0dd, 0xcda1f604, 0xc960ebb3,0xbd3e8d7e, 0xb9ff90c9, 0xb4bcb610, 0xb07daba7,0xae3afba2, 0xaafbe615, 0xa7b8c0cc, 0xa379dd7b,0x9b3660c6, 0x9ff77d71, 0x92b45ba8, 0x9675461f,0x8832161a, 0x8cf30bad, 0x81b02d74, 0x857130c3,0x5d8a9099, 0x594b8d2e, 0x5408abf7, 0x50c9b640,0x4e8ee645, 0x4a4ffbf2, 0x470cdd2b, 0x43cdc09c,0x7b827d21, 0x7f436096, 0x7200464f, 0x76c15bf8,0x68860bfd, 0x6c47164a, 0x61043093, 0x65c52d24,0x119b4be9, 0x155a565e, 0x18197087, 0x1cd86d30,0x029f3d35, 0x065e2082, 0x0b1d065b, 0x0fdc1bec,0x3793a651, 0x3352bbe6, 0x3e119d3f, 0x3ad08088,0x2497d08d, 0x2056cd3a, 0x2d15ebe3, 0x29d4f654,0xc5a92679, 0xc1683bce, 0xcc2b1d17, 0xc8ea00a0,0xd6ad50a5, 0xd26c4d12, 0xdf2f6bcb, 0xdbee767c,0xe3a1cbc1, 0xe760d676, 0xea23f0af, 0xeee2ed18,0xf0a5bd1d, 0xf464a0aa, 0xf9278673, 0xfde69bc4,0x89b8fd09, 0x8d79e0be, 0x803ac667, 0x84fbdbd0,0x9abc8bd5, 0x9e7d9662, 0x933eb0bb, 0x97ffad0c,0xafb010b1, 0xab710d06, 0xa6322bdf, 0xa2f33668,0xbcb4666d, 0xb8757bda, 0xb5365d03, 0xb1f740b4
};quint32 header_crc(const QByteArray& data) {quint32 crc = 0xFFFFFFFFu;const uchar* buf = reinterpret_cast<const uchar*>(data.constData());int len = data.size();for (int i = 0; i < len; ++i) {quint8 index = (crc ^ buf[i]) & 0xFFU;crc = (crc >> 8) ^ crc32_table[index];}return crc ^ 0xFFFFFFFFu;
}

5. 校验示例

CRC-32 的标准测试字符串是 123456789，计算结果应为：

0xCBF43926

你可以直接测试：

qDebug() << QString::number(header_crc("123456789"), 16);  // 输出 cbf43926

基于QDataStream的拆装包

一、QDataStream 简介：写入与读取原始二进制数据

QDataStream 可用于序列化（写入）和反序列化（读取）基础类型（如 quint32, quint64, quint8 等）以及 Qt 数据类型，且支持跨平台字节序一致性处理
写 raw bytes 时可使用 writeRawData()，读时用 readRawData()
使用 setByteOrder() 可以控制（默认网络大端或小端），确保跨平台通信一致性

二、封包（Pack）：将协议头打入 `QByteArray`

1. 使用 `<<` 运算符逐字段写入

QByteArray buf;
QDataStream out(&buf, QIODevice::WriteOnly);
out.setVersion(QDataStream::Qt_6_0);        // 保证版本一致
out.setByteOrder(QDataStream::BigEndian);   // 指定字节序out << quint32(header.header_magic)<< quint16(header.protocol_version)<< quint8(header.current_state)<< quint64(header.fileId)<< quint64(header.offset)<< quint64(header.totalSize)<< quint32(header.nameLen)<< quint32(header.payloadSize);
// header_crc 最后写，值之前自计算
out << quint32(header.header_crc);

优点是类型自动序列化，并支持 Qt 类型一致性处理。确保 setVersion() 和 setByteOrder() 在写与读端匹配

2. 使用 `writeRawData()` 整块写入（只建议在已处理对齐和 byte order 的情况下）

QByteArray buf(sizeof(DataHeader), Qt::Uninitialized);
memcpy(buf.data(), &header, sizeof(header));
// 然后 writeRawData(buf.data(), buf.size())

注意：此方式依赖结构体内存布局，可能受编译器对齐、endianness 影响，不推荐用于跨平台协议实现

三、拆包（Unpack）：使用 `QDataStream` 从 `QByteArray` 或 `QIODevice` 读取

1. 逐字段读取

QDataStream in(&buf, QIODevice::ReadOnly);
in.setVersion(QDataStream::Qt_6_0);
in.setByteOrder(QDataStream::BigEndian);quint32 magic;
in >> magic;
if (magic != HEADER_MAGIC) { /* 错误处理 */ }quint16 version;
in >> version;
// 检查版本兼容性quint8 state;
in >> state;in >> fileId >> offset >> totalSize>> nameLen >> payloadSize;quint32 headerCRC;
in >> headerCRC;

可结合 CRC 校验机制对 header 或 header+payload 范围进行校验。

2. 使用事务机制，避免半包读取失败

若数据分片接收，可使用 startTransaction() / commitTransaction() / abortTransaction() 来确保完整读取，否则回退状态等候后续数据(doc.qt.io)。

四、完整示例：pack 和 unpack 实现伪代码

QByteArray packUpHeader(const DataHeader& h) {QByteArray buf;QDataStream out(&buf, QIODevice::WriteOnly);out.setVersion(QDataStream::Qt_6_0);out.setByteOrder(QDataStream::BigEndian);out << quint32(HEADER_MAGIC)<< quint16(HEADER_VERSION)<< quint8(h.current_state)<< quint64(h.fileId)<< quint64(h.offset)<< quint64(h.totalSize)<< quint32(h.nameLen)<< quint32(h.payloadSize);quint32 crc = calculateCRC(buf); // 计算前面部分 CRCout << quint32(crc);return buf;
}bool readOutHeader(QDataStream& in, DataHeader& h) {in.setVersion(QDataStream::Qt_6_0);in.setByteOrder(QDataStream::BigEndian);in.startTransaction();in >> h.header_magic >> h.protocol_version >> h.current_state>> h.fileId >> h.offset >> h.totalSize>> h.nameLen >> h.payloadSize >> h.header_crc;if (!in.commitTransaction())return false;if (h.header_magic != HEADER_MAGIC) return false;// 可读出 CRC 后并校验return true;
}

五、关键注意点汇总

项目	说明
`setVersion()`	保证写读端的 QDataStream 版本一致
`setByteOrder()`	明确字节序，跨平台通信稳定
类型匹配	使用 Qt 类型（quint32 等）确保大小一致性
原始写入问题	`writeRawData()` 可能绕过 byte order 和版本处理
错误处理	使用事务避免半包读取导致数据错乱
CRC 校验	header CRC 建议覆盖 header 前半部分或 header+payload