SocketServer-CSDN博客

本文链接：https://blog.csdn.net/haihaihai2232/article/details/92845998

SocketServer

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

类的继承关系

BaseServer -> TCPServer (下有UnixStreamServer)->UDPServer(UnixdatagramServer)

SocketServer 简化了网络服务器的编写
它有四个同步类:

TCPServer
UDPServer
UnixStramServer
UnixDatagramserver
2个Mixin类: ForkingMixIn 和ThreadingMixin类, 用来支持异步. 由此得到
class Forking UDPServer(ForkingMixIn, UDPSerer): pass
class ForkingTCPsever(ThreadingMixInm TCPSever):pass
class Threading UDPServer(threadingMixIn, UDPSerer):pass
class Threading TCPsever(ForkingMixInm TCPSever):pass

fork 是创建多进程, thread是创建多线程
fork需要操作系统支持, Windows不支持

编程接口

socketserver.BaseServer(server_address, RequesHandlerClass)

需要提供服务器绑定的地址信息, 和用于处理请求的RequestHandlerClass类
RequestHandlerClass类必须是BaseRequestHandler类的子类,在BaseServer中代码如下:

#BaseServer代码
  def __init__(self, server_address, RequestHandlerClass):
    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):
    self.RequestHandlerClass(request, client_address, self)

BaseRequestHandler类

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

BaseRequestHandler(request, client_address, server)

服务端Server实例(就是服务端的socket)接收用户请求后, 最后实例化这个类.
他被初始化时, 送入3个构造参数:request, client_address,server自身
以后就可以在BaseRequestHandler类的实例上使用一下属性:

self.request 是和客户端的连接的socket对象(即accept返回的newsocket)
self.server是TCPserver实例本身(就是服务端配置好的socket对象)
self.client_address是客户端地址

这个类在实例化的时候, 它会依次调用3个方法. 子类可以覆盖这些方法.

## 子类要覆盖的方法
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 socketserver
import threading

class MyHandler(socketserver.BaseRequestHandler):

    def handler(self):
        #super().handle() #可以不调用, 父类的handler什么都没做
        print("-" * 20)
        print(self.server)  # 服务
        print(self.request) # 服务端负责分配客户端连接请求的socket对象
        print(self.client_address)  # 客户端地址
        print(self.__dict__)
        print(self.server.__dict__)  # 能看到负责accept的socket

addr = ('127.0.0.1', 9999)

server = socketserver.ThreadingTCPServer(addr, MyHandler)  # 注意参数是MyHandler类

server.serve_forever()  ## 永久循环执行

测试结果说明, handler
方法相当于socket的recv方法.
每个不同的连接的请求过来后, 生成这个连接的socket对象即self.request, 客户端地址是self.client_address

问题:
测试过程中, 上面代码,连接后理解断开了, 为什么?
怎么样才能客户端和服务器端长时间连接?

import socketserver
import threading
import logging

class MyHandler(socketserver.BaseRequestHandler):

    def handler(self):
        #super().handle() #可以不调用, 父类的handler什么都没做
        print("-" * 20)
        print(self.server)  # 服务
        print(self.request) # 服务端负责分配客户端连接请求的socket对象
        print(self.client_address)  # 客户端地址
        print(self.__dict__)
        print(self.server.__dict__)  # 能看到负责accept的socket
        print(self.request.recv)

        print(threading.enumerate())
        print(threading.current_thread())

        print('-' * 30)
        for i in range(30):
            data = self.request.recv(1024)
            logging.info(data)
        logging.info('=====ending========')


addr = ('127.0.0.1', 9999)

server = socketserver.ThreadingTCPServer(addr, MyHandler)  # 注意参数是MyHandler类

server.serve_forever()  ## 永久循环执行

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

ThreadingTCPServer是异步的, 可以同时处理多个连接.

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

总结:
创建服务器需要几个步骤

从BaseRequestHandler类派生子类, 并覆盖其handler()方法创建请求处理程序类, 此方法将处理传入请求.
实例化一个服务器类, 传参服务器的地址和请求处理类
调用服务器实例的handler_request()或server_forever()方法
调用server_close()关闭套接字

setup 写一些处理前需要做的事情, 添加实例属性等.
handle 数据处理的地方
finish 结束需要做的事情, 释放占用的资源. 源码中使用了finally语句, finish里的必定执行.

基类源码保证了即使异常, 也能执行finish方法. 但不代表不应该不捕获客户端各种异常.

注意: 此程序线程不安全

总结

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

socketserver模块提供了不同的类, 但是编程接口是一样的, 即使是多线程, 多进程的类也是一样的, 大大减少了编程的难度.
将socket编程简化, 只需要程序员关注数据处理本身, 实现Handler类就行了. 这种风格在Python十分常见.