原創(chuàng)：志學(xué)Python http://985.so/bVgX
SocketServer簡(jiǎn)化了網(wǎng)絡(luò)服務(wù)器的編寫。在進(jìn)行socket創(chuàng)建時(shí)，使用SocketServer會(huì)大大減少創(chuàng)建的步驟，并且SocketServer使用了select它有4個(gè)類：TCPServer，UDPServer，UnixStreamServer，UnixDatagramServer。這4個(gè)類是同步進(jìn)行處理的，另外通過(guò)ForkingMixIn和ThreadingMixIn類來(lái)支持異步。
使用SocketServer的步驟簡(jiǎn)介
創(chuàng)建服務(wù)器的步驟。首先，你必須創(chuàng)建一個(gè)請(qǐng)求處理類，它是BaseRequestHandler的子類并重載其handle()方法。
實(shí)例化一個(gè)服務(wù)器類，傳入服務(wù)器的地址和請(qǐng)求處理程序類。
最后，調(diào)用handlerequest()(一般是調(diào)用其他事件循環(huán)或者使用select())或serveforever()。
集成ThreadingMixIn類時(shí)需要處理異常關(guān)閉。daemon_threads指示服務(wù)器是否要等待線程終止，要是線程互相獨(dú)立，必須要設(shè)置為True，默認(rèn)是False。
無(wú)論用什么網(wǎng)絡(luò)協(xié)議，服務(wù)器類有相同的外部方法和屬性。
測(cè)試案例
服務(wù)器端為一個(gè)時(shí)間戳服務(wù)器，在接收到客戶端發(fā)來(lái)的數(shù)據(jù)后，自動(dòng)回復(fù)。
客戶端，等待用戶輸入，回車后向服務(wù)器發(fā)送用戶輸入的內(nèi)容。
分別在python2.7和python3.6下測(cè)試。在啟動(dòng)時(shí)需要先啟動(dòng)服務(wù)器端，在啟動(dòng)客戶端。
python2.7下
服務(wù)器端代碼為
#coding:utf-8 import SocketServer from time import ctime print ( "=====================SocketServer TCP服務(wù)器=====================" ); HOST = '' #主機(jī)號(hào)為空白表示可以使用任何可用的地址。 PORT = 21567 #端口號(hào) ADDR = ( HOST , PORT ) class MyRequestHandler ( SocketServer . StreamRequestHandler ): #StreamRequestHandler實(shí)現(xiàn)TCP/UDP服務(wù)器的服務(wù)處理器 def handle ( self ): #重寫接收響應(yīng)函數(shù) print ( '...connect from:' , self . client_address ) data = self . rfile . readline (). strip () print ( data ) self . wfile . write ( '[%s] %s' % ( ctime (), data )) tcpSerSock = SocketServer . TCPServer ( ADDR , MyRequestHandler ) print ( '等待連接...' ) tcpSerSock . serve_forever ()
客戶端代碼為
#coding:utf-8 from socket import * print ( "=====================SocketServer TCP客戶端=====================" ); HOST = '127.0.0.1' #本機(jī)測(cè)試 PORT = 21567 BUFSIZ = 1024 ADDR = ( HOST , PORT ) while True : tcpCliSock = socket ( AF_INET , SOCK_STREAM ) #創(chuàng)建客戶端套接字 tcpCliSock . connect ( ADDR ) #發(fā)起TCP連接 data = raw_input ( '> ' ) #接收用戶輸入 if not data : #如果用戶輸入為空，直接回車就會(huì)發(fā)送""，""就是代表false break tcpCliSock . send ( data + 'n' ) #客戶端發(fā)送消息，必須發(fā)送字節(jié)數(shù)組 data = tcpCliSock . recv ( BUFSIZ ) #接收回應(yīng)消息，接收到的是字節(jié)數(shù)組 if not data : #如果接收服務(wù)器信息失敗，或響應(yīng)消息為空 break print ( data ) #打印回應(yīng)消息 tcpCliSock . close () #關(guān)閉客戶端socket
python3.6下
SocketServer模塊在python3中已經(jīng)更名為socketserver。
服務(wù)器端代碼為
#coding:utf-8 import socketserver from time import ctime print ( "=====================SocketServer TCP服務(wù)器=====================" ); HOST = '' #主機(jī)號(hào)為空白表示可以使用任何可用的地址。 PORT = 21567 #端口號(hào) ADDR = ( HOST , PORT ) class MyRequestHandler ( socketserver . StreamRequestHandler ): #StreamRequestHandler實(shí)現(xiàn)TCP/UDP服務(wù)器的服務(wù)處理器 def handle ( self ): #重寫接收響應(yīng)函數(shù) print ( '連接到:' , self . client_address ) data = self . rfile . readline (). strip () print ( data ) self . wfile . write ( bytes ( '[%s] %s' % ( ctime (), data . decode ( 'utf-8' )), 'utf-8' )) tcpSerSock = socketserver . TCPServer ( ADDR , MyRequestHandler ) print ( '等待連接...' ) tcpSerSock . serve_forever ()
客戶端代碼為
#coding:utf-8 from socket import * print ( "=====================SocketServer TCP客戶端=====================" ); HOST = '127.0.0.1' #本機(jī)測(cè)試 PORT = 21567 BUFSIZ = 1024 ADDR = ( HOST , PORT ) while True : tcpCliSock = socket ( AF_INET , SOCK_STREAM ) #創(chuàng)建客戶端套接字 tcpCliSock . connect ( ADDR ) #發(fā)起TCP連接 data = input ( '> ' ) #接收用戶輸入 if not data : #如果用戶輸入為空，直接回車就會(huì)發(fā)送""，""就是代表false break tcpCliSock . send ( bytes ( data + 'n' , 'utf-8' )) #客戶端發(fā)送消息，必須發(fā)送字節(jié)數(shù)組 buffer = tcpCliSock . recv ( BUFSIZ ) #接收回應(yīng)消息，接收到的是字節(jié)數(shù)組 if not buffer : #如果接收服務(wù)器信息失敗，或響應(yīng)消息為空 break print ( str ( buffer , 'utf-8' )) #打印回應(yīng)消息 tcpCliSock . close () #關(guān)閉客戶端socket
服務(wù)器類型
5種類型：BaseServer，TCPServer，UnixStreamServer，UDPServer，UnixDatagramServer。注意：BaseServer不直接對(duì)外服務(wù)。
服務(wù)器對(duì)象
•class SocketServer.BaseServer：這是模塊中的所有服務(wù)器對(duì)象的超類。它定義了接口，如下所述，但是大多數(shù)的方法不實(shí)現(xiàn)，在子類中進(jìn)行細(xì)化。
•BaseServer.fileno()：返回服務(wù)器監(jiān)聽(tīng)套接字的整數(shù)文件描述符。通常用來(lái)傳遞給select.select(), 以允許一個(gè)進(jìn)程監(jiān)視多個(gè)服務(wù)器。
•BaseServer.handlerequest()：處理單個(gè)請(qǐng)求。處理順序：getrequest(), verifyrequest(), processrequest()。如果用戶提供handle()方法拋出異常，將調(diào)用服務(wù)器的handleerror()方法。如果self.timeout內(nèi)沒(méi)有請(qǐng)求收到， 將調(diào)用handletimeout()并返回handle_request()。
•BaseServer.serveforever(pollinterval=0.5): 處理請(qǐng)求，直到一個(gè)明確的shutdown()請(qǐng)求。每poll_interval秒輪詢一次shutdown。忽略self.timeout。如果你需要做周期性的任務(wù)，建議放置在其他線程。
•BaseServer.shutdown()：告訴serve_forever()循環(huán)停止并等待其停止。python2.6版本。
•BaseServer.addressfamily: 地址家族，比如socket.AFINET和socket.AF_UNIX。
•BaseServer.RequestHandlerClass：用戶提供的請(qǐng)求處理類，這個(gè)類為每個(gè)請(qǐng)求創(chuàng)建實(shí)例。
•BaseServer.server_address：服務(wù)器偵聽(tīng)的地址。格式根據(jù)協(xié)議家族地址的各不相同，請(qǐng)參閱socket模塊的文檔。
•BaseServer.socketSocket：服務(wù)器上偵聽(tīng)傳入的請(qǐng)求socket對(duì)象的服務(wù)器。
服務(wù)器類支持下面的類變量：
•BaseServer.allowreuseaddress：服務(wù)器是否允許地址的重用。默認(rèn)為false ，并且可在子類中更改。
•BaseServer.requestqueuesize
請(qǐng)求隊(duì)列的大小。如果單個(gè)請(qǐng)求需要很長(zhǎng)的時(shí)間來(lái)處理，服務(wù)器忙時(shí)請(qǐng)求被放置到隊(duì)列中，最多可以放requestqueuesize個(gè)。一旦隊(duì)列已滿，來(lái)自客戶端的請(qǐng)求將得到 “Connection denied”錯(cuò)誤。默認(rèn)值通常為5 ，但可以被子類覆蓋。
•BaseServer.sockettype：服務(wù)器使用的套接字類型; socket.SOCKSTREAM和socket.SOCK_DGRAM等。
•BaseServer.timeout：超時(shí)時(shí)間，以秒為單位，或 None表示沒(méi)有超時(shí)。如果handlerequest()在timeout內(nèi)沒(méi)有收到請(qǐng)求，將調(diào)用handletimeout()。
下面方法可以被子類重載，它們對(duì)服務(wù)器對(duì)象的外部用戶沒(méi)有影響。
•BaseServer.finish_request()：實(shí)際處理RequestHandlerClass發(fā)起的請(qǐng)求并調(diào)用其handle()方法。常用。
•BaseServer.get_request()：接受socket請(qǐng)求，并返回二元組包含要用于與客戶端通信的新socket對(duì)象，以及客戶端的地址。
•BaseServer.handleerror(request, clientaddress)：如果RequestHandlerClass的handle()方法拋出異常時(shí)調(diào)用。默認(rèn)操作是打印traceback到標(biāo)準(zhǔn)輸出，并繼續(xù)處理其他請(qǐng)求。
•BaseServer.handle_timeout()：超時(shí)處理。默認(rèn)對(duì)于forking服務(wù)器是收集退出的子進(jìn)程狀態(tài)，threading服務(wù)器則什么都不做。
•BaseServer.processrequest(request, clientaddress) :調(diào)用finish_request()創(chuàng)建RequestHandlerClass的實(shí)例。如果需要，此功能可以創(chuàng)建新的進(jìn)程或線程來(lái)處理請(qǐng)求,ForkingMixIn和ThreadingMixIn類做到這點(diǎn)。常用。
•BaseServer.server_activate()：通過(guò)服務(wù)器的構(gòu)造函數(shù)來(lái)激活服務(wù)器。默認(rèn)的行為只是監(jiān)聽(tīng)服務(wù)器套接字。可重載。
•BaseServer.server_bind()：通過(guò)服務(wù)器的構(gòu)造函數(shù)中調(diào)用綁定socket到所需的地址。可重載。
•BaseServer.verifyrequest(request, clientaddress)：返回一個(gè)布爾值，如果該值為True ，則該請(qǐng)求將被處理，反之請(qǐng)求將被拒絕。此功能可以重寫來(lái)實(shí)現(xiàn)對(duì)服務(wù)器的訪問(wèn)控制。默認(rèn)的實(shí)現(xiàn)始終返回True。client_address可以限定客戶端，比如只處理指定ip區(qū)間的請(qǐng)求。常用。
請(qǐng)求處理器
處理器接收數(shù)據(jù)并決定如何操作。它負(fù)責(zé)在socket層之上實(shí)現(xiàn)協(xié)議（i.e., HTTP, XML-RPC, or AMQP)，讀取數(shù)據(jù)，處理并寫反應(yīng)。可以重載的方法如下：
•setup(): 準(zhǔn)備請(qǐng)求處理. 默認(rèn)什么都不做，StreamRequestHandler中會(huì)創(chuàng)建文件類似的對(duì)象以讀寫socket.
•handle(): 處理請(qǐng)求。解析傳入的請(qǐng)求，處理數(shù)據(jù)，并發(fā)送響應(yīng)。默認(rèn)什么都不做。常用變量：self.request，self.client_address，self.server。
•finish(): 環(huán)境清理。默認(rèn)什么都不做，如果setup產(chǎn)生異常，不會(huì)執(zhí)行finish。
通常只需要重載handle。self.request的類型和數(shù)據(jù)報(bào)或流的服務(wù)不同。對(duì)于流服務(wù)，self.request是socket 對(duì)象；對(duì)于數(shù)據(jù)報(bào)服務(wù)，self.request是字符串和socket 。可以在子類StreamRequestHandler或DatagramRequestHandler中重載，重寫setup()和finish() ，并提供self.rfile和self.wfile屬性。self.rfile和self.wfile可以讀取或?qū)懭耄垣@得請(qǐng)求數(shù)據(jù)或?qū)?shù)據(jù)返回到客戶端。
