Python SocketServer源码分析（二）

BaseServer 和 BaseRequestHandler是网络处理的两个基类。实际应用中，网络操作更多是使用 TCP 或 HTTP 协议。SocketServer.py 也提供了更高级的TCP、UDP封装。下面就来看下关于TCP方面的网络模块（UDP和TCP的在代码组织上差别不是特别大，暂且忽略）。

TCPServer

TCPServer 继承了BaseServer，初始化的时候，进行了socket套接字的创建。

def __init__(self, server_address, RequestHandlerClass, bind_and_activate=True):
    BaseServer.__init__(self, server_address, RequestHandlerClass)
    self.socket = socket.socket(self.address_family,
                                self.socket_type)
    if bind_and_activate:
        self.server_bind()
        self.server_activate()

__init__ 方法通过 socket模块创建了socket对象，然后进行调用server_bind和server_activate。

server_bind

def server_bind(self):
    if self.allow_reuse_address:
        self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
    self.socket.bind(self.server_address)
    self.server_address = self.socket.getsockname()

server_bind 方法进行socket对象的bind操作，以及设置socket相关属性，如网络地址的复用。

server_activate

def server_activate(self):
    self.socket.listen(self.request_queue_size)

server_activate 方法也比较简单，添加socket对象的listen。

get_request

该类最重要的方法就是 get_request。该方法进行返回socket对象的请求连接。

    def get_request(self):
    """Get the request and client address from the socket.
    """
    return self.socket.accept()

get_request方法是在BaseServer基类中的_handle_request_noblock中调用，从那里里传入套接字对象获取的连接信息。如果是UDPServer，这里获取的就是UDP连接。

此外，TCPServer还提供了一个 fileno 方法，提供给基类的select调用返回文件描述符。

StreamRequestHandler

TCPServer实现了使用tcp套接字的网络服务，Handler方面则是对应的StreamRequestHandler。它继承了BaseRequestHandler。基类的setup方法和finish方法被它重写，用于通过连接实现缓存文件的读写操作。

setup方法


def setup(self):
    self.connection = self.request
    if self.timeout is not None:
        self.connection.settimeout(self.timeout)
    if self.disable_nagle_algorithm:
        self.connection.setsockopt(socket.IPPROTO_TCP,
                                   socket.TCP_NODELAY, True)
    self.rfile = self.connection.makefile('rb', self.rbufsize)
    self.wfile = self.connection.makefile('wb', self.wbufsize)

setup判断了是否使用nagle算法。然后设置对应的连接属性。最重要的就是创建了一个可读（rfile）和一个可写（wfile）的“文件”对象，他们实际上并不是创建了文件，而是封装了读取数据和发送数据的操作，抽象成为对文件的操作。可以理解为 self.rfile 就是读取客户端数据的对象，它有一些方法可以读取数据。self.wfile则是用来发送数据给客户端的对象。后面的操作，客户端数据到来会被写入缓冲区可读，需要向客户端发送数据的时候，只需要向可写的文件中write数据即可。

实现TCP服务需要使用TCPServer和StreamRequestHandler共同协作。大致函数调用流程如下，函数调用用括号表示，赋值不带括号，没有类前缀的表示系统调用：


TCPServer - StreamRequestHandler

__init__(server_address, RequestHandlerClass): 
    BaseServer.server_address
    BaseServer.RequestHandlerClass
    
    TCPServer.socket = socket.socket(self.address_family, self.socket_type)
    TCPServer.server_bind()
    TCPServer.server_activate()

serve_forever(): 

    select() 

    BaseServer._handle_request_noblock()

        TCPServer.get_request() -> request, client_addres
            socket.accept()

        BaseServer.verify_request()

            BaseServer.process_request()

                BaseServer.process_request()

                    BaseServer.finish_request(request, client_address)

                        BaseServer.RequestHandlerClass()

                            BaseRequestHandler.__init__(request)
            
                                BaseRequestHandler.request
                                BaseRequestHandler.client_address = client_address

                                StreamRequestHandler.setup()

                                    StreamRequestHandler.connection = StreamRequestHandler.request
                                    StreamRequestHandler.rfile
                                    StreamRequestHandler.wfile

                                BaseRequestHandler.handle()

                                StreamRequestHandler.finsih()
                                    StreamRequestHandler.wfile.close()
                                    StreamRequestHandler.rfile.close()

                    BaseServer.shutdown_request(request)
                        TCPServer.shutdown()
                            request.shutdown()
                        TCPServer.close_request(request)
                            request.close()

            TCPServer.shutdown_request(request)
                TCPServer.shutdown(request)
                    request.shutdown()
                TCPServer.close_request(request)
                    request.close()

Python SocketServer.py 源码分析（二）