一:socketserver简化了网络服务器的编写。
它有4个类:TCPServer,UDPServer,UnixStreamServer,UnixDatagramServer。
这4个类是同步进行处理的,另外通过ForkingMixIn和ThreadingMixIn类来支持异步
class socketserver.
TCPServer
(server_address, RequestHandlerClass, bind_and_activate=True)
class socketserver.
UDPServer
(server_address, RequestHandlerClass, bind_and_activate=True)
class socketserver.
UnixStreamServer
(server_address, RequestHandlerClass, bind_and_activate=True)
class socketserver.
UnixDatagramServer
(server_address, RequestHandlerClass,bind_and_activate=True)
class socketserver.
ForkingTCPServer
class socketserver.
ForkingUDPServer
class socketserver.
ThreadingTCPServer
class socketserver.
ThreadingUDPServer
二:有五个类之间的继承关系
+------------+
| BaseServer |
+------------+
|
v
+-----------+ +------------------+
| TCPServer |------->| UnixStreamServer |
+-----------+ +------------------+
|
v
+-----------+ +--------------------+
| UDPServer |------->| UnixDatagramServer |
+-----------+ +--------------------+
UnixStreamServer 继承-TCPServer继承BaseServer
UnixDatagramServer 继承UDPServer继承TCPServer继承BaseServer
三:使用步骤
1)你必须自己创建一个请求类,并继承BaseRequestHandler,并重构hanndle方法
2)你必须实例化TCPServer,并且传递server ip和上面创建的请求的类
3)调用handle_request()方法或者server_forever()方法,handle_request,只处理一个请求,
server_forever 处理N多请求
4)关闭call_server()
创建服务器的步骤。首先,你必须创建一个请求处理类,它是BaseRequestHandler的子类并重载其handle()方法。
其次,你必须实例化一个服务器类,传入服务器的地址和请求处理程序类。
最后,调用handle_request()(一般是调用其他事件循环或者使用select())或serve_forever()。
四: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可以读取或写入,以获得请求数据或将数据返回到客户端。
# -*- coding:utf-8 -*- __author__ = 'shisanjun' import os import hashlib import socketserver class MyServer(socketserver.BaseRequestHandler): def handle(self): while True: try: data=self.request.recv(1024) except ConnectionResetError as e: print(e) if not data: #客户端断开会传个空值过来,会导致进入死循环 print("客户端断开连接") break cmd,filename=data.decode("utf-8").split() print(filename) if os.path.isfile(filename): f=open(filename,'rb') m=hashlib.md5() #MD5验证 file_size=os.stat(filename).st_size #获取文件大小 self.request.send(str(file_size).encode()) #给客户端发送文件大小 self.request.recv(1024) #阻塞 因为有两次send,防止出现“粘包” for line in f: m.update(line) self.request.send(line) else: f.close() print("file md5 ",m.hexdigest()) print("send done") self.request.send(m.hexdigest().encode()) #给客户端发送md5验证值 if __name__=="__main__": # server=socketserver.TCPServer(("127.0.0.1",9999),MyServer) #单线程 server=socketserver.ThreadingTCPServer(("127.0.0.1",9999),MyServer) #多线程 server.serve_forever()
# -*- coding:utf-8 -*- __author__ = 'shisanjun' import os import socket import hashlib client=socket.socket() client.connect(("127.0.0.1",9999)) while True: cmd=input(">>:").strip() if len(cmd)==0:continue if cmd.startswith("get"): client.send(cmd.encode("utf-8")) #给服务器端发送命令 response=client.recv(1024) #接受服务器相应:文件大小 total_file_size=int(response.decode("utf-8")) client.send(b"read to recv file") #防止粘包,阻塞 f=open(cmd.split()[1],'wb') m=hashlib.md5() #md5验证 recv_size=0 while recv_size<total_file_size: if total_file_size - recv_size>1024: #判断最后一次接受数据,长度是多少,就收多少,如果还是1024有可能会出现粘包 size=1024 else: size=total_file_size - recv_size recv_data=client.recv(size) f.write(recv_data) m.update(recv_data) recv_size+=len(recv_data) #要以len来计算,最后一次的数据不一定是1024 else: f.close() recv_md5=m.hexdigest() recv_server_md5=client.recv(1024).decode() print("md5 clinet and server", recv_md5,recv_server_md5)