Python Socket 程式設計：聊天室示例程式

上一篇我們學習了簡單的 Python TCP Socket 程式設計，通過分別寫服務端和客戶端的程式碼瞭解基本的 Python Socket 程式設計模型。本文再通過一個例子來加強一下對 Socket 程式設計的理解。

聊天室程式需求

我們要實現的是簡單的聊天室的例子，就是允許多個人同時一起聊天，每個人傳送的訊息所有人都能接收到，類似於 QQ 群的功能，而不是點對點的 QQ 好友之間的聊天。如下圖：

我們要實現的有兩部分：

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，表示這些檔案有事件到達。下面的簡單程式是表示等待從標準輸入中獲得輸入：

Python

rlist, wlist, elist = select.select( [sys.stdin], [], [] )

print sys.stdin.read()

123	rlist,wlist,elist=select.select([sys.stdin],[],[])printsys.stdin.read()

select 方法的三個引數都是 list 型別，分別代表讀事件、寫事件、錯誤事件，同樣方法返回值也是三個 list，包含的是哪些事件（讀、寫、異常）滿足了。上面的例子，由於引數只有一個事件 sys.stdin，表示只關心標準輸入事件，因此當 select 返回時 rlist 只會是 [sys.stdin]，表示可以從 stdin 中讀入資料了，我們使用 read 方法來讀入資料。

當然 select 對於 socket 描述符也是有效的，下面的一個例子是建立了兩個 socket 客戶端連線到遠端伺服器，select 用來監控哪個 socket 有資料到達：

Python

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 )

12345678910111213141516171819202122

importsocketimportselectsock1=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))while1:# 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 dataforsock inrlist:printsock.recv(100)

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

聊天室伺服器

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

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

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

Python

# Get the list sockets which are ready to be read through select
read_sockets,write_sockets,error_sockets = select.select(CONNECTION_LIST,[],[])

12	# Get the list sockets which are ready to be read through selectread_sockets,write_sockets,error_sockets=select.select(CONNECTION_LIST,[],[])

當 select 返回時，說明在 read_sockets 上有可讀的資料，這裡又分為兩種情況：

如果是主 socket（即伺服器開始建立的 socket，一直處於監聽狀態）有資料可讀，表示有新的連線請求可以接收，此時需要呼叫 accept 函式來接收新的客戶端連線，並將其連線資訊廣播到其它客戶端。
如果是其它 sockets（即與客戶端已經建立連線的 sockets）有資料可讀，那麼表示客戶端傳送訊息到伺服器端，使用 recv 函式讀訊息，並將訊息轉發到其它所有連線的客戶端。

上面兩種情況到涉及到廣播訊息的過程，廣播也就是將從某個 socket 獲得的訊息通過 CONNECTION_LIST 的每個 socket （除了自身和主 socket）一個個傳送出去：

Python

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)

12345678910

defbroadcast_data(sock,message):#Do not send the message to master socket and the client who has send us the messageforsocketinCONNECTION_LIST:ifsocket!=server_socket andsocket!=sock:try:socket.send(message)except:# broken socket connection may be, chat client pressed ctrl+c for examplesocket.close()CONNECTION_LIST.remove(socket)

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

完整的聊天室伺服器原始碼如下：

Python

# 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

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970

# Tcp Chat serverimportsocket,select#Function to broadcast chat messages to all connected clientsdefbroadcast_data(sock,message):#Do not send the message to master socket and the client who has send us the messageforsocketinCONNECTION_LIST:ifsocket!=server_socket andsocket!=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)while1:# Get the list sockets which are ready to be read through selectread_sockets,write_sockets,error_sockets=select.select(CONNECTION_LIST,[],[])forsock inread_sockets:#New connectionifsock==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 roomn"%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)ifdata:broadcast_data(sock,"r"+' '+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 port5000

聊天室客戶端

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

監聽伺服器是否有訊息傳送過來
檢查使用者的輸入，如果使用者輸入某條訊息，需要傳送到伺服器

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

Python

rlist = [sys.stdin, s]

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

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

那邏輯就很簡單了，如果是 sys.stdin 有資料可讀，表示使用者從控制檯輸入資料並按下回車，那麼就從標準輸入讀資料，併發送到伺服器；如果是與伺服器連線的 socket 有資料可讀，表示伺服器傳送訊息給該客戶端，那麼就從 socket 接收資料。加上一些提示資訊及異常處理的完整客戶端程式碼如下：

Python

# 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()

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253

# telnet program exampleimportsocket,select,string,sysdefprompt():sys.stdout.write('<You> ')sys.stdout.flush()#main functionif__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

Python Socket 程式設計：聊天室示例程式

聊天室程式需求

Python 非同步 I/O

聊天室伺服器

聊天室客戶端

Python Socket 程式設計：聊天室示例程式

Python Socket 程式設計——聊天室示例程式

Python Socket 編程——聊天室演示樣例程序

（二）網路程式設計：聊天室（2）

（二）網路程式設計：聊天室（1）

python-網路程式設計-模擬聊天室

Python網路程式設計---實現聊天室

python socket 多人聊天室

Python socket實現簡單聊天室

Python下UDP的Socket程式設計：伺服器端因客戶端的非正常退出而報錯？

Python Socket 程式設計示例 Echo Server

Python程式設計：聊天群的遮蔽髒話

python網路程式設計：TCP/IP、Socket、C/S架構等

Python socket程式設計之（二）：socket的選項設定

python socket程式設計---從使用Python開發一個Socket示例說到開發者的思維和習慣問題

使用 Socket.IO 開發聊天室

Java——WebSocket的使用（Demo：聊天室）

1025_(即時通訊)使用 Socket.IO 開發聊天室

[Python_7] Python Socket 程式設計

python基礎程式設計：登入介面

Python Socket 程式設計：聊天室示例程式

聊天室程式需求

Python 非同步 I/O

聊天室伺服器

聊天室客戶端

相關推薦