上一篇 我們學習了簡單的 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，表示這些文件有事件到達。下面的簡單程序是表示等待從標準輸入中獲得輸入：

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 有數據到達：

import socket import selectsock1 = 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 eventrlist, wlist, elist = select.select( [sock1, sock2], [], [], 5 )# Test for timeoutif [rlist, wlist, elist] == [ [], [], [] ]:print "Five seconds elapsed.\n"else:# Loop through each socket in rlist, read and print the available datafor sock in rlist:print sock.recv( 100 )

好了，有了上面的基礎，我們就可以來設計聊天室的服務器和客戶端了。

聊天室服務器

聊天室服務器主要完成下面兩件事：

• 接收多個客戶端的連接
• 從每個客戶端讀入消息病廣播到其它連接的客戶端

我們定義一個 list 型變量 CONNECTION_LIST 表示監聽多個 socket 事件的可讀事件，那么利用上面介紹的我們的服務器使用 select 來處理多路復用 I/O 的代碼如下：

# 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）一個個發送出去：

def broadcast_data (sock, message):#Do not send the message to master socket and the client who has send us the messagefor 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 examplesocket.close()CONNECTION_LIST.remove(socket)

如果發送失敗，我們假設某個客戶端已經斷開了連接，關閉該 socket 病將其從連接列表中刪除。

完整的聊天室服務器源代碼如下：

# Tcp Chat serverimport 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 messagefor 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 examplesocket.close()CONNECTION_LIST.remove(socket)if __name__ == "__main__":# List to keep track of socket descriptorsCONNECTION_LIST = []RECV_BUFFER = 4096 # Advisable to keep it as an exponent of 2PORT = 5000server_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 connectionsCONNECTION_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 selectread_sockets,write_sockets,error_sockets = select.select(CONNECTION_LIST,[],[])for sock in read_sockets:#New connectionif sock == server_socket:# Handle the case in which there is a new connection recieved through server_socketsockfd, addr = server_socket.accept()CONNECTION_LIST.append(sockfd)print "Client (%s, %s) connected" % addrbroadcast_data(sockfd, "[%s:%s] entered room\n" % addr)#Some incoming message from a clientelse:# Data recieved from client, process ittry:#In Windows, sometimes when a TCP program closes abruptly,# a "Connection reset by peer" exception will be throwndata = sock.recv(RECV_BUFFER)if data:broadcast_data(sock, "\r" + '<' + str(sock.getpeername()) + '> ' + data) except:broadcast_data(sock, "Client (%s, %s) is offline" % addr)print "Client (%s, %s) is offline" % addrsock.close()CONNECTION_LIST.remove(sock)continueserver_socket.close()

在控制臺下運行該程序：

$ python chat_server.py Chat server started on port 5000

聊天室客戶端

我們寫一個客戶端程序可以連接到上面的服務器，完成發送消息和接收消息的過程。主要做下面兩件事：

• 監聽服務器是否有消息發送過來
• 檢查用戶的輸入，如果用戶輸入某條消息，需要發送到服務器

這里有兩個 I/O 事件需要監聽：連接到服務器的 socket 和標準輸入，同樣我們可以使用 select 來完成：

rlist = [sys.stdin, s]# Get the list sockets which are readable read_list, write_list, error_list = select.select(rlist , [], [])

那邏輯就很簡單了，如果是 sys.stdin 有數據可讀，表示用戶從控制臺輸入數據并按下回車，那么就從標準輸入讀數據，并發送到服務器；如果是與服務器連接的 socket 有數據可讀，表示服務器發送消息給該客戶端，那么就從 socket 接收數據。加上一些提示信息及異常處理的完整客戶端代碼如下：

# telnet program example import socket, select, string, sysdef 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 hosttry :s.connect((host, port))except :print 'Unable to connect'sys.exit()print 'Connected to remote host. Start sending messages'prompt()while 1:rlist = [sys.stdin, s]# Get the list sockets which are readableread_list, write_list, error_list = select.select(rlist , [], [])for sock in read_list:#incoming message from remote serverif sock == s:data = sock.recv(4096)if not data :print '\nDisconnected from chat server'sys.exit()else :#print datasys.stdout.write(data)prompt()#user entered a messageelse :msg = sys.stdin.readline()s.send(msg)prompt()

可以在多個終端下運行該代碼：

$ 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>

在另一個終端顯示的信息：

<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 編程。

參考文獻

• Python socket – chat server and client with code example
• Sockets programming in Python

轉載于:https://www.cnblogs.com/hazir/p/python_chat_room.html

總結

以上是生活随笔為你收集整理的Python Socket 编程——聊天室示例程序的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。