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

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 3
except 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 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
#每次都要创建新的连接
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.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