SocketServer

socket编程过于底层，编程虽然有套路，但是想要写出健壮的代码还是比较困难的，所以很多语言都对socket底层api进行封装，Python的封装就是socketserver模块。它是网络服务编程框架，便于企业级快速开发

类的继承关系

+------------+
| BaseServer |
+------------+
|v
+-----------+       +------------------+
| TCPServer |------->| UnixStreamServer |
+-----------+       +------------------+
|v
+-----------+       +--------------------+
| UDPServer |------->| UnixDatagramServer |
+-----------+       +--------------------+

SocketServer 简化了网络服务器的编写。

他有4个同步类

• TCPServer
• UDPServer
• UnixStreamServer
• UnixDatagramServer

2个Mixin类：ForkingMixin 和ThreadingMixin 类，用来支持异步。由此得到

• class ForkingUDPServer(ForkingMixIn, UDPServer): pass
• class ForkingTCPServer(ForkingMixIn, TCPServer): pass
• class ThreadingUDPServer(ThreadingMixIn, UDPServer): pass
• class ThreadingTCPServer(ThreadingMixIn, TCPServer): pass

fork是创建多进程，thread是创建多线程

fork需要操作系统支持，windows不支持。

编程接口

socketserver.BaseServer(server_address, RequestHandlerClass)

需要提供服务器绑定的地址信息，和用于处理请求的RequestHandlerClass类。

RequestHandlerClass类必须是BaseRequestHandler类的子类，在BaseServer中代码如下：

# BaseServer代码
class BaseServer:
    def __init__(self, server_address, RequestHandlerClass):
        """Constructor. May be extended, do not override.可扩展不可覆盖"""
        self.server_address = server_address
        self.RequestHandlerClass = RequestHandlerClass # 请求处理类
        self.__is_shut_down = threading.Event()
        self.__shutdown_request = False
    def finish_request(self, request, client_address): # 处理请求的方法
        """Finish one request by instantiating RequestHandlerClass."""
        self.RequestHandlerClass(request, client_address, self) # 
RequestHandlerClass构造

BaseRequestHandler类

它是和用户连接的用户请求处理类的基类，定义为：

BaseRequestHandler(request, client_address, server)

服务端Server实例接受用户请求后，最后会实例化这个类。

它被初始化时，送入3个构造参数：request，client_address，server自身

以后就可以在BaseRequestHandler类的实例上使用以下属性：

• self.request 就是和客户端的链接的socket对象
• self.client_address：就是客户端的ip地址和端口
• self.server 是TCPserver实例本身

这个类在初始化的时候，它会依次调用3个方法。子类可以覆盖这些方法。

# BaseRequestHandler要子类覆盖的方法
class BaseRequestHandler:
    def __init__(self, request, client_address, server):
        self.request = request
        self.client_address = client_address
        self.server = server
        self.setup()
        try:
            self.handle()
        finally:
            self.finish()
    def setup(self): # 每一个连接初始化
        pass
    def handle(self): # 每一次请求处理
        pass
    def finish(self): # 每一个连接清理
        pass

测试代码

import threading
import socketserver
class MyHandler(socketserver.BaseRequestHandler):
    def handle(self):
        # super().handle() # 可以不调用，父类handle什么都没有做
        print('-'*30)
        print(self.server) # 服务
        print(self.request) # 服务端负责客户端连接请求的socket对象
        print(self.client_address) # 客户端地址
        print(self.__dict__)
        print(self.server.__dict__) # 能看到负责accept的socket
        print(threading.enumerate())
        print(threading.current_thread())
        print('-'*30)
addr = ('192.168.142.1', 9999)
server = socketserver.ThreadingTCPServer(addr, MyHandler) # 注意参数是
MyHandler类
#server.handle_request() # 一次性
server.serve_forever() # 永久循环执行

测试结果说明，handle方法相当于socket的recv方法。

每个不同的连接上的请求过来后，生成这个链接的socket对象即self.request，客户端地址是self.client_address

问题

测试过程中，上面代码，连接后立即断开了，为什么？

怎样才能客户端和服务器端长时间连接？

