如何用Python編寫一個聊天室

標籤：

一、課程介紹1.簡介

本次項目課是實現簡單聊天室程式的伺服器端和用戶端。

2.知識點

伺服器端涉及到asyncore、asynchat和socket這幾個模組，用戶端用到了telnetlib、wx、time和thread這幾個模組。

3.所需環境

本次課中編寫用戶端需要用到wxPython，它是一個GUI工具包，請先使用下面的命令安裝：

$ sudo apt-get install python-wxtools

密碼為shiyanlou

4.項目效果

登入視窗

聊天視窗

5.原始碼下載

git clone https://github.com/shiyanlou/pythonchat.git

說明：如果你不理解上述代碼的下載方式或者下載後在環境中找不到代碼，可以點擊查看這裡

二、項目實戰（伺服器端）1.伺服器類

首先需要一個聊天伺服器，這裡繼承asyncore的dispatcher類來實現，代碼如下

class ChatServer(dispatcher):    """    聊天伺服器    """    def __init__(self, port):        dispatcher.__init__(self)        self.create_socket(socket.AF_INET, socket.SOCK_STREAM)        self.set_reuse_addr()        self.bind((‘‘, port))        self.listen(5)        self.users = {}        self.main_room = ChatRoom(self)    def handle_accept(self):        conn, addr = self.accept()        ChatSession(self, conn)

2.會話類

有了伺服器類還需要能維護每個使用者的串連會話，這裡繼承asynchat的async_chat類來實現，代碼如下：

class ChatSession(async_chat):    """    負責和單使用者通訊    """    def __init__(self, server, sock):        async_chat.__init__(self, sock)        self.server = server        self.set_terminator(‘\n‘)        self.data = []        self.name = None        self.enter(LoginRoom(server))    def enter(self, room):        ‘從當前房間移除自身，然後添加到指定房間‘        try:            cur = self.room        except AttributeError:            pass        else:            cur.remove(self)        self.room = room        room.add(self)    def collect_incoming_data(self, data):        ‘接受用戶端的資料‘        self.data.append(data)    def found_terminator(self):        ‘當用戶端的一條資料結束時的處理‘        line = ‘‘.join(self.data)        self.data = []        try:            self.room.handle(self, line)        except EndSession:            self.handle_close()    def handle_close(self):        async_chat.handle_close(self)        self.enter(LogoutRoom(self.server))

3.命令直譯器

現在就需要一個命令直譯器能夠解釋使用者的命令，例如登入、查詢線上使用者和發訊息等，代碼如下：

class CommandHandler:    """    命令處理類    """    def unknown(self, session, cmd):        ‘響應未知命令‘        session.push(‘Unknown command: %s\n‘ % cmd)    def handle(self, session, line):        ‘命令處理‘        if not line.strip():            return        parts = line.split(‘ ‘, 1)        cmd = parts[0]        try:            line = parts[1].strip()        except IndexError:            line = ‘‘        meth = getattr(self, ‘do_‘ + cmd, None)        try:            meth(session, line)        except TypeError:            self.unknown(session, cmd)

4.房間

接下來就需要實現聊天室的房間了，這裡我們定義了三種房間，分別是使用者剛登入時的房間、聊天的房間和退出登入的房間，這三種房間都有一個公用的父類，代碼如下：

class Room(CommandHandler):    """    包含多個使用者的環境，負責基本的命令處理和廣播    """    def __init__(self, server):        self.server = server        self.sessions = []    def add(self, session):        ‘一個使用者進入房間‘        self.sessions.append(session)    def remove(self, session):        ‘一個使用者離開房間‘        self.sessions.remove(session)    def broadcast(self, line):        ‘向所有的使用者發送指定訊息‘        for session in self.sessions:            session.push(line)    def do_logout(self, session, line):        ‘退出房間‘        raise EndSessionclass LoginRoom(Room):    """    剛登入的使用者的房間    """    def add(self, session):        ‘使用者串連成功的回應‘        Room.add(self, session)        session.push(‘Connect Success‘)    def do_login(self, session, line):        ‘登入命令處理‘        name = line.strip()        if not name:            session.push(‘UserName Empty‘)        elif name in self.server.users:            session.push(‘UserName Exist‘)        else:            session.name = name            session.enter(self.server.main_room)class ChatRoom(Room):    """    聊天用的房間    """    def add(self, session):        ‘廣播新使用者進入‘        session.push(‘Login Success‘)        self.broadcast(session.name + ‘ has entered the room.\n‘)        self.server.users[session.name] = session        Room.add(self, session)    def remove(self, session):        ‘廣播使用者離開‘        Room.remove(self, session)        self.broadcast(session.name + ‘ has left the room.\n‘)    def do_say(self, session, line):        ‘用戶端發送訊息‘        self.broadcast(session.name + ‘: ‘ + line + ‘\n‘)    def do_look(self, session, line):        ‘查看線上使用者‘        session.push(‘Online Users:\n‘)        for other in self.sessions:            session.push(other.name + ‘\n‘)class LogoutRoom(Room):    """    使用者退出時的房間    """    def add(self, session):        ‘從伺服器中移除‘        try:            del self.server.users[session.name]        except KeyError:            pass

