python应用系列教程——python使用SocketServer实现网络服务器，socket实现客户端

全栈工程师开发手册 （作者：栾鹏）
python教程全解

---

python使用SocketServer实现网络服务器

SocketServer简化了网络服务器的编写。在进行socket创建时，使用SocketServer会大大减少创建的步骤，并且SocketServer使用了select它有4个类：TCPServer，UDPServer，UnixStreamServer，UnixDatagramServer。这4个类是同步进行处理的，另外通过ForkingMixIn和ThreadingMixIn类来支持异步。

使用SocketServer的步骤简介

1. 创建服务器的步骤。首先，你必须创建一个请求处理类，它是BaseRequestHandler的子类并重载其handle()方法。

2. 实例化一个服务器类，传入服务器的地址和请求处理程序类。

3. 最后，调用handle_request()(一般是调用其他事件循环或者使用select())或serve_forever()。

集成ThreadingMixIn类时需要处理异常关闭。daemon_threads指示服务器是否要等待线程终止，要是线程互相独立，必须要设置为True，默认是False。

无论用什么网络协议，服务器类有相同的外部方法和属性。

测试案例

服务器端为一个时间戳服务器，在接收到客户端发来的数据后，自动回复。

客户端，等待用户输入，回车后向服务器发送用户输入的内容。

分别在python2.7和python3.6下测试。在启动时需要先启动服务器端，在启动客户端。

python2.7下

服务器端代码为

#coding:utf-8

import SocketServer
from time import ctime

print("=====================SocketServer TCP服务器=====================");

HOST = ''  #主机号为空白表示可以使用任何可用的地址。
PORT = 21567  #端口号
ADDR = (HOST, PORT)

class MyRequestHandler(SocketServer.StreamRequestHandler):  #StreamRequestHandler实现TCP/UDP服务器的服务处理器
    def handle(self):  #重写接收响应函数
        print('...connect from:', self.client_address)
        data = self.rfile.readline().strip()
        print(data)
        self.wfile.write('[%s] %s' % (ctime(), data))

tcpSerSock = SocketServer.TCPServer(ADDR, MyRequestHandler)
print('等待连接...')
tcpSerSock.serve_forever()

客户端代码为

#coding:utf-8

from socket import *

print("=====================SocketServer TCP客户端=====================");

HOST = '127.0.0.1'  #本机测试
PORT = 21567
BUFSIZ = 1024
ADDR = (HOST, PORT)

while True:
    tcpCliSock = socket(AF_INET, SOCK_STREAM)   #创建客户端套接字
    tcpCliSock.connect(ADDR)   #发起TCP连接
    data = raw_input('> ')  #接收用户输入
    if not data:   #如果用户输入为空，直接回车就会发送""，""就是代表false
        break
    tcpCliSock.send(data+'\n')   #客户端发送消息，必须发送字节数组
    data = tcpCliSock.recv(BUFSIZ)  #接收回应消息，接收到的是字节数组
    if not data:   #如果接收服务器信息失败，或响应消息为空
        break
    print(data)   #打印回应消息
    tcpCliSock.close() #关闭客户端socket

python3.6下

SocketServer模块在python3中已经更名为socketserver。

服务器端代码为

#coding:utf-8

import socketserver
from time import ctime

print("=====================SocketServer TCP服务器=====================");

HOST = ''  #主机号为空白表示可以使用任何可用的地址。
PORT = 21567  #端口号
ADDR = (HOST, PORT)

class MyRequestHandler(socketserver.StreamRequestHandler):  #StreamRequestHandler实现TCP/UDP服务器的服务处理器
    def handle(self):  #重写接收响应函数
        print('连接到:', self.client_address)
        data = self.rfile.readline().strip()
        print(data)
        self.wfile.write(bytes('[%s] %s' % (ctime(), data.decode('utf-8')),'utf-8'))

tcpSerSock = socketserver.TCPServer(ADDR, MyRequestHandler)
print('等待连接...')
tcpSerSock.serve_forever()

客户端代码为

#coding:utf-8

from socket import *

print("=====================SocketServer TCP客户端=====================");

HOST = '127.0.0.1'  #本机测试
PORT = 21567
BUFSIZ = 1024
ADDR = (HOST, PORT)

while True:
    tcpCliSock = socket(AF_INET, SOCK_STREAM)   #创建客户端套接字
    tcpCliSock.connect(ADDR)   #发起TCP连接
    data = input('> ')  #接收用户输入
    if not data:   #如果用户输入为空，直接回车就会发送""，""就是代表false
        break
    tcpCliSock.send(bytes(data+'\n','utf-8'))   #客户端发送消息，必须发送字节数组
    buffer = tcpCliSock.recv(BUFSIZ)  #接收回应消息，接收到的是字节数组
    if not buffer:   #如果接收服务器信息失败，或响应消息为空
        break
    print(str(buffer,'utf-8'))   #打印回应消息
    tcpCliSock.close() #关闭客户端socket

