上一篇 我們學習了簡單的 Python TCP Socket 程式設計，通過分別寫服務端和客戶端的程式碼瞭解基本的 Python Socket 程式設計模型。本文再通過一個例子來加強一下對 Socket 程式設計的理解。
聊天室程式需求
我們要實現的是簡單的聊天室的例子，就是允許多個人同時一起聊天，每個人傳送的訊息所有人都能接收到，類似於 QQ 群的功能，而不是點對點的 QQ 好友之間的聊天。如下圖：
圖來自：http://www.ibm.com/developerworks/linux/tutorials/l-pysocks/
我們要實現的有兩部分：
- Chat Server：聊天伺服器，負責與使用者建立 Socket 連線，並將某個使用者傳送的訊息廣播到所有線上的使用者。
- Telnet Client：使用者聊天客戶端，可以輸入聊天的內容併傳送，同時可以顯示其他使用者的訊息記錄。
同樣，我們的訊息通訊採用 TCP 連線保證可靠性。在分別對服務端和客戶端進行程式設計之前，首先要學習一下 Python 中實現非同步 I/O 的一個函式 —— select。
Python 非同步 I/O
Python 在 select 模組中提供了非同步 I/O（Asynchronous I/O），這與 Linux 下的 select 機制相似，但進行一些簡化。我首先介紹一下 select，然後告訴你在 Python 中如何使用它。
前面文章使用多執行緒來並行處理多路 socket I/O，這裡介紹的select 方法允許你響應不同 socket 的多個事件以及其它不同事件。例如你可以讓 select 在某個 socket 有資料到達時，或者當某個 socket 可以寫資料時，又或者是當某個 socket 發生錯誤時通知你，好處是你可以同時響應很多 socket 的多個事件。
Linux 下 C 語言的 select 使用到點陣圖來表示我們要關注哪些檔案描述符的事件，Python 中使用 list 來表示我們監控的檔案描述符，當有事件到達時，返回的也是檔案描述符的 list，表示這些檔案有事件到達。下面的簡單程式是表示等待從標準輸入中獲得輸入：
|
1 2 3 |
rlist, wlist, elist = select.select( [sys.stdin], [], [] ) print sys.stdin.read() |
select 方法的三個引數都是 list 型別，分別代表讀事件、寫事件、錯誤事件，同樣方法返回值也是三個 list，包含的是哪些事件（讀、寫、異常）滿足了。上面的例子，由於引數只有一個事件 sys.stdin，表示只關心標準輸入事件，因此當 select 返回時 rlist 只會是 [sys.stdin]，表示可以從 stdin 中讀入資料了，我們使用 read 方法來讀入資料。
當然 select 對於 socket 描述符也是有效的，下面的一個例子是建立了兩個 socket 客戶端連線到遠端伺服器，select 用來監控哪個 socket 有資料到達：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
import socket import select sock1 = socket.socket( socket.AF_INET, socket.SOCK_STREAM ) sock2 = socket.socket( socket.AF_INET, socket.SOCK_STREAM ) sock1.connect( ('192.168.1.1', 25) ) sock2.connect( ('192.168.1.1', 25) ) while 1: # Await a read event rlist, wlist, elist = select.select( [sock1, sock2], [], [], 5 ) # Test for timeout if [rlist, wlist, elist] == [ [], [], [] ]: print "Five seconds elapsed.n" else: # Loop through each socket in rlist, read and print the available data for sock in rlist: print sock.recv( 100 ) |
好了，有了上面的基礎，我們就可以來設計聊天室的伺服器和客戶端了。
聊天室伺服器
聊天室伺服器主要完成下面兩件事：
- 接收多個客戶端的連線
- 從每個客戶端讀入訊息病廣播到其它連線的客戶端
我們定義一個 list 型變數 CONNECTION_LIST 表示監聽多個 socket 事件的可讀事件，那麼利用上面介紹的我們的伺服器使用 select 來處理多路複用 I/O 的程式碼如下：
|
1 2 |
# Get the list sockets which are ready to be read through select read_sockets,write_sockets,error_sockets = select.select(CONNECTION_LIST,[],[]) |
當 select 返回時，說明在 read_sockets 上有可讀的資料，這裡又分為兩種情況：
- 如果是主 socket（即伺服器開始建立的 socket，一直處於監聽狀態）有資料可讀，表示有新的連線請求可以接收，此時需要呼叫
accept函式來接收新的客戶端連線，並將其連線資訊廣播到其它客戶端。 - 如果是其它 sockets（即與客戶端已經建立連線的 sockets）有資料可讀，那麼表示客戶端傳送訊息到伺服器端，使用
recv函式讀訊息，並將訊息轉發到其它所有連線的客戶端。
上面兩種情況到涉及到廣播訊息的過程，廣播也就是將從某個 socket 獲得的訊息通過 CONNECTION_LIST 的每個 socket （除了自身和主 socket）一個個傳送出去：
|
1 2 3 4 5 6 7 8 9 10 |
def broadcast_data (sock, message): #Do not send the message to master socket and the client who has send us the message for socket in CONNECTION_LIST: if socket != server_socket and socket != sock : try : socket.send(message) except : # broken socket connection may be, chat client pressed ctrl+c for example socket.close() CONNECTION_LIST.remove(socket) |
如果傳送失敗，我們假設某個客戶端已經斷開了連線，關閉該 socket 病將其從連線列表中刪除。
完整的聊天室伺服器原始碼如下：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 |
# Tcp Chat server import socket, select #Function to broadcast chat messages to all connected clients def broadcast_data (sock, message): #Do not send the message to master socket and the client who has send us the message for socket in CONNECTION_LIST: if socket != server_socket and socket != sock : try : socket.send(message) except : # broken socket connection may be, chat client pressed ctrl+c for example socket.close() CONNECTION_LIST.remove(socket) if __name__ == "__main__": # List to keep track of socket descriptors CONNECTION_LIST = [] RECV_BUFFER = 4096 # Advisable to keep it as an exponent of 2 PORT = 5000 server_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) # this has no effect, why ? server_socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) server_socket.bind(("0.0.0.0", PORT)) server_socket.listen(10) # Add server socket to the list of readable connections CONNECTION_LIST.append(server_socket) print "Chat server started on port " + str(PORT) while 1: # Get the list sockets which are ready to be read through select read_sockets,write_sockets,error_sockets = select.select(CONNECTION_LIST,[],[]) for sock in read_sockets: #New connection if sock == server_socket: # Handle the case in which there is a new connection recieved through server_socket sockfd, addr = server_socket.accept() CONNECTION_LIST.append(sockfd) print "Client (%s, %s) connected" % addr broadcast_data(sockfd, "[%s:%s] entered roomn" % addr) #Some incoming message from a client else: # Data recieved from client, process it try: #In Windows, sometimes when a TCP program closes abruptly, # a "Connection reset by peer" exception will be thrown data = sock.recv(RECV_BUFFER) if data: broadcast_data(sock, "r" + ' ' + data) except: broadcast_data(sock, "Client (%s, %s) is offline" % addr) print "Client (%s, %s) is offline" % addr sock.close() CONNECTION_LIST.remove(sock) continue server_socket.close() 在控制檯下執行該程式： $ python chat_server.py Chat server started on port 5000 |
聊天室客戶端
我們寫一個客戶端程式可以連線到上面的伺服器，完成傳送訊息和接收訊息的過程。主要做下面兩件事：
- 監聽伺服器是否有訊息傳送過來
- 檢查使用者的輸入，如果使用者輸入某條訊息，需要傳送到伺服器
這裡有兩個 I/O 事件需要監聽：連線到伺服器的 socket 和標準輸入，同樣我們可以使用 select 來完成：
|
1 2 3 4 |
rlist = [sys.stdin, s] # Get the list sockets which are readable read_list, write_list, error_list = select.select(rlist , [], []) |
那邏輯就很簡單了，如果是 sys.stdin 有資料可讀，表示使用者從控制檯輸入資料並按下回車，那麼就從標準輸入讀資料，併傳送到伺服器；如果是與伺服器連線的 socket 有資料可讀，表示伺服器傳送訊息給該客戶端，那麼就從 socket 接收資料。加上一些提示資訊及異常處理的完整客戶端程式碼如下：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
# telnet program example import socket, select, string, sys def prompt() : sys.stdout.write('<You> ') sys.stdout.flush() #main function if __name__ == "__main__": if(len(sys.argv) < 3) : print 'Usage : python telnet.py hostname port' sys.exit() host = sys.argv[1] port = int(sys.argv[2]) s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) s.settimeout(2) # connect to remote host try : s.connect((host, port)) except : print 'Unable to connect' sys.exit() print 'Connected to remote host. Start sending messages' prompt() while 1: socket_list = [sys.stdin, s] # Get the list sockets which are readable read_sockets, write_sockets, error_sockets = select.select(socket_list , [], []) for sock in read_sockets: #incoming message from remote server if sock == s: data = sock.recv(4096) if not data : print '\nDisconnected from chat server' sys.exit() else : #print data sys.stdout.write(data) prompt() #user entered a message else : msg = sys.stdin.readline() s.send(msg) prompt() |
可以在多個終端下執行該程式碼：
|
1 2 3 4 5 6 |
$ python telnet.py localhost 5000 Connected to remote host. Start sending messages <You> hello <You> I am fine <('127.0.0.1', 38378)> ok good <You> |
在另一個終端顯示的資訊：
|
1 2 3 4 |
<You> [127.0.0.1:39339] entered room <('127.0.0.1', 39339)> hello <('127.0.0.1', 39339)> I am fine <You> ok good |
總結
上面的程式碼注意兩點：
- 聊天室客戶端程式碼不能在 windows 下執行，因為程式碼使用
select同時監聽 socket 和輸入流，在 Windows 下select函式是由 WinSock 庫提供，不能處理不是由 WinSock 定義的檔案描述符。 - 客戶端程式碼還有個缺陷是，當某個客戶端在輸入訊息但還未傳送出去時，伺服器也傳送訊息過來，這樣會沖刷掉客戶端正在輸入的訊息。這目前來看沒辦法解決的，唯一的解決方法是使用像 ncurses 終端庫使使用者輸入和輸出獨立開，或者寫一個 GUI 的程式。
那麼本文通過一個聊天室的範例進一步學習了 Python 下 Socket 程式設計。