Python Socket 编程：聊天室示例程序
上一篇 我们学习了简单的 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，表示这些文件有事件到达。下面的简单程序是表示等待从标准输入中获得输入：
| 123 | 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 有数据到达：
| 12345678910111213141516171819202122 | import socketimport 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 ) |
好了，有了上面的基础，我们就可以来设计聊天室的服务器和客户端了。
聊天室服务器
聊天室服务器主要完成下面两件事：
- 接收多个客户端的连接
- 从每个客户端读入消息病广播到其它连接的客户端
我们定义一个 list 型变量 CONNECTION_LIST 表示监听多个 socket 事件的可读事件，那么利用上面介绍的我们的服务器使用 select 来处理多路复用 I/O 的代码如下：
| 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）一个个发送出去：
| 12345678910 | 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) |
如果发送失败，我们假设某个客户端已经断开了连接，关闭该 socket 病将其从连接列表中删除。
完整的聊天室服务器源代码如下：
好了，有了上面的基础，我们就可以来设计聊天室的服务器和客户端了。
聊天室服务器
聊天室服务器主要完成下面两件事：
- 接收多个客户端的连接
- 从每个客户端读入消息病广播到其它连接的客户端
我们定义一个 list 型变量 CONNECTION_LIST 表示监听多个 socket 事件的可读事件，那么利用上面介绍的我们的服务器使用 select 来处理多路复用 I/O 的代码如下：
| 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）一个个发送出去：
| 12345678910 | 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) |
如果发送失败，我们假设某个客户端已经断开了连接，关闭该 socket 病将其从连接列表中删除。
完整的聊天室服务器源代码如下：
| 12345678910111213141516171819202122232425262728293031323334353637383940414243riped-num\” data-line=\”crayon-5812b0b241f5e056978561-44\”>444546474849505152535455565758596061626364656667686970 | # Tcp Chat server import socket, select #Function to broadcast chat messages to all connected clientsdef broadcast_data (sock, message): #Do not send the message to master socket and the client who has send us the message |