python设计tcp数据包协议类

一.问题描述

    在tcp编程中，最需要解决的就是粘包分包问题。所以，我们需要在每个数据包前面加上数据包的长度用以分割粘连的包。

二.包结构的设计

    包的组成：包长度+数据域 

    包长度：用4个字节存储数据域长度，数据域长度即为其所占字节数

    数据域：由若干个变量组成，如果是定长变量则不用加变量长度

    定长变量：我们人为规定，传输中的int为4字节定长变量

    变长变量：那就是字符串啦

    文字难理解，那我就画个图吧：

    

    

    上图的第一行是数据包的一个总体结构

    第二行是数据域内部的一个结构（数据域的变量数量和位置都是我们自己定的，上图只是举一个例子而已）

    第三行是具体变量的结构

    如果不太清楚这个结构，不要紧，我们来举一个具体的例子

    比如我们现在创建一个数据域是这样的数据包：

    数据域：666,"你好啊","hello",888

    这个数据域一共存储了四个变量，开头和结尾是两个整型变量，中间是两个字符串变量。然后我们对这个数据域构建出来的数据包是这个样子的：

    

    

   这下搞明白了吧，那下面就看看怎么用python封装一个类实现上述结构的数据包的组装。

 

三.代码实现

class Protocol:
    """
    规定：
        数据包头部占4字节

        整型占4字节

        字符串长度位占2字节

        字符串不定长

    """

    def __init__(self, bs=None):
        """
        如果bs为None则代表需要创建一个数据包
        否则代表需要解析一个数据包
        """
        if bs:
            self.bs = bytearray(bs)
        else:
            self.bs = bytearray(0)

    def get_int32(self):
        try:
            ret = self.bs[:4]
            self.bs = self.bs[4:]
            return int.from_bytes(ret, byteorder='little')
        except:
            raise Exception("数据异常！")

    def get_str(self):
        try:
            # 拿到字符串字节长度(字符串长度位2字节)
            length = int.from_bytes(self.bs[:2], byteorder='little')
            # 再拿字符串
            ret = self.bs[2:length + 2]
            # 删掉取出来的部分
            self.bs = self.bs[2 + length:]
            return ret.decode(encoding='utf8')
        except:
            raise Exception("数据异常！")

    def add_int32(self, val):
        bytes_val = bytearray(val.to_bytes(4, byteorder='little'))
        self.bs += bytes_val

    def add_str(self, val):
        bytes_val = bytearray(val.encode(encoding='utf8'))
        bytes_length = bytearray(len(bytes_val).to_bytes(2, byteorder='little'))
        self.bs += (bytes_length + bytes_val)

    def get_pck_not_head(self):
        return self.bs

    def get_pck_has_head(self):
        bytes_pck_length = bytearray(len(self.bs).to_bytes(4, byteorder='little'))
        return bytes_pck_length + self.bs


if __name__ == '__main__':
    p = Protocol()

    p.add_int32(666)
    p.add_str("你好啊")
    p.add_str("hello")
    p.add_int32(888)

    r = Protocol(p.get_pck_not_head())

    print(r.get_int32())
    print(r.get_str())
    print(r.get_str())
    print(r.get_int32())

代码比较简单，也不够严谨。大家可以按照自己的需求加以修改。