浅谈通信协议设计

目录

1.设计原则

2.注意事项

2.1.大小端编码问题

2.2.字节对齐

2.3.显式指定整型字段的长度

2.4.涉及到浮点数要考虑精度问题，建议放大成整数或者使用字符串去传输

2.5.协议与自动升级功能

1.设计原则

设计通信协议时，需要考虑以下几个原则：

1) 简单性：协议设计应尽可能简单，简单的协议更易于实现和维护，减少出错的可能性。复杂的协议往往会导致理解和实现的困难，增加维护成本。

2) 可扩展性：

• 预留扩展空间：在设计协议时，应考虑到未来的扩展需求，通过预留字段或功能接口，使得在不改变协议基本结构的前提下能够增加新的功能或修改现有功能。
• 分层设计：将通信协议划分为多个层次，每个层次只负责特定的功能，有助于实现功能的独立性和可扩展性。

3) 互操作性：确保不同系统和硬件间的通信，协议应设计为能够在不同的系统和硬件之间进行通信，以实现广泛的互操作性。这有助于不同设备或系统之间的无缝集成。

4) 效率：减少通信开销，协议应尽可能减少通信过程中的带宽使用、处理时间和电力消耗。这可以通过优化协议格式、减少冗余数据等方式实现。

5) 可靠性：提供错误检测和恢复机制，协议应具备错误检测和恢复机制，以确保数据的正确传输。这包括校验码、重传机制等，以应对通信过程中的错误和丢包问题。

6) 安全性：提供适当的安全机制，协议应提供加密、身份验证等安全机制，以防止未经授权的访问和数据篡改。这有助于保护通信过程中的数据安全性和隐私性。

7) 兼容性考虑:  向后兼容性，在设计新版本的协议时，应考虑到与旧版本的兼容性，以确保旧设备或系统能够继续与新设备进行通信。

2.注意事项

2.1.大小端编码问题

        不同的平台存在大小端的问题（即主机字节序和网络字节序），在设计协议格式时，如果协议中存在整型字段，建议使用同一个字节序。通常的做法是在进行网络传输时将所有的整型转换为网络字节序（大端编码，Big Endian），避免不同的机器因为大小端问题解析得到不同的整型值。

        当然，不一定非要转换为网络字节序，如果明确的知道通信的双方使用的是相同的字节序，则也可以不转换。

2.2.字节对齐

以C++为例，通信协议一般用结构体struct来表达，如：

#pragma pack(push, 1)//传输的整个报文
typedef  struct  _stShortWavePacket
{quint32        version; //版本号quint16        frameIndex;quint16        srcObjMark; //源对象标识quint16        srcObjNO; //源对象编号quint16        destObjMark; //目的对象标识quint16        destObjNO; //目的对象编号quint8         isMustResponse; //是否需要应答quint8		   responseStatus; //0：返回成功；非0：失败qint8          content[1024]; //协议内容
}stShortWavePacket;#pragma pack()

        有一组成对的 #pragma XX 指令，其中 #pragma pack(push, n)，是告诉编译器接下来的所有结构体（这里就是 userinfo 协议）的每一个字段按 n 个字节对齐，这里 n = 1，按一个字节对齐，即去除任何 padding 字节。这样做的目的是为了内存更加紧凑，节省存储空间。

        我们不再需要这个对齐功能后，应该使用 #pragma pack(pop) 让编译器恢复之前的对齐方式。

注意：#pragma pack(push, n) 与 #pragma pack(pop) 一定要成对使用，如果你漏掉其中任何一个，编译出来的代码可能会出现很多奇怪的运行结果。

2.3.显式指定整型字段的长度

        对于一个 int 型字段，在作为协议传输时，我们应该显式地指定该类型的长度，也就是说，你应该使用 int32_t、int64_t 这样的类型来代替 int、long。之所以这么做，是因为在不同字长的机器上，对于默认的 int 和 long 的长度可能不一样，例如 long 型，在 32 位操作系统上其长度是 4 个字节，而在 64 位机器上其长度是 8 个字节。如果不显式指定这种整形的长度，可能因为不同机器字长不同，导致协议解析出错或者产生错误的结果。

2.4.涉及到浮点数要考虑精度问题，建议放大成整数或者使用字符串去传输

        由于计算机表示浮点数存在精度取舍不准确的问题，例如对于 1.000000，有的计算机可能会得到 0.999999，在某些应用中，如果这个浮点数的业务单位比较大（如表示金额，单位为亿），就会造成很大的影响。因此为了避免不同的机器解析得到不同的结果，建议在网络传输时将浮点数值放大相应的倍数变成整数或者转换为字符串来进行传输。

2.5.协议与自动升级功能

        对于一个商业的产品，发布出去的客户端一般通过客户端的自动升级功能去获得更新（IOS App 除外，苹果公司要求所有的 App 必须在其 App Store 上更新新版本，禁止热更新）。在客户端与服务器通信的所有协议格式中，自动升级协议是最重要的一个，无论版本如何迭代，一定要保证自动升级协议的新旧兼容，这样做有如下原因：

• 如果新的服务器不能兼容旧客户端中的自动升级协议，那么旧的客户端用户将无法升级成新的版本了，这样的产品相当于把自己给“阉割”了。对于不少产品，不通过自动升级而让众多用户去官网下载新的版本是一件很难做到的事情，这种决策可能会导致大量用户流失；

• 退一步讲，对于一些测试不完善，或者处于快速迭代中的产品，只要保证自动升级功能正常，旧版本任何 bug 和瑕疵都可以通过升级新版本解决。这对于一些想投放市场试水，但又可能设计不充分的产品尤其重要。

顺便提一下，一般自动升级功能是根据当前版本的版本号与服务器端新版本的版本号进行比较，如果二者之间存在一个大版本号的差别（如1.0.0 与 2.0.0），即有重大功能更新，则应该强制客户端更新下载最新版本；如果只是一个小版本号的更新（如 1.0.0 与 1.1.0），则可以让用户选择是否更新。当然，如果是新版本修正了前一个版本中严重影响使用的 bug，也应当强制用户更新。