5.伺服器端完整代碼

#!/usr/bin/python# encoding: utf-8from asyncore import dispatcherfrom asynchat import async_chatimport socket, asyncorePORT = 6666 #連接埠class EndSession(Exception):    """    自訂會話結束時的異常    """    passclass CommandHandler:    """    命令處理類    """    def unknown(self, session, cmd):        ‘響應未知命令‘        session.push(‘Unknown command: %s\n‘ % cmd)    def handle(self, session, line):        ‘命令處理‘        if not line.strip():            return        parts = line.split(‘ ‘, 1)        cmd = parts[0]        try:            line = parts[1].strip()        except IndexError:            line = ‘‘        meth = getattr(self, ‘do_‘ + cmd, None)        try:            meth(session, line)        except TypeError:            self.unknown(session, cmd)class Room(CommandHandler):    """    包含多個使用者的環境，負責基本的命令處理和廣播    """    def __init__(self, server):        self.server = server        self.sessions = []    def add(self, session):        ‘一個使用者進入房間‘        self.sessions.append(session)    def remove(self, session):        ‘一個使用者離開房間‘        self.sessions.remove(session)    def broadcast(self, line):        ‘向所有的使用者發送指定訊息‘        for session in self.sessions:            session.push(line)    def do_logout(self, session, line):        ‘退出房間‘        raise EndSessionclass LoginRoom(Room):    """    剛登入的使用者的房間    """    def add(self, session):        ‘使用者串連成功的回應‘        Room.add(self, session)        session.push(‘Connect Success‘)    def do_login(self, session, line):        ‘登入命令處理‘        name = line.strip()        if not name:            session.push(‘UserName Empty‘)        elif name in self.server.users:            session.push(‘UserName Exist‘)        else:            session.name = name            session.enter(self.server.main_room)class ChatRoom(Room):    """    聊天用的房間    """    def add(self, session):        ‘廣播新使用者進入‘        session.push(‘Login Success‘)        self.broadcast(session.name + ‘ has entered the room.\n‘)        self.server.users[session.name] = session        Room.add(self, session)    def remove(self, session):        ‘廣播使用者離開‘        Room.remove(self, session)        self.broadcast(session.name + ‘ has left the room.\n‘)    def do_say(self, session, line):        ‘用戶端發送訊息‘        self.broadcast(session.name + ‘: ‘ + line + ‘\n‘)    def do_look(self, session, line):        ‘查看線上使用者‘        session.push(‘Online Users:\n‘)        for other in self.sessions:            session.push(other.name + ‘\n‘)class LogoutRoom(Room):    """    使用者退出時的房間    """    def add(self, session):        ‘從伺服器中移除‘        try:            del self.server.users[session.name]        except KeyError:            passclass ChatSession(async_chat):    """    負責和單使用者通訊    """    def __init__(self, server, sock):        async_chat.__init__(self, sock)        self.server = server        self.set_terminator(‘\n‘)        self.data = []        self.name = None        self.enter(LoginRoom(server))    def enter(self, room):        ‘從當前房間移除自身，然後添加到指定房間‘        try:            cur = self.room        except AttributeError:            pass        else:            cur.remove(self)        self.room = room        room.add(self)    def collect_incoming_data(self, data):        ‘接受用戶端的資料‘        self.data.append(data)    def found_terminator(self):        ‘當用戶端的一條資料結束時的處理‘        line = ‘‘.join(self.data)        self.data = []        try:            self.room.handle(self, line)        except EndSession:            self.handle_close()    def handle_close(self):        async_chat.handle_close(self)        self.enter(LogoutRoom(self.server))class ChatServer(dispatcher):    """    聊天伺服器    """    def __init__(self, port):        dispatcher.__init__(self)        self.create_socket(socket.AF_INET, socket.SOCK_STREAM)        self.set_reuse_addr()        self.bind((‘‘, port))        self.listen(5)        self.users = {}        self.main_room = ChatRoom(self)    def handle_accept(self):        conn, addr = self.accept()        ChatSession(self, conn)if __name__ == ‘__main__‘:    s = ChatServer(PORT)    try:        asyncore.loop()    except KeyboardInterrupt:        print

