使用Python SocketServer快速实现多线程网络服务器

Python SocketServer使用介绍

1、简介：

         SocketServer是python的一个网络服务器框架，可以减少开发人员编写网络服务器程序的工作量。

SocketServer总共有4个server基类。

TCPServer：负责处理TCP协议。

UDPServer：负责处理UDP协议。

UnixStreamServer：只适用于类unix平台，不常用。

UnixDatagramServer：只适用于类unix平台，不常用。

这4个类会同步处理每一个request，也就是说只有当前的request处理完才会处理下一个request，这种方式显然很不合理，如果当前的request处理过慢的话就会导致“堵塞”。正确的处理方式应该是开辟新的进程或线程去处理不同的request，通过混合继承ForkingMixIn或ThreadingMixIn类即可解决此问题。

2、创建SocketServer

         使用SocketServer创建一个网络服务程序只需要几个简单的步骤：

（1）、创建处理request的类，创建方法为：继承BaseRequestHandler类，并重载handle()方法。该方法将被回调用做处理当前接收到的request。

注意：一般的做法是直接继承StreamRequestHandler或者DatagramRequestHandler。比如：

class MyTCPHandler(SocketServer.StreamRequestHandler):

（2）、实例化一个server基类（比如TCPServer）的对象，并发服务器地址和处理request的类作为参数传入。

（3）、使用server基类对象调用handle_request()或serve_forever()方法，即可处理一个或多个request。

（4）、如果需要创建多进程或多线程的服务器程序，则可以通过混合继承ForkingMixIn或ThreadingMixIn类来实现，比如：

class ThreadingTCPServer(ThreadingMixIn, TCPServer): pass //创建一个多线程的TCP服务器。

注意：ThreadingMixIn必须要放在TCPServer前面。

3、server类方法说明：

（1）、class SocketServer.BaseServer

         这是所有类的超类，只定义接口，大部分均在子类中实现。

（2）、BaseServer.handle_request()

         该方法用于处理单一的request。按顺序调用get_request(), verify_request()和   process_request().

（3）、BaseServer.serve_forever(poll_interval=0.5)

                  循环轮询处理request

（4）、BaseServer.address_family

         协议簇信息，比如socket.AF_INET and socket.AF_UNIX

（5）、BaseServer.RequestHandlerClass

         开发者自定义的用于处理request的类，每个request都会对应实例化一个request handle       类进行处理。

（6）、BaseServer.server_address

         服务器要监听的地址和端口的二元组，比如(0.0.0.0,8080)

（7）、BaseServer.finish_request()

         实例化开发者自定义request handle类，然后调用handle()方法处理当前的request。

（8）、

4、request handler类方法说明：

         由用户自定义并传入SocketServer，由server类实例化来处理当前的request。需要注意的是：Request handler类必须要复写handle()方法，其它方法也可以复写，但不做强制。

（1）、RequestHandler.handle()

         开发者必须在此方法里面实现对当前request的所有处理，在该方法里面有几个实例化的属性可以直接使用：self.request代表当前的request对象，self.client_address代表客户端地址，self.server代表服务器对象。对于TCP链接，self.request是当前request的socket。self.rfile和self.wfile可分别用于读取客户端数据和向客户端返回数据。

5、样例代码：

5.1、创建TCP类型的SocketServer：

import SocketServer
class MyTCPHandler(SocketServer.BaseRequestHandler): #定义request handler类，从BaseRequestHandler类继承

    def handle(self): #复写handle()方法，注意：该方法必须复写，用于处理当前的request
        self.data = self.request.recv(1024).strip() #self.request是和客户端连接的套接字，可直接使用
        print "{} wrote:".format(self.client_address[0])
        print self.data
        self.request.sendall(self.data.upper())

class MyTCPHandler(SocketServer.StreamRequestHandler): #定义request handler类，从StreamRequestHandler类继承

    def handle(self):
        self.data = self.rfile.readline().strip() #self.rfile/self.wfile是文件格式类型的socket，相当于对原始socket的封装，让读写网络数据向读写文件一样容易
        print "{} wrote:".format(self.client_address[0])
        print self.data
        self.wfile.write(self.data.upper())     

if __name__ == "__main__":
    HOST, PORT = "localhost", 9999
    server = SocketServer.TCPServer((HOST, PORT), MyTCPHandler) #传入监听地址、端口号和request handler类
    server.serve_forever() #启动监听处理request

 

5.2、创建UDP类型的SocketServer：

 

import SocketServer

class MyUDPHandler(SocketServer.BaseRequestHandler):
    def handle(self):
        data = self.request[0].strip()
        socket = self.request[1]
        print "{} wrote:".format(self.client_address[0])
        print data
        socket.sendto(data.upper(), self.client_address)
if __name__ == "__main__":
    HOST, PORT = "localhost", 9999
    server = SocketServer.UDPServer((HOST, PORT), MyUDPHandler)
server.serve_forever()

 

 

 

5.3、创建多线程类型的TCP SocketServer：

import socket
import threading
import SocketServer
class ThreadedTCPRequestHandler(SocketServer.BaseRequestHandler):
    def handle(self):
        data = self.request.recv(1024)
        cur_thread = threading.current_thread()
        response = "{}: {}".format(cur_thread.name, data)
        self.request.sendall(response)

class ThreadedTCPServer(SocketServer.ThreadingMixIn, SocketServer.TCPServer):#继承ThreadingMixIn表示使用多线程处理request，注意这两个类的继承顺序不能变
    pass

def client(ip, port, message):
    sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
    sock.connect((ip, port))
    try:
        sock.sendall(message)
        response = sock.recv(1024)
        print "Received: {}".format(response)
    finally:
        sock.close()

if __name__ == "__main__":
    HOST, PORT = "localhost", 0
    server = ThreadedTCPServer((HOST, PORT), ThreadedTCPRequestHandler)
    ip, port = server.server_address
    server_thread = threading.Thread(target=server.serve_forever)
    server_thread.daemon = True
    server_thread.start()
    print "Server loop running in thread:", server_thread.name
    client(ip, port, "Hello World 1")
    client(ip, port, "Hello World 2")
    client(ip, port, "Hello World 3")
    server.shutdown()

 

执行结果：