模块的选择:
使用 asyncore 和 asynchat 模块,实现 多客户端的接入 和 服务器、客户端之间消息的传递。
几个类及各自的功能:
EndSession:异常类,用于产生异常退出
CommandHandler:消息分类处理,区分 命令消息 和 聊天消息
Room:进行用户的会话管理,比如保持房间内所有用户的会话、用户进入房间、退出房间、退出服务器、向其他用户发送消息
Hall:大厅。输入昵称登陆、退出服务器、选择聊天室
ChatRoom:聊天室。进入聊天室、查看聊天室在线用户、广播消息、返回大厅
ChatSession:为每一个用户会话创建实例,保持用户昵称,处理服务器与客户端的消息传递
Server:服务器。启动的同时,创建 大厅、三个聊天室,侦探、接受用户的接入请求,字典形式保存所有登陆服务器的用户的 会话:昵称。
服务器运行:
创建一个 Server类 作为服务器,继承 asyncore.dispatcher ,程序运行时,创建 实例对象 ,初始化服务器、侦听用户的服务请求,同时实例化 大厅、三个聊天室。
host = 'localhost'
port = 5000
if __name__ == '__main__':
s = Server(port, host)
asyncore.loop()
class Server(asyncore.dispatcher):
def __init__(self, port, host):
asyncore.dispatcher.__init__(self)
self.create_socket(socket.AF_INET, socket.SOCK_STREAM)
self.set_reuse_addr()
self.bind((host, port))
self.listen(5)
self.users = {}
self.hall = Hall(self, 'Hall')
self.python = ChatRoom(self, 'python')
self.write = ChatRoom(self, 'write')
self.pm = ChatRoom(self, 'pm')
接受用户接入请求:
Server类 的 handle_accept方法,接收用户接入请求,为每个用户创建一个 socket对象,表示用户。并为每一个 socket对象调用 ChatSession类 创建实例。
class Server(asyncore.dispatcher):
def handle_accept(self):
conn,addr = self.accept()
ChatSession(self, conn)
class ChatSession(asynchat.async_chat):
def __init__(self, server, sock):
asynchat.async_chat.__init__(self, sock)
self.set_terminator('\r\n')
self.data = []
self.client_name = ''
用户登录、退出:
用户在大厅、三个聊天室直接的切换,通过 ChatSession类 的 enter方法 完成。
class ChatSession(asynchat.async_chat):
def enter(self, room):
''' 更改用户所在的房间,并将 用户的会话 添加到 房间的session列表 '''
self.room = room room.add(self) # 将新 session 添加到 hall 的 sessions 列表
对消息的处理:
ChatSession类 的 collectincomingdata方法,缓存从用户接收到的消息,found_terminator方法 将消息发送给 用户所在房间的 room.handle方法进行处理,也就是继承自 CommandHandler 的 handle方法。
handle方法 约定,以\开头的是命令,其他是普通聊天消息,命令对应的类方法以do_开头。
如果消息是以\开头,通过 getattr 方法检查所在房间是否有对应的do_方法,如果有,执行,否则,提示命令未知。
而对于普通的聊天消息,默认通过do_broadcast方法广播给聊天室其他用户。
class ChatSession(asynchat.async_chat):
def collect_incoming_data(self, data):
'''
缓存从用户收到的数据
'''
self.data.append(data)
def found_terminator(self):
'''
将 从用户接收到的消息 发给 房间的消息处理函数 进行处理
'''
line = ''.join(self.data) # 将所有发来的消息放入 line 中
self.data = []
try:
self.room.handle(self, line) #对当前所在房间的方法进行查找,判断是否是命令
except EndSession:
self.handle_close() #如果不是,调用退出房间的方法
class Room(CommandHandler):
class CommandHandler:
def handle(self, session, line):
if not line: return
parts = line.split(' ', 1)
if parts[0][0] == '/': # 检查是否命令,命令格式:/cmd
cmd = parts[0][1:]
try:
line = parts[1].strip()
except IndexError:
line = None
meth = getattr(self, 'do_'+cmd, None)
try:
meth(session, line)
except TypeError:
self.unknow(session, cmd)
else: # 对于普通的聊天信息,默认直接调用 'do_broadcast' 方法广播给房间内其他人
meth = getattr(self, 'do_broadcast', line)
try:
meth(session, line)
except TypeError:
self.unknow(session, line)
def unknow(self, session, cmd):
'''
当找不到相应的命令时,进行提示
'''
session.send('Unknow command: %s\r\n' % cmd)
class Hall(Room):
def do_login(self, session, line):
'''
对用户输入的昵称处理。
给出帮助信息。
'''
def do_logout(self, session, line):
'''
用户退出连接
'''
def do_python(self, session, line):
'''
进入聊天室 python
'''
def do_write(self, session, line):
session.enter(self.server.write)
def do_pm(self):
session.enter(self.server.pm)
def do_help(self, session, line):
'''
发送帮助信息
'''
class ChatRoom(Room):
def do_online(self, session, line):
'''
查看房间内有哪些其他用户
'''
def do_back(self, session, line):
'''
退回到大厅
'''
def do_broadcast(self, session, line):
'''
广播消息给房间内其他所有人
'''
def do_help(self, session, line):
完整代码仓库
项目wiki