Python使用SocketServer模塊編寫基本服務器程序的教程
SocketServer簡化了網絡服務器的編寫。它有4個類:TCPServer,UDPServer,UnixStreamServer,UnixDatagramServer。這4個類是同步進行處理的,另外通過ForkingMixIn和ThreadingMixIn類來支持異步。
創(chuàng)建服務器的步驟。首先,你必須創(chuàng)建一個請求處理類,它是BaseRequestHandler的子類并重載其handle()方法。其次,你必須實例化一個服務器類,傳入服務器的地址和請求處理程序類。最后,調用handle_request()(一般是調用其他事件循環(huán)或者使用select())或serve_forever()。
集成ThreadingMixIn類時需要處理異常關閉。daemon_threads指示服務器是否要等待線程終止,要是線程互相獨立,必須要設置為True,默認是False。
無論用什么網絡協(xié)議,服務器類有相同的外部方法和屬性。
在Python3中,本模塊為socketserver模塊。在Python 2中,本模塊為SocketServer模塊。所以在用import導入時,要分情況導入,否則會報錯。導入的代碼如下:
try: import socketserver #Python 3 except ImportError: import SocketServer #Python 2
SocketSerror模塊包括許多可以簡化TCP、UDP、UNIX域套接字 服務器實現的類。
一、處理程序
要使用本模塊,必須定義一個繼承于基類BaseRequestHandler的處理程序類。BaseRequestHandler類的實例h可以實現以下方法:
1、h.handle() 調用該方法執(zhí)行實際的請求操作。調用該函數可以不帶任何參數,但是幾個實例變量包含有用的值。h.request包含請求,h.client_address包含客戶端地址,h.server包含調用處理程序的實例。對于TCP之類的數據流服務,h.request屬性是套接字對象。對于數據報服務,它是包含收到數據的字節(jié)字符串。
2、h.setup() 該方法在handle()之前調用。默認情況下,它不執(zhí)行任何操作。如果希望服務器實現更多連接設置(如建立SSL連接),可以在這里實現。
3、h.finish() 調用本方法可以在執(zhí)行完handle()之后執(zhí)行清除操作。默認情況下,它不執(zhí)行任何操作。如果setup()和handle()方法都不生成異常,則無需調用該方法。
如果知道應用程序只能操縱面向數據流的連接(如TCP),那么應從StreamRequestHandler繼承,而不是BaseRequestHandler。StreamRequestHandler類設置了兩個屬性,h.wfile是將數據寫入客戶端的類文件對象,h.rfile是從客戶端讀取數據的類文件對象。
如果要編寫針對數據包操作的處理程序并將響應持續(xù)返回發(fā)送方,那么它應當從DatagramRequestHandler繼承。它提供的類接口與StramRequestHandler相同。
二、服務器
要使用處理程序,必須將其插入到服務器對象。定義了四個基本的服務器類。
(1)TCPServer(address,handler) 支持使用IPv4的TCP協(xié)議的服務器,address是一個(host,port)元組。Handler是BaseRequestHandler或StreamRequestHandler類的子類的實例。
(2)UDPServer(address,handler) 支持使用IPv4的UDP協(xié)議的服務器,address和handler與TCPServer中類似。
(3)UnixStreamServer(address,handler) 使用UNIX域套接字實現面向數據流協(xié)議的服務器,繼承自TCPServer。
(4)UnixDatagramServer(address,handler) 使用UNIX域套接字實現數據報協(xié)議的服務器,繼承自UDPServer。
所有四個服務器類的實例都有以下方法和變量:
1、s.socket 用于傳入請求的套接字對象。
2、s.sever_address 監(jiān)聽服務器的地址。如元組("127.0.0.1",80)
3、s.RequestHandlerClass 傳遞給服務器構造函數并由用戶提供的請求處理程序類。
4、s.serve_forever() 處理無限的請求
5、s.shutdown() 停止serve_forever()循環(huán)
6、s.fileno() 返回服務器套接字的整數文件描述符。該方法可以有效地通過輪詢操作(如select()函數)使用服務器實例。
三、定義自定義服務器
服務器往往需要特殊的配置來處理不同的網絡地址族、超時期、并發(fā)和其他功能,可以通過繼承上面四個基本服務器類來自行定義。
可以通過混合類獲得更多服務器功能,這也是通過進程或線程分支添加并發(fā)行的方法。為了實現并發(fā)性,定義了以下類:
(1)ForkingMixIn 將UNIX進程分支添加到服務器的混合方法,使用該方法可以讓服務器服務多個客戶。
(2)ThreadingMixIn 修改服務器的混合類,可以使用線程服務多個客戶端。
要向服務器添加這些功能,可以使用多重繼承,其中首先列出混了類。
由于并發(fā)服務器很常用,為了定義它,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 ctime class 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-8 from socket import * BUFSIZE=1024 #每次都要創(chuàng)建新的連接 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()
執(zhí)行結果:
$ python ThreadedTCPServer.py Server loop running in thread: Thread-1 Received: Thread-2: Hello World 1 Received: Thread-3: Hello World 2 Received: Thread-4: Hello World 3
相關文章
python 3.5實現檢測路由器流量并寫入txt的方法實例
這篇文章主要給大家介紹了關于利用python 3.5實現檢測路由器流量并寫入txt的相關資料,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起看看吧。2017-12-12