三、項目實戰（用戶端）

完成了伺服器端後，就需要實現用戶端了，這裡用戶端串連伺服器使用了telnetlib模組。

1.登入視窗

這裡的圖形介面包選擇了wxPython，前面有安裝說明，登入視窗通過繼承wx.Frame類來實現，代碼如下：

class LoginFrame(wx.Frame):    """    登入視窗    """    def __init__(self, parent, id, title, size):        ‘初始化，添加控制項並綁定事件‘        wx.Frame.__init__(self, parent, id, title)        self.SetSize(size)        self.Center()        self.serverAddressLabel = wx.StaticText(self, label = "Server Address", pos = (10, 50), size = (120, 25))        self.userNameLabel = wx.StaticText(self, label = "UserName", pos = (40, 100), size = (120, 25))        self.serverAddress = wx.TextCtrl(self, pos = (120, 47), size = (150, 25))        self.userName = wx.TextCtrl(self, pos = (120, 97), size = (150, 25))        self.loginButton = wx.Button(self, label = ‘Login‘, pos = (80, 145), size = (130, 30))        self.loginButton.Bind(wx.EVT_BUTTON, self.login)        self.Show()    def login(self, event):        ‘登入處理‘        try:            serverAddress = self.serverAddress.GetLineText(0).split(‘:‘)            con.open(serverAddress[0], port = int(serverAddress[1]), timeout = 10)            response = con.read_some()            if response != ‘Connect Success‘:                self.showDialog(‘Error‘, ‘Connect Fail!‘, (95, 20))                return            con.write(‘login ‘ + str(self.userName.GetLineText(0)) + ‘\n‘)            response = con.read_some()            if response == ‘UserName Empty‘:                self.showDialog(‘Error‘, ‘UserName Empty!‘, (135, 20))            elif response == ‘UserName Exist‘:                self.showDialog(‘Error‘, ‘UserName Exist!‘, (135, 20))            else:                self.Close()                ChatFrame(None, -2, title = ‘ShiYanLou Chat Client‘, size = (500, 350))        except Exception:            self.showDialog(‘Error‘, ‘Connect Fail!‘, (95, 20))    def showDialog(self, title, content, size):        ‘顯示錯誤資訊對話方塊‘        dialog = wx.Dialog(self, title = title, size = size)        dialog.Center()        wx.StaticText(dialog, label = content)        dialog.ShowModal()

2.聊天視窗

聊天視窗中最主要的就是向伺服器發訊息並接受伺服器的訊息，這裡通過子線程來接受，代碼如下：

class ChatFrame(wx.Frame):    """    聊天視窗    """    def __init__(self, parent, id, title, size):        ‘初始化，添加控制項並綁定事件‘        wx.Frame.__init__(self, parent, id, title)        self.SetSize(size)        self.Center()        self.chatFrame = wx.TextCtrl(self, pos = (5, 5), size = (490, 310), style = wx.TE_MULTILINE | wx.TE_READONLY)        self.message = wx.TextCtrl(self, pos = (5, 320), size = (300, 25))        self.sendButton = wx.Button(self, label = "Send", pos = (310, 320), size = (58, 25))        self.usersButton = wx.Button(self, label = "Users", pos = (373, 320), size = (58, 25))        self.closeButton = wx.Button(self, label = "Close", pos = (436, 320), size = (58, 25))        self.sendButton.Bind(wx.EVT_BUTTON, self.send)        self.usersButton.Bind(wx.EVT_BUTTON, self.lookUsers)        self.closeButton.Bind(wx.EVT_BUTTON, self.close)        thread.start_new_thread(self.receive, ())        self.Show()    def send(self, event):        ‘發送訊息‘        message = str(self.message.GetLineText(0)).strip()        if message != ‘‘:            con.write(‘say ‘ + message + ‘\n‘)            self.message.Clear()    def lookUsers(self, event):        ‘查看當前線上使用者‘        con.write(‘look\n‘)    def close(self, event):        ‘關閉視窗‘        con.write(‘logout\n‘)        con.close()        self.Close()    def receive(self):        ‘接受伺服器的訊息‘        while True:            sleep(0.6)            result = con.read_very_eager()            if result != ‘‘:                self.chatFrame.AppendText(result)

