Python使用SocketServer模組編寫基本伺服器程式的教程_python

SocketServer簡化了網路伺服器的編寫。它有4個類：TCPServer，UDPServer，UnixStreamServer，UnixDatagramServer。這4個類是同步進行處理的，另外通過ForkingMixIn和ThreadingMixIn類來支援非同步。

建立伺服器的步驟。首先，你必須建立一個請求處理類，它是BaseRequestHandler的子類並重載其handle()方法。其次，你必須執行個體化一個伺服器類，傳入伺服器的地址和請求處理常式類。最後，調用handle_request()(一般是調用其他事件迴圈或者使用select())或serve_forever()。

整合ThreadingMixIn類時需要處理異常關閉。daemon_threads指示伺服器是否要等待線程終止，要是線程互相獨立，必須要設定為True，預設是False。

無論用什麼網路通訊協定，伺服器類有相同的外部方法和屬性。

在Python3中，本模組為socketserver模組。在Python 2中，本模組為SocketServer模組。所以在用import匯入時，要分情況匯入，否則會報錯。匯入的代碼如下：

try:  import socketserver   #Python 3except ImportError:  import SocketServer   #Python 2

SocketSerror模組包括許多可以簡化TCP、UDP、UNIX域通訊端  伺服器實現的類。

一、處理常式
要使用本模組，必須定義一個繼承於基類BaseRequestHandler的處理常式類。BaseRequestHandler類的執行個體h可以實現以下方法：
1、h.handle()  調用該方法執行實際的請求操作。調用該函數可以不帶任何參數，但是幾個執行個體變數包含有用的值。h.request包含請求，h.client_address包含用戶端地址，h.server包含調用處理常式的執行個體。對於TCP之類的資料流服務，h.request屬性是通訊端對象。對於資料報服務，它是包含收到資料的位元組字串。
2、h.setup()   該方法在handle()之前調用。預設情況下，它不執行任何操作。如果希望伺服器實現更多串連設定（如建立SSL串連），可以在這裡實現。
3、h.finish()   調用本方法可以在執行完handle()之後執行清除操作。預設情況下，它不執行任何操作。如果setup()和handle()方法都不產生異常，則無需調用該方法。
如果知道應用程式只能操縱面向資料流的串連（如TCP），那麼應從StreamRequestHandler繼承，而不是BaseRequestHandler。StreamRequestHandler類設定了兩個屬性，h.wfile是將資料寫入用戶端的類檔案對象，h.rfile是從用戶端讀取資料的類檔案對象。
如果要編寫針對資料包操作的處理常式並將響應持續返回傳送方，那麼它應當從DatagramRequestHandler繼承。它提供的類介面與StramRequestHandler相同。

二、伺服器
要使用處理常式，必須將其插入到伺服器對象。定義了四個基本的伺服器類。
（1）TCPServer(address,handler)   支援使用IPv4的TCP協議的伺服器，address是一個（host,port）元組。Handler是BaseRequestHandler或StreamRequestHandler類的子類的執行個體。
（2）UDPServer(address,handler)   支援使用IPv4的UDP協議的伺服器，address和handler與TCPServer中類似。
（3）UnixStreamServer(address,handler)   使用UNIX域通訊端實現面向資料流協議的伺服器，繼承自TCPServer。
（4）UnixDatagramServer(address,handler)  使用UNIX域通訊端實現資料報協議的伺服器，繼承自UDPServer。
所有四個伺服器類的執行個體都有以下方法和變數：
1、s.socket   用於傳入請求的通訊端對象。
2、s.sever_address  監聽伺服器的地址。如元組（"127.0.0.1",80）
3、s.RequestHandlerClass   傳遞給伺服器建構函式並由使用者提供的請求處理常式類。
4、s.serve_forever()  處理無限的請求
5、s.shutdown()   停止serve_forever()迴圈
6、s.fileno()   返回伺服器通訊端的整數檔案描述符。該方法可以有效地通過輪詢操作（如select()函數）使用伺服器執行個體。

