利用Python的SocketServer框架編寫網路服務程式
1.前言:
雖說用Python編寫簡單的網路程式很方便,但複雜一點的網路程式還是用現成的框架比較好。這樣就可以專心事務邏輯,而不是套接字的各種細節。SocketServer模組簡化了編寫網路服務程式的任務。同時SocketServer模組也是Python標準庫中很多伺服器框架的基礎。
2.網路服務類:
SocketServer提供了4個基本的服務類:
TCPServer針對TCP套接字流
UDPServer針對UDP資料報套接字
UnixStreamServer和UnixDatagramServer針對UNIX域套接字,不常用。
它們的繼承關係如下:
+------------+ | BaseServer | +------------+ | v +-----------+ +------------------+ | TCPServer |------->| UnixStreamServer | +-----------+ +------------------+ | v +-----------+ +--------------------+ | UDPServer |------->| UnixDatagramServer | +-----------+ +--------------------+
2.1非同步處理:
這個四個服務類都是同步處理請求的。一個請求沒處理完不能處理下一個請求。要想支援非同步模型,可以利用多繼承讓server類繼承ForkingMixIn 或ThreadingMixInmix-in classes。
ForkingMixIn利用多程序(分叉)實現非同步。
ThreadingMixIn利用多執行緒實現非同步。
3.請求處理類:
要實現一項服務,還必須派生一個handler class請求處理類,並重寫父類的handle()方法。handle方法就是用來專門是處理請求的。該模組是通過服務類和請求處理類組合來處理請求的。
SocketServer模組提供的請求處理類有BaseRequestHandler,以及它的派生類StreamRequestHandler和DatagramRequestHandler。從名字看出可以一個處理流式套接字,一個處理資料報套接字。
4.總結用SocketServer建立一個服務的步驟:
1.建立一個request handler class(請求處理類),繼承自BaseRequestHandler class並重寫它的handle()方法,該方法將處理到的請求。
2.例項化一個server class物件,並將服務的地址和之前建立的request handler class傳遞給它。
3.呼叫server class物件的handle_request() 或 serve_forever()方法來開始處理請求。
一個基於SocketServer的伺服器示例:
from SocketServer import TCPServer,StreamRequestHandler
#定義請求處理類
class Handler(StreamRequestHandler):
def handle(self):
addr = self.request.getpeername()
print 'Got connection from ',addr
self.wfile.write('Thank you for connecting')
server = TCPServer(('',1234), Handler) #例項化服務類物件
server.server_forever() #開啟服務
5.實現非同步,支援多連線
前面介紹服務類時提到過,四個基本的服務類預設是同步模型的。要想支援非同步可以利用多繼承從ForkingMixIn 或ThreadingMixInmix-in classes和一個基本的服務類繼承來定義一個支援非同步的服務類。比如:
class Server(ThreadingMixIn, TCPServer): pass
ForkingMixIn 要考慮程序間的通訊。ThreadingMixIn要考慮執行緒訪問同一變數時的同步和互斥。
一個使用了多執行緒處理的伺服器示例:
from SocketServer import TCPServer, ThreadingMixIn, StreamRequestHandler
#定義支援多執行緒的服務類,注意是多繼承
class Server(ThreadingMixIn, TCPServer): pass
#定義請求處理類
class Handler(StreamRequestHandler):
def handle(self):
addr = self.request.getpeername()
print 'Got connection from ',addr
self.wfile.write('Thank you for connection')
server = Server(('', 1234), Handler) #例項化服務類
server.serve_forever() #開啟服務
6.參考:
書 《Python基礎教程(第2版)》
-----------------------------------------------------2016.6.29新增--------------------------------------
分析socketserver原始碼時很好奇,如果mix-in類和Server中都實現了某個方法,執行時會選擇哪個。然後在原始碼檔案中看到了以下說明:
Forking and threading versions of each type of server can be created
using the ForkingMixIn and ThreadingMixIn mix-in classes. For
instance, a threading UDP server class is created as follows:
class ThreadingUDPServer(ThreadingMixIn, UDPServer): pass
The Mix-in class must come first, since it overrides a method defined
in UDPServer! Setting the various member variables also changes
the behavior of the underlying server mechanism.
意思是說繼承這兩個mix-in類時,必須把它放在繼承順序的前面,因為它重寫了UDPServer中的同名方法。