import threading
import socketserver
import logging
FORMAT = "%(asctime)s %(threadName)s %(thread)d %(message)s"
logging.basicConfig(format=FORMAT, level=logging.INFO)
class MyHandler(socketserver.BaseRequestHandler):
    def handle(self):
        # super().handle() # 可以不调用，父类handle什么都没有做
        print('-'*30)
        print(self.server) # 服务
        print(self.request) # 服务端负责客户端连接请求的socket对象
        print(self.client_address) # 客户端地址
        print(self.__dict__)
        print(self.server.__dict__) # 能看到负责accept的
        print(threading.enumerate())
        print(threading.current_thread())
        print('-'*30)
        for i in range(3):
            data = self.request.recv(1024)
            logging.info(data)
        logging.info('====end====')
addr = ('192.168.142.1', 9999)
server = socketserver.ThreadingTCPServer(addr, MyHandler)
server.serve_forever() # 永久

将ThreadingTCPServer换成TCPServer，同时连接2个客户端观察效果。

ThreadingTCPServer是异步的，可以同时处理多个连接。

TCPServer是同步的，一个连接处理完了，即一个连接的handle方法执行完了，才能处理另一个连接，且只有主线程

总结：

创建服务器需要几个步骤：

1. 从BaseRequestHandler类派生出子类，并覆盖其handle()方法来创建请求处理程序类，此方法将处理传入请求。
2. 实例化一个服务器类，传参服务器的地址和请求处理类
3. 调用服务器实例的handle_request()或serve_forever()方法
4. 调用server_close()关闭套接字

实现EchoServer

顾名思义，Echo，来什么消息回显什么消息

客户端发来什么信息，返回什么信息

import threading
import socketserver
class Handler(socketserver.BaseRequestHandler):
    def setup(self):
        super().setup()
        self.event = threading.Event()
    def finish(self):
        super().finish()
        self.event.set()
    def handle(self):
        super().handle()
        print('-' * 30)
        while not self.event.is_set():
            data = self.request.recv(1024).decode()
            print(data)
            msg = '{} {}'.format(self.client_address, data).encode()
            self.request.send(msg)
server = socketserver.ThreadingTCPServer(('127.0.0.1', 9999), Handler)
print(server)
threading.Thread(target=server.serve_forever, name='EchoServer', 
daemon=True).start()
while True:
    cmd = input('>>')
    if cmd == 'quit':
        server.server_close()
        break
    print(threading.enumerate())

总结

为每一个连接提供RequestHandlerClass类实例，依次调用setup、handle、finish方法，且使用了try…finally结构保证finish方法一定能被调用。这些方法依次执行完成，如果想维持这个连接和客户端通信，就需要在handle函数中使用循环。

socketserver模块提供的不同的类，但是编程接口是一样的，即使是多进程、多线程的类也是一样，大大减少了编程的难度。

将socket编程简化，只需要程序员关注数据处理本身，实现Handler类就行了。这种风格在Python十分常见。

作业

用SocketServer来改写ChatServer

import datetime
import  threading
import socketserver
import logging
logging.basicConfig(level=logging.INFO, format="%(asctime)s %(thread)d %(message)s")

class MySocket(socketserver.BaseRequestHandler):
    socketDict = {}
    def setup(self) -> None:
        super().setup()
        self.event = threading.Event()
    def handle(self) -> None:
        print(self.server)
        print(self.client_address)
        print(self.request)
        while not self.event.is_set():
            data = self.request.recv(1024)
            print(data)
            self.socketDict[self.client_address] = self.request
            if data == b'quit' or data == b'':
                logging.info("{} is quit".format(self.client_address))
                break
            msg = "{:%Y/%m/%d %H:%M:%S} {}:{}  DATA={}".format(datetime.datetime.now(),*self.client_address,data)
            for n in self.socketDict.values():
                n.send(msg.encode())

    def finish(self) -> None:
        self.socketDict.pop(self.client_address)
        super().finish()
        self.event.set()

class ChatServer:
    def __init__(self,ip='127.0.0.1',port=9999):
        self.server = socketserver.ThreadingTCPServer((ip,port),MySocket)
        self.server.daemon_threads = True
    def start(self):
        threading.Thread(target=self.server.serve_forever,name='chatserver').start()
    def stop(self):
        self.server.server_close()
if __name__ == '__main__':
    cs = ChatServer()
    cs.start()