概述

這篇文章是講解如何使用socketserver建立一個非同步TCP伺服器，其中Python版本為3.5.1。

socketserver主要的類

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請求處理類的一個實現

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()方法都不生成異常，則無需呼叫該方法。

官方例程

首先上官方給出的例程：

<span style="font-size:14px;">import socket
import threading
import socketserver

class ThreadedTCPRequestHandler(socketserver.BaseRequestHandler):

    def handle(self):
        data = str(self.request.recv(1024), 'ascii')
        cur_thread = threading.current_thread()
        response = bytes("{}: {}".format(cur_thread.name, data), 'ascii')
        self.request.sendall(response)

class ThreadedTCPServer(socketserver.ThreadingMixIn, socketserver.TCPServer):
    pass

def client(ip, port, message):
    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
        sock.connect((ip, port))
        sock.sendall(bytes(message, 'ascii'))
        response = str(sock.recv(1024), 'ascii')
        print("Received: {}".format(response))

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()
    server.server_close()</span>
 

正常輸入如下：

$ 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

增加功能

上面部分主要是講解官方的例程，下面這一部分是博主自己增加的功能。

1、獲取客戶端的ip和port

client_addr = []

class ThreadedTCPRequestHandler(socketserver.BaseRequestHandler):

    def setup(self):
        ip = self.client_address[0].strip()     # 獲取客戶端的ip
        port = self.client_address[1]           # 獲取客戶端的port
        print(ip+":"+str(port)+" is connect!")
        client_addr.append(self.client_address) # 儲存到佇列中

    def handle(self):
        data = str(self.request.recv(1024), 'ascii')
        cur_thread = threading.current_thread()
        response = bytes("{}: {}".format(cur_thread.name, data), 'ascii')
        self.request.sendall(response)

print("\nclient_addr:"+str(client_addr))

2、保持TCP長連線

class ThreadedTCPRequestHandler(socketserver.BaseRequestHandler):

    def setup(self):
        ip = self.client_address[0].strip()     # 獲取客戶端的ip
        port = self.client_address[1]           # 獲取客戶端的port
        print(ip+":"+str(port)+" is connect!")
        client_addr.append(self.client_address) # 儲存到佇列中

    def handle(self):
        while True: # while迴圈
            data = str(self.request.recv(1024), 'ascii')
            if data:    # 判斷是否接收到資料
                cur_thread = threading.current_thread()
                response = bytes("{}: {}".format(cur_thread.name, data), 'ascii')
                self.request.sendall(response)

    def finish(self):
        print("client is disconnect!")

3、伺服器給客戶端傳送請求

client_addr = []
client_socket = []

class ThreadedTCPRequestHandler(socketserver.BaseRequestHandler):

    def setup(self):
        ip = self.client_address[0].strip()     # 獲取客戶端的ip
        port = self.client_address[1]           # 獲取客戶端的port
        print(ip+":"+str(port)+" is connect!")
        client_addr.append(self.client_address) # 儲存到佇列中
        client_socket.append(self.request)      # 儲存套接字socket

    def handle(self):
        while True: # while迴圈
            data = str(self.request.recv(1024), 'ascii')
            if data:    # 判斷是否接收到資料
                cur_thread = threading.current_thread()
                response = bytes("{}: {}".format(cur_thread.name, data), 'ascii')
                self.request.sendall(response)

    def finish(self):
        print("client is disconnect!")
        client_addr.remove(self.client_address)
        client_socket.remove(self.request)

    message = bytes("clientTest\n", "ascii")
    while True:
        time.sleep(2)
        if client_addr:
            client_socket[0].sendall(message)

4、伺服器接收客戶端資料超時後斷開

class ThreadedTCPRequestHandler(socketserver.BaseRequestHandler):

    ip = ""
    port = 0
    timeOut = 6     # 設定超時時間變數

    def setup(self):
        self.ip = self.client_address[0].strip()     # 獲取客戶端的ip
        self.port = self.client_address[1]           # 獲取客戶端的port
        self.request.settimeout(self.timeOut)        # 對socket設定超時時間
        print(self.ip+":"+str(self.port)+"連線到伺服器！")
        client_addr.append(self.client_address) # 儲存到佇列中
        client_socket.append(self.request)      # 儲存套接字socket

    def handle(self):
        while True: # while迴圈
            try:
                data = str(self.request.recv(1024), 'ascii')
            except socket.timeout:  # 如果接收超時會丟擲socket.timeout異常
                print(self.ip+":"+str(self.port)+"接收超時！即將斷開連線！")
                break       # 記得跳出while迴圈

            if data:    # 判斷是否接收到資料
                cur_thread = threading.current_thread()
                response = bytes("{}: {}".format(cur_thread.name, data), 'ascii')
                self.request.sendall(response)

    def finish(self):
        print(self.ip+":"+str(self.port)+"斷開連線！")
        client_addr.remove(self.client_address)
        client_socket.remove(self.request)