如何用Python编写一个聊天室

一、课程介绍

1.简介

本次项目课是实现简单聊天室程序的服务器端和客户端。

2.知识点

服务器端涉及到asyncore、asynchat和socket这几个模块，客户端用到了telnetlib、wx、time和thread这几个模块。

3.所需环境

本次课中编写客户端需要用到wxPython，它是一个GUI工具包，请先使用下面的命令安装：

$ sudo apt-get install python-wxtools

密码为shiyanlou

4.项目效果截图

登录窗口

聊天窗口

二、项目实战（服务器端）

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 EndSession

class 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-8

from asyncore import dispatcher

from asynchat import async_chat

import socket, asyncore

PORT = 6666 #端口

class EndSession(Exception):

"""

自定义会话结束时的异常

"""

pass

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)

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 EndSession

class 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

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

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):

"""

登录窗口

这个是很有意思，也简单的话题 。你可以使用twisted, 或者是socket, 实现。 如果想优美些可以用stackless，也可以用greenlet。

最简单的办法是使用内置的httpserver，通过多线程socketserver，和simplehttpserver实现简单的交互。

其实就是做了一个socket服务端，前端使用ajax或者python也都可以实现与socket服务端的交互，关于其详细使用方法，可以参考本人博客，里面详细讲了如何使用socket.

TCP网络应用程序开发流程回顾

Flask聊天进阶(群聊+私聊)

python 网络编程三(网络基础)

---