三、定義自訂伺服器
伺服器往往需要特殊的配置來處理不同的網路地址族、逾時期、並發和其他功能，可以通過繼承上面四個基本伺服器類來自行定義。
可以通過混合類獲得更多伺服器功能，這也是通過進程或線程分支添加並發行的方法。為了實現並發性，定義了以下類：
（1）ForkingMixIn         將UNIX進程分支添加到伺服器的混合方法，使用該方法可以讓伺服器服務多個客戶。
（2）ThreadingMixIn    修改伺服器的混合類，可以使用線程服務多個用戶端。
要向伺服器添加這些功能，可以使用多重繼承，其中首先列出混了類。
由於並發伺服器很常用，為了定義它，SocketServer預定義了以下伺服器類：
（1）ForkingUDPServer(address,handler)  
（2）ForkingTCPServer(address,handler)
（3）ThreadingUDPServer(address,handler)
（4）ThreadingTCPServer(address,handler)
上面有點亂，現總結以下：
SocketServer模組中的類主要有以下幾個：
1、BaseServer    包含伺服器的核心功能與混合類（mix-in）的鉤子功能。這個類主要用於派生，不要直接產生這個類的類對象，可以考慮使用TCPServer和UDPServer類。
2、TCPServer    基本的網路同步TCP伺服器
3、UDPServer    基本的網路同步UDP伺服器
4、ForkingMixIn   實現了核心的進程化功能，用於與伺服器類進行混合(mix-in)，以提供一些非同步特性。不要直接產生這個類的對象。
5、ThreadingMixIn   實現了核心的線程化功能，用於與伺服器類進行混合(mix-in)，以提供一些非同步特性。不要直接產生這個類的對象。
6、ForkingTCPServer     ForkingMixIn與TCPServer的組合
7、ForkingUDPServer    ForkingMixIn與UDPServer的組合
8、BaseRequestHandler
9、StreamRequestHandler    TCP請求處理類的一個實現
10、DataStreamRequestHandler   UDP請求處理類的一個實現
現在繁雜的事務都已經封裝到類中了，直接使用類即可。

四、執行個體
1.使用SocketServer模組編寫的TCP伺服器端代碼：

#! /usr/bin/env python#coding=utf-8"""使用SocketServer來實現簡單的TCP伺服器"""from SocketServer import (TCPServer,StreamRequestHandler as SRH)from time import ctimeclass MyRequestHandler(SRH):  def handle(self):    print "connected from ",self.client_address    self.wfile.write("[%s] %s" %(ctime(),self.rfile.readline()))tcpSer=TCPServer(("",10001),MyRequestHandler)print "waiting for connection"tcpSer.serve_forever()相應的TCP用戶端代碼：#! /usr/bin/env python#coding=utf-8from socket import *BUFSIZE=1024#每次都要建立新的串連while True:  tcpClient=socket(AF_INET,SOCK_STREAM)  tcpClient.connect(("localhost",10001))  data=raw_input(">")  if not data:    break  tcpClient.send("%s\r\n" %data)  data1=tcpClient.recv(BUFSIZE)  if not data1:    break  print data1.strip()  tcpClient.close()

2.非同步伺服器的實現

ThreadingMixIn的例子：

import socketimport threadingimport SocketServerclass ThreadedTCPRequestHandler(SocketServer.BaseRequestHandler):  def handle(self):    data = self.request.recv(1024)    cur_thread = threading.current_thread()    response = "{}: {}".format(cur_thread.name, data)    self.request.sendall(response)class ThreadedTCPServer(SocketServer.ThreadingMixIn, SocketServer.TCPServer):  passdef client(ip, port, message):  sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)  sock.connect((ip, port))  try:    sock.sendall(message)    response = sock.recv(1024)    print "Received: {}".format(response)  finally:    sock.close()if __name__ == "__main__":  # Port 0 means to select an arbitrary unused port  HOST, PORT = "localhost", 0  server = ThreadedTCPServer((HOST, PORT), ThreadedTCPRequestHandler)  ip, port = server.server_address  # Start a thread with the server -- that thread will then start one  # more thread for each request  server_thread = threading.Thread(target=server.serve_forever)  # Exit the server thread when the main thread terminates  server_thread.daemon = True  server_thread.start()  print "Server loop running in thread:", server_thread.name  client(ip, port, "Hello World 1")  client(ip, port, "Hello World 2")  client(ip, port, "Hello World 3")  server.shutdown()

執行結果：

$ python ThreadedTCPServer.pyServer loop running in thread: Thread-1Received: Thread-2: Hello World 1Received: Thread-3: Hello World 2Received: Thread-4: Hello World 3