3.用戶端完整代碼

#!/usr/bin/python# encoding: utf-8import wximport telnetlibfrom time import sleepimport threadclass LoginFrame(wx.Frame):    """    登入視窗    """    def __init__(self, parent, id, title, size):        ‘初始化，添加控制項並綁定事件‘        wx.Frame.__init__(self, parent, id, title)        self.SetSize(size)        self.Center()        self.serverAddressLabel = wx.StaticText(self, label = "Server Address", pos = (10, 50), size = (120, 25))        self.userNameLabel = wx.StaticText(self, label = "UserName", pos = (40, 100), size = (120, 25))        self.serverAddress = wx.TextCtrl(self, pos = (120, 47), size = (150, 25))        self.userName = wx.TextCtrl(self, pos = (120, 97), size = (150, 25))        self.loginButton = wx.Button(self, label = ‘Login‘, pos = (80, 145), size = (130, 30))        self.loginButton.Bind(wx.EVT_BUTTON, self.login)        self.Show()    def login(self, event):        ‘登入處理‘        try:            serverAddress = self.serverAddress.GetLineText(0).split(‘:‘)            con.open(serverAddress[0], port = int(serverAddress[1]), timeout = 10)            response = con.read_some()            if response != ‘Connect Success‘:                self.showDialog(‘Error‘, ‘Connect Fail!‘, (95, 20))                return            con.write(‘login ‘ + str(self.userName.GetLineText(0)) + ‘\n‘)            response = con.read_some()            if response == ‘UserName Empty‘:                self.showDialog(‘Error‘, ‘UserName Empty!‘, (135, 20))            elif response == ‘UserName Exist‘:                self.showDialog(‘Error‘, ‘UserName Exist!‘, (135, 20))            else:                self.Close()                ChatFrame(None, -2, title = ‘ShiYanLou Chat Client‘, size = (500, 350))        except Exception:            self.showDialog(‘Error‘, ‘Connect Fail!‘, (95, 20))    def showDialog(self, title, content, size):        ‘顯示錯誤資訊對話方塊‘        dialog = wx.Dialog(self, title = title, size = size)        dialog.Center()        wx.StaticText(dialog, label = content)        dialog.ShowModal()class ChatFrame(wx.Frame):    """    聊天視窗    """    def __init__(self, parent, id, title, size):        ‘初始化，添加控制項並綁定事件‘        wx.Frame.__init__(self, parent, id, title)        self.SetSize(size)        self.Center()        self.chatFrame = wx.TextCtrl(self, pos = (5, 5), size = (490, 310), style = wx.TE_MULTILINE | wx.TE_READONLY)        self.message = wx.TextCtrl(self, pos = (5, 320), size = (300, 25))        self.sendButton = wx.Button(self, label = "Send", pos = (310, 320), size = (58, 25))        self.usersButton = wx.Button(self, label = "Users", pos = (373, 320), size = (58, 25))        self.closeButton = wx.Button(self, label = "Close", pos = (436, 320), size = (58, 25))        self.sendButton.Bind(wx.EVT_BUTTON, self.send)        self.usersButton.Bind(wx.EVT_BUTTON, self.lookUsers)        self.closeButton.Bind(wx.EVT_BUTTON, self.close)        thread.start_new_thread(self.receive, ())        self.Show()    def send(self, event):        ‘發送訊息‘        message = str(self.message.GetLineText(0)).strip()        if message != ‘‘:            con.write(‘say ‘ + message + ‘\n‘)            self.message.Clear()    def lookUsers(self, event):        ‘查看當前線上使用者‘        con.write(‘look\n‘)    def close(self, event):        ‘關閉視窗‘        con.write(‘logout\n‘)        con.close()        self.Close()    def receive(self):        ‘接受伺服器的訊息‘        while True:            sleep(0.6)            result = con.read_very_eager()            if result != ‘‘:                self.chatFrame.AppendText(result)‘程式運行‘if __name__ == ‘__main__‘:    app = wx.App()    con = telnetlib.Telnet()    LoginFrame(None, -1, title = "Login", size = (280, 200))    app.MainLoop()

四、小結

最後就可以運行程式進行聊天了，注意需要先啟動伺服器再啟動用戶端。這個項目中使用了asyncore的dispatcher來實現伺服器，asynchat的asyn_chat來維護使用者的串連會話，用wxPython來實現圖形介面，用telnetlib來串連伺服器，在子線程中接受伺服器發來的訊息，由此一個簡單的聊天室程式就完成了。

如何用Python編寫一個聊天室