前言
在本章節中,我們將探討TCP協議基於流式傳輸的最大一個問題,即粘包問題。本章主要介紹TCP粘包的原理與其三種解決粘包的方案。並且還會介紹為什麼UDP協議不會產生粘包。
基於TCP協議的socket實現遠端命令輸入
我們準備做一個可以在Client端遠端執行Server端shell
命令並拿到其執行結果的程式,而涉及到網路通訊就必然會出現socket
模組,關於如何抉擇傳輸層協議的選擇?我們選擇使用TCP協議,因為它是可靠傳輸協議且資料量支援比UDP協議要大
Server端程式碼如下:
#!/usr/bin/env python3 # -*- coding:utf-8 -*- # ==== 基於TCP協議的socket實現遠端命令輸入之Server ==== import subprocess from socket import * server = socket(AF_INET, SOCK_STREAM) server.bind(("172.17.0.16",6666)) # 填入私網IP server.listen(5) while 1: # 連結迴圈 conn,client_addr = server.accept() while 1: # 通訊迴圈 try: # 防止Windows平臺下Client端異常關閉導致雙向連結崩塌Server端異常的情況發生 cmd = conn.recv(1024) if not cmd: # 防止類Unix平臺下Client端異常關閉導致雙向連結崩塌Server端異常的情況發生 break res = subprocess.Popen(cmd.decode("utf-8"), shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE,) stdout_res = res.stdout.read() # 正確結果 stderr_res = res.stderr.read() # 錯誤結果 # subprocess模組拿到的是bytes型別,所以直接傳送即可 cmd_res = stdout_res if stdout_res else stderr_res # 因為兩個結果只有一個有資訊,所以我們只拿到有結果的那個 conn.send(cmd_res) except Exception: break conn.close() # 由於client端連結異常,故關閉連結迴圈
Client端程式碼如下:
#!/usr/bin/env python3 # -*- coding:utf-8 -*- # ==== 基於TCP協議的socket實現遠端命令輸入之Client ==== from socket import * client = socket(AF_INET,SOCK_STREAM) client.connect(("xxx.xxx.xxx.xxx",6666)) # 填入Server端公網IP while 1: cmd = input("請輸入命令>>>:").strip() if not cmd: continue if cmd == "quit": break client.send(cmd.encode("utf-8")) cmd_res = client.recv(1024) # 本次接收1024位元組資料 print(cmd_res.decode("utf-8")) # 如果Server端是Windows則用gbk解碼,類Unix用utf-8解碼 client.close()
測試結果:
粘包問題及其原理
上面的測試一切看起來都非常完美,但是是有一個BUG的。當我們如果讀取一條非常長的命令實際上是會出問題的,比如:
這種現象被稱之為粘包,那麼為何會產生這樣的現象呢?
這是由於
recv()
沒有一次性讀取完整個核心緩衝區的內容導致的。其實歸根結底還是怪TCP是位元組流方式傳輸資料。
我們來解析一下這種現象產生的原因:
由於我們的recv()
只是按照固定的1024去讀取資料,那麼一旦整體核心緩衝區中所儲存的整體資料大於1024,就會產生粘包現象。所謂粘包問題主要還是因為接收方不知道訊息之間的界限,不知道一次性提取多少位元組的資料所造成的。
這裡我還畫了一幅圖,可以方便讀者理解:
那麼我們可以通過不斷的增大recv()
中的讀取範圍來解決這個問題嗎?就像對應上圖中的,一次性把快遞櫃包裹全取完,答案是不可以!你再大你也不可能大過核心緩衝區,這個東西都是有一個一定的閾值。一旦超出了這個閾值就會引發異常或者乾脆無效。那麼有什麼好的辦法呢?哈,下面會教給你一些解決辦法的。不過在此之前我們要先看一個TCP協議特有的Nagle
演算法。
Nagle演算法與粘包
基於TCP協議的socket通訊有一個特點,即:一方的
send()
與另一方的recv()
可以沒有任何關係,即:一方send()
三次,另一方recv()
一次就可以將資料全部取出來。
TCP協議的傳送方有一個特徵。他會進行組包,如果一次傳送的資料量很小,比如第一次傳送10個位元組,第二次發生2個位元組,第三次發生3個位元組。他可能會將這15個位元組湊到一塊傳送出去,這是採用了Nagle
演算法來進行的,這麼做有一個弊端就是接收方想要將這個大的資料包按照傳送方的傳送次數精確無誤的接收拆分成10 2 3必須要有傳送方提供的拆包機制才行。
如下圖組所示
傳送方:
from socket import * ip_port = ("127.0.0.1",12306) buffer_size = 1024 back_log = 5 server = socket(AF_INET,SOCK_STREAM) server.bind(ip_port) server.listen(back_log) conn,addr = server.accept() conn.send("hello,".encode("utf-8")) # 第一次傳送是6Bytes的資料 conn.send("world,".encode("utf-8")) # 第二次也是6Bytes的資料 conn.send("yunyaGG!!".encode("utf-8")) # 第三次是9Bytes的資料
接收方:
from socket import * ip_port = ("127.0.0.1",12306) buffer_size = 1024 client = socket(AF_INET,SOCK_STREAM) client.connect(ip_port) data_1 = client.recv(buffer_size) # 我們讀取資料時統一用設定的 buffer_size 來讀取 print("這是第一次的資料包:",data_1.decode("utf-8")) data_2 = client.recv(buffer_size) print("這是第二次的資料包:",data_2.decode("utf-8")) data_3 = client.recv(buffer_size) print("這是第三次的資料包:",data_3.decode("utf-8"))
接收結果:
# ==== 執行結果 ==== """ 這是第一次的資料包: hello, 這是第二次的資料包: world,yunyaGG!! 這是第三次的資料包: """
和預想的有點不太一樣哈,居然把第二次和第三次組成了一個大的資料包傳送過來了。這就是Nagle
演算法,這樣的組包策略很容易就會產生粘包。我不知道你是以什麼樣的方式發過來的,所以我recv()
就只能按照自己設定的方式去接收。
現在思考一下粘包的思路,我們的傳送方需要將切分解包的規則告訴給接收方。
我們嘗試改一下每一次的buffer_size
接收大小:
接收方:
from socket import * ip_port = ("127.0.0.1",12306) buffer_size = 1024 client = socket(AF_INET,SOCK_STREAM) client.connect(ip_port) data_1 = client.recv(6) # 我們手動的按照對方傳送時的規則來進行拆包 print("這是第一次的資料包:",data_1.decode("utf-8")) data_2 = client.recv(6) print("這是第二次的資料包:",data_2.decode("utf-8")) data_3 = client.recv(9) print("這是第三次的資料包:",data_3.decode("utf-8"))
接收結果:
# ==== 執行結果 ==== """ 這是第一次的資料包: hello, 這是第二次的資料包: world, 這是第三次的資料包: yunyaGG!! """
粘包被我們手動的計算位元組數來精確的分割資料接受量的大小給解決了,但是這樣做是不現實的..我們不可能知道對方傳送的資料到底是怎麼樣的,更不用說手動計算。所以有沒有更好的解決方案呢?
解決方案1:預先傳送訊息長度
好了,其實上面關於解決粘包的思路已經出來了。我們需要做的就是讓接收方知道本次傳送內容的大小,接收方才能夠精確的將所有資料全部提取出來不產生遺漏。其實實現方式很簡單,可以嘗試以下思路:
1.傳送方傳送一個此次資料固定的長度
2.接收方接收到該資料長度並且回應
3.傳送方收到回應並且傳送真正的資料
4.接收方不斷的用預設的
buffer_size
值接收新的資料並儲存起來直到超出整個資料的長度,代表此處資料全部接收完畢
Server端:
#!/usr/bin/env python3 # -*- coding:utf-8 -*- # ==== 基於TCP協議的socket實現遠端命令輸入之Server ==== import subprocess from socket import * server = socket(AF_INET, SOCK_STREAM) server.bind(("172.17.0.16", 6666)) # 填入私網IP server.listen(5) while 1: # 連結迴圈 conn, client_addr = server.accept() while 1: # 通訊迴圈 try: # 防止Windows平臺下Client端異常關閉導致雙向連結崩塌Server端異常的情況發生 cmd = conn.recv(1024) if not cmd: # 防止類Unix平臺下Client端異常關閉導致雙向連結崩塌Server端異常的情況發生 break res = subprocess.Popen(cmd.decode("utf-8"), shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE, ) stdout_res = res.stdout.read() # 正確結果 stderr_res = res.stderr.read() # 錯誤結果 # subprocess模組拿到的是bytes型別,所以直接傳送即可 cmd_res = stdout_res if stdout_res else stderr_res # 因為兩個結果只有一個有資訊,所以我們只拿到有結果的那個 msg_length = len(cmd_res) # 本次資料的長度 conn.send(str(msg_length).encode("utf-8")) # 先將要發的整體內容長度傳送過去 if conn.recv(1024) == b"ready": # 如果接收方回應了ready則開始傳送真正的資料體 conn.send(cmd_res) except Exception: break conn.close() # 由於client端連結異常,故關閉連結迴圈
Client端:
#!/usr/bin/env python3 # -*- coding:utf-8 -*- # ==== 基於TCP協議的socket實現遠端命令輸入之Client ==== from socket import * client = socket(AF_INET, SOCK_STREAM) client.connect(("xxx.xxx.xxx.xxx", 6666)) # 填入Server端公網IP while 1: cmd = input("請輸入命令>>>:").strip() if not cmd: continue if cmd == "quit": break client.send(cmd.encode("utf-8")) msg_length = int(client.recv(1024).decode("utf-8")) # 接收到此次傳送內容的整體長度 recv_length = 0 # 代表已接收的內容長度 cmd_res = b"" client.send(b"ready") # 傳送給Server端,代表自己已經接收到此次內容長度,可以傳送真正的資料啦 while recv_length < msg_length: cmd_res += client.recv(1024) # 本次接收1024位元組資料,可能是一小節資料 recv_length += len(cmd_res) # 新增上本次讀取的長度,當全部讀取完後應該 recv_length == msg_length else: print(cmd_res.decode("utf-8")) # 如果Server端是Windows則用gbk解碼,類Unix用utf-8解碼 client.close()
結果如下:
解決方案2:json+struct方案
其實上面的解決方案還是有一些弊端,因為Server端是傳送了2次send()
,第1次傳送資料整體長度,第2次傳送資料內容主體,這樣其實是不太好的(Server端可能同時處理多個連結,所以send()
次數越少越好),而且如果Server端傳的是一個檔案的話那麼侷限性就太強了。因為我們只能將整體的訊息長度傳送過去而諸如檔名,檔案大小之內的資訊就傳送不過去。
所以我們需要一個更加完美的解決方案,即Server端傳送一次send()
就將本次的資料整體長度傳送過去(還可以包括檔案姓名,檔案大小等資訊。)
struct
模組使用介紹
struct
模組可以將其某一種資料格式序列化為固定長度的Bytes
型別,其中最重要的兩個方法就是pack()
、unpack()
。
pack(fmt,*args)
: 根據格式將其轉換為Bytes
型別
unpack(fmt,string)
:根據格式將Bytes
型別資料反解為其原本的形式
格式 | C語言型別 | Python型別 | 位元組數大小 |
---|---|---|---|
x | 填充位元組 | 沒有值 | |
c | char | 位元組長度為1 | 1 |
b | signed char | 整數 | 1 |
B | unsigned char | 整數 | 1 |
? | _Bool | bool | 1 |
h | short | 整數 | 2 |
H | unsigned short | 整數 | 2 |
i | int | 整數 | 4 |
I | unsigned int | 整數 | 4 |
l | long | 整數 | 4 |
L | unsigned long | 整數 | 4 |
q | long long | 整數 | 8 |
Q | unsigned long long | 整數 | 8 |
n | ssize_t | 整數 | |
N | size_t | 整數 | |
f | float | 浮點數 | 4 |
d | double | 浮點數 | 8 |
s | char[] | 位元組 | |
p | char[] | 位元組 | |
P | void * | 整數 |
使用演示:
>>> import struct >>> b1 = struct.pack("i",12) # 嘗試將 int型別的12進行序列化,得到一個4位元組的物件 >>> b1 b'\x0c\x00\x00\x00' >>> struct.unpack("i",b1) # 嘗試將12的序列化物件位元組進行反解,得出元組,第1位就是需要的資料。 (12,) >>>
好了,瞭解到這裡我們就可以開始進行改寫了。
Server端程式碼如下:
#!/usr/bin/env python3 # -*- coding:utf-8 -*- # ==== 基於TCP協議的socket實現遠端命令輸入之Server ==== import json import struct import subprocess from socket import * server = socket(AF_INET, SOCK_STREAM) server.bind(("172.17.0.16", 6666)) # 填入私網IP server.listen(5) while 1: # 連結迴圈 conn, client_addr = server.accept() while 1: # 通訊迴圈 try: # 防止Windows平臺下Client端異常關閉導致雙向連結崩塌Server端異常的情況發生 cmd = conn.recv(1024) if not cmd: # 防止類Unix平臺下Client端異常關閉導致雙向連結崩塌Server端異常的情況發生 break res = subprocess.Popen(cmd.decode("utf-8"), shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE, ) stdout_res = res.stdout.read() # 正確結果 stderr_res = res.stderr.read() # 錯誤結果 # subprocess模組拿到的是bytes型別,所以直接傳送即可 cmd_res = stdout_res if stdout_res else stderr_res # 因為兩個結果只有一個有資訊,所以我們只拿到有結果的那個 # 解決粘包:構建字典,包含資料主體長度,這個就相當於其頭部資訊 head_msg = { "msg_length": len(cmd_res), # 包含資料主體部分的長度 # 如果是檔案,還可以新增file_name,file_size等屬性。 } # 序列化成json格式,並且統計其頭部的長度 head_data = json.dumps(head_msg).encode("utf-8") head_length = struct.pack("i", len(head_data)) # 得到4位元組的頭部資訊,裡面包含頭部的長度 # 傳送頭部長度資訊,頭部資料,與真實資料部分 conn.send(head_length + head_data + cmd_res) except Exception: break conn.close() # 由於client端連結異常,故關閉連結迴圈
Client端程式碼如下:
#!/usr/bin/env python3 # -*- coding:utf-8 -*- # ==== 基於TCP協議的socket實現遠端命令輸入之Client ==== import json import struct from socket import * client = socket(AF_INET, SOCK_STREAM) client.connect(("xxx.xxx.xxx.xxx", 6666)) # 填入Server端公網IP while 1: cmd = input("請輸入命令>>>:").strip() if not cmd: continue if cmd == "quit": break client.send(cmd.encode("utf-8")) # 傳送終端命令 # 解決粘包 head_length = struct.unpack("i", client.recv(4))[0] # 接收到頭部的長度資訊 head_data = json.loads(client.recv(head_length)) # 接收到真實的頭部資訊 msg_length = head_data["msg_length"] # 獲取到資料主體的長度資訊 recv_length = 0 # 代表已接收的內容長度 cmd_res = b"" # 開始獲取真正的資料主體資訊 while recv_length < msg_length: cmd_res += client.recv(1024) # 本次接收1024位元組資料,可能是一小節資料 recv_length += len(cmd_res) # 新增上本次讀取的長度,當全部讀取完後應該 recv_length == msg_length else: print(cmd_res.decode("utf-8")) # 如果Server端是Windows則用gbk解碼,類Unix用utf-8解碼 client.close()
思想如下:
1.Server端構建自身的資料頭部分,其中包含資料體整體長度,如果傳輸的是檔案的話還可以包含檔名,檔案大小等資訊
2.將資料頭部分
json
序列化後再轉換為Bytes
型別3.使用
struct.pack()
模組獲取資料頭的長度,得到一個長度為4的Bytes
型別4.Server端將 資料頭長度 + 資料頭部分 + 資料體部分 全部傳送給Client端
5. Client端
recv()
接收值改為4,拿到資料頭長度Bytes型別6. Client端使用
struct.unpack(
資料頭長度Bytes型別)
模組反解出資料頭真實的長度7. Client端使用
recv()
接收值為資料頭真實的長度拿到真正的資料頭8. 通過
json
反序列化出真正的資料頭,在到其中取出資料體的長度9. 開始
while
迴圈不斷的讀取真實的資料體資料
解決方案3:iter()與偏函式(失敗案例)
上面那麼做看似完美但還是美中不足。因為記憶體緩衝區本來就是隻能取一次值,和迭代器很像,只能迭代一次便不能繼續迭代了。基於這一點我們來做一個終極優化:
還記得iter()
方法嗎?iter()
方法除開建立迭代器外實際上還有一個引數:
def iter(source, sentinel=None): # known special case of iter """ iter(iterable) -> iterator iter(callable, sentinel) -> iterator Get an iterator from an object. In the first form, the argument must supply its own iterator, or be a sequence. In the second form, the callable is called until it returns the sentinel. """ pass
我們來試試這個引數做什麼用的。
li = [1, 2, 3, 4] def my_iter(): return li.pop() res = iter(my_iter, 2) # 代表這個迭代器沒__next__一下就會執行my_iter函式,並且該函式返回值如果是2則終止迭代 print(res.__next__()) # 4 print(res.__next__()) # 3 print(res.__next__()) # StopIteration
第二個引數看來可以設定迭代的終點。
那麼偏函式是什麼呢?偏函式可以設定一個固定的引數給第一個位置的值
效果如下:
from functools import partial # 匯入偏函式 def add(x, y): return x + y func = partial(add, 1) # 設定辨寒暑繫結的第一個引數的值 print(func(1)) # 2 print(func(5)) # 6
現在我們仔細回想,當緩衝區的訊息接收完畢後為空的狀態是會變成 b""
的形式。那麼這個時候我們可以使用iter()
方法設定為不斷的取出快取中的值直到出現b""
,而偏函式可以對recv()
函式進行設定讓它始終取一個值,最後通過join來拼接出取出的所有值即可。
可以使用 "".join(iter(partial(tcp_clien.recv,back_log)),b"")
我們嘗試用函式來檢視一下效果:
from functools import partial # 匯入偏函式 li = [b"","1","2","3","4","5"] # 模擬核心緩衝區 def test(buffer_size): if buffer_size: # 模擬recv的資料大小 return li.pop() print("buffer_size必須為一個int型別的值") res = "".join(iter(partial(test,1024),b"")) print(res) # 54321 # join()方法會不斷的呼叫iter()下的__next__,每呼叫一次就執行一次偏函式。知道出現b""停止
最後我們發現,這樣的做法是會產生recv()
阻塞的,總體來說還是不能夠成功。因為join()
方法會不斷的執行,即使核心緩衝區的資料被recv()
讀完了也不會終止迭代而是繼續阻塞下次的recv()
,故這種方式宣告失敗。(還是iter()
的第二個引數導致的,或許讀取完後核心緩衝區中的資料並不是b""
)
測試的Server端程式碼如下:
from socket import * import subprocess import struct ip_port=('127.0.0.1',8080) back_log=5 buffer_size=1024 tcp_server=socket(AF_INET,SOCK_STREAM) tcp_server.bind(ip_port) tcp_server.listen(back_log) while True: conn,addr=tcp_server.accept() print('新的Client連結',addr) while True: #收 try: cmd=conn.recv(buffer_size) if not cmd:break print('收到Client的命令',cmd) #執行命令,得到命令的執行結果cmd_res res=subprocess.Popen(cmd.decode('utf-8'),shell=True, stderr=subprocess.PIPE, stdout=subprocess.PIPE, stdin=subprocess.PIPE) err=res.stderr.read() if err: cmd_res=err else: cmd_res=res.stdout.read() #發 if not cmd_res: cmd_res='執行成功'.encode('gbk') length=len(cmd_res) data_length=struct.pack('i',length) conn.send(data_length) conn.send(cmd_res) except Exception as e: print(e) break
測試的Client程式碼如下:
from socket import * import struct from functools import partial #偏函式 ip_port=('127.0.0.1',8080) back_log=5 buffer_size=1024 tcp_client=socket(AF_INET,SOCK_STREAM) tcp_client.connect(ip_port) while True: cmd=input('>>: ').strip() if not cmd:continue if cmd == 'quit':break tcp_client.send(cmd.encode('utf-8')) #解決粘包 length_data=tcp_client.recv(4) length=struct.unpack('i',length_data)[0] #第一種方法 recv_size=0 recv_msg=b'' while recv_size < length: #為何recv裡是buffer_size,不是length,因為length如果為24G,系統記憶體沒有那麼大 #所以每次buffer_size,當recv_size < length時,迴圈接收,直到recv_size =length,退出迴圈 recv_msg += tcp_client.recv(buffer_size) recv_size=len(recv_msg) #1024 #第二種方法 失敗版本,會引發recv()的阻塞,而不會終止迭代。因為join()方法會不斷的呼叫其iter()方法產生的迭代器,也就是呼叫其__next__方法,所以第二次沒訊息的recv()會阻塞住。 #recv_msg=''.join(iter(partial(tcp_client.recv, buffer_size), b'')) print('命令的執行結果是 ',recv_msg.decode('gbk')) tcp_client.close()
UDP協議為何不會產生粘包
UDP協議是面向訊息的協議,每一次的
sendto()
與recvfrom()
必須一一對應,否則就會收不到訊息。
UDP是面向訊息的協議,每個UDP段都是一條訊息,每sendto()
一次就是傳送一次訊息,而不管接收方有沒有收到訊息傳送方只管自己的傳送任務,這也是UDP被稱為不可靠傳輸協議的由來。接收端的套接字緩衝區採用了鏈式的結構來記錄每一個到達的UDP包,在每一個UDP包中都有了訊息頭,包括埠,訊息源等等..於是UDP就能夠去區分出一個明確的訊息定義,即面向訊息的通訊是有訊息邊界的,所以UDP的傳輸叫做資料包的形式。
並且每一次recvform()
的buffer_size
最大值如果不夠獲取完全部的核心緩衝區裡的資料的話,那麼只會收夠指定的最大位元組數量(即buffer_size
的設定值),剩餘的就不要了。所以UDP不會存在粘包,多麼乾脆利落...
我們還是用一個快遞員的那個圖來進行演示:
還有一點需要注意一下。使用UDP協議進行通訊的時候不管首先啟動哪一方都不會報錯,因為它只管發,不管有沒有人接收。
所以,這也是我稱UDP協議比較隨便的原因。