服务器类型

5种类型：BaseServer，TCPServer，UnixStreamServer，UDPServer，UnixDatagramServer。 注意：BaseServer不直接对外服务。

服务器对象

•class SocketServer.BaseServer：这是模块中的所有服务器对象的超类。它定义了接口，如下所述，但是大多数的方法不实现，在子类中进行细化。

•BaseServer.fileno()：返回服务器监听套接字的整数文件描述符。通常用来传递给select.select(), 以允许一个进程监视多个服务器。

•BaseServer.handle_request()：处理单个请求。处理顺序：get_request(), verify_request(), process_request()。如果用户提供handle()方法抛出异常，将调用服务器的handle_error()方法。如果self.timeout内没有请求收到， 将调用handle_timeout()并返回handle_request()。

•BaseServer.serve_forever(poll_interval=0.5): 处理请求，直到一个明确的shutdown()请求。每poll_interval秒轮询一次shutdown。忽略self.timeout。如果你需要做周期性的任务，建议放置在其他线程。

•BaseServer.shutdown()：告诉serve_forever()循环停止并等待其停止。python2.6版本。

•BaseServer.address_family: 地址家族，比如socket.AF_INET和socket.AF_UNIX。

•BaseServer.RequestHandlerClass：用户提供的请求处理类，这个类为每个请求创建实例。

•BaseServer.server_address：服务器侦听的地址。格式根据协议家族地址的各不相同，请参阅socket模块的文档。

•BaseServer.socketSocket：服务器上侦听传入的请求socket对象的服务器。

服务器类支持下面的类变量：

•BaseServer.allow_reuse_address：服务器是否允许地址的重用。默认为false ，并且可在子类中更改。

•BaseServer.request_queue_size

请求队列的大小。如果单个请求需要很长的时间来处理，服务器忙时请求被放置到队列中，最多可以放request_queue_size个。一旦队列已满，来自客户端的请求将得到 “Connection denied”错误。默认值通常为5 ，但可以被子类覆盖。

•BaseServer.socket_type：服务器使用的套接字类型; socket.SOCK_STREAM和socket.SOCK_DGRAM等。

•BaseServer.timeout：超时时间，以秒为单位，或 None表示没有超时。如果handle_request()在timeout内没有收到请求，将调用handle_timeout()。

下面方法可以被子类重载，它们对服务器对象的外部用户没有影响。

•BaseServer.finish_request()：实际处理RequestHandlerClass发起的请求并调用其handle()方法。 常用。

•BaseServer.get_request()：接受socket请求，并返回二元组包含要用于与客户端通信的新socket对象，以及客户端的地址。

•BaseServer.handle_error(request, client_address)：如果RequestHandlerClass的handle()方法抛出异常时调用。默认操作是打印traceback到标准输出，并继续处理其他请求。

•BaseServer.handle_timeout()：超时处理。默认对于forking服务器是收集退出的子进程状态，threading服务器则什么都不做。

•BaseServer.process_request(request, client_address) :调用finish_request()创建RequestHandlerClass的实例。如果需要，此功能可以创建新的进程或线程来处理请求,ForkingMixIn和ThreadingMixIn类做到这点。常用。

•BaseServer.server_activate()：通过服务器的构造函数来激活服务器。默认的行为只是监听服务器套接字。可重载。

•BaseServer.server_bind()：通过服务器的构造函数中调用绑定socket到所需的地址。可重载。

•BaseServer.verify_request(request, client_address)：返回一个布尔值，如果该值为True ，则该请求将被处理，反之请求将被拒绝。此功能可以重写来实现对服务器的访问控制。默认的实现始终返回True。client_address可以限定客户端，比如只处理指定ip区间的请求。 常用。

请求处理器

处理器接收数据并决定如何操作。它负责在socket层之上实现协议（i.e., HTTP, XML-RPC, or AMQP)，读取数据，处理并写反应。可以重载的方法如下：

•setup(): 准备请求处理. 默认什么都不做，StreamRequestHandler中会创建文件类似的对象以读写socket.

•handle(): 处理请求。解析传入的请求，处理数据，并发送响应。默认什么都不做。常用变量：self.request，self.client_address，self.server。

•finish(): 环境清理。默认什么都不做，如果setup产生异常，不会执行finish。

通常只需要重载handle。self.request的类型和数据报或流的服务不同。对于流服务，self.request是socket 对象；对于数据报服务，self.request是字符串和socket 。可以在子类StreamRequestHandler或DatagramRequestHandler中重载，重写setup()和finish() ，并提供self.rfile和self.wfile属性。 self.rfile和self.wfile可以读取或写入，以获得请求数据或将数据返回到客户端。