11.2 創(chuàng)建TCP服務(wù)器

問(wèn)題

你想實(shí)現(xiàn)一個(gè)服務(wù)器，通過(guò)TCP協(xié)議和客戶端通信。

解決方案

創(chuàng)建一個(gè)TCP服務(wù)器的一個(gè)簡(jiǎn)單方法是使用?<span class="pre" style="box-sizing: border-box;">socketserver</span>?庫(kù)。例如，下面是一個(gè)簡(jiǎn)單的應(yīng)答服務(wù)器：

from socketserver import BaseRequestHandler, TCPServer

class EchoHandler(BaseRequestHandler):
    def handle(self):
        print('Got connection from', self.client_address)
        while True:

            msg = self.request.recv(8192)
            if not msg:
                break
            self.request.send(msg)

if __name__ == '__main__':
    serv = TCPServer(('', 20000), EchoHandler)
    serv.serve_forever()

在這段代碼中，你定義了一個(gè)特殊的處理類，實(shí)現(xiàn)了一個(gè)?<span class="pre" style="box-sizing: border-box;">handle()</span>?方法，用來(lái)為客戶端連接服務(wù)。<span class="pre" style="box-sizing: border-box;">request</span>?屬性是客戶端socket，<span class="pre" style="box-sizing: border-box;">client_address</span>?有客戶端地址。 為了測(cè)試這個(gè)服務(wù)器，運(yùn)行它并打開(kāi)另外一個(gè)Python進(jìn)程連接這個(gè)服務(wù)器：

>>> from socket import socket, AF_INET, SOCK_STREAM
>>> s = socket(AF_INET, SOCK_STREAM)
>>> s.connect(('localhost', 20000))
>>> s.send(b'Hello')
5
>>> s.recv(8192)
b'Hello'
>>>

很多時(shí)候，可以很容易的定義一個(gè)不同的處理器。下面是一個(gè)使用?<span class="pre" style="box-sizing: border-box;">StreamRequestHandler</span>?基類將一個(gè)類文件接口放置在底層socket上的例子：

from socketserver import StreamRequestHandler, TCPServer

class EchoHandler(StreamRequestHandler):
    def handle(self):
        print('Got connection from', self.client_address)
        # self.rfile is a file-like object for reading
        for line in self.rfile:
            # self.wfile is a file-like object for writing
            self.wfile.write(line)

if __name__ == '__main__':
    serv = TCPServer(('', 20000), EchoHandler)
    serv.serve_forever()

討論

<span class="pre" style="box-sizing: border-box;">socketserver</span>?可以讓我們很容易的創(chuàng)建簡(jiǎn)單的TCP服務(wù)器。 但是，你需要注意的是，默認(rèn)情況下這種服務(wù)器是單線程的，一次只能為一個(gè)客戶端連接服務(wù)。 如果你想處理多個(gè)客戶端，可以初始化一個(gè)<span class="pre" style="box-sizing: border-box;">ForkingTCPServer</span>?或者是?<span class="pre" style="box-sizing: border-box;">ThreadingTCPServer</span>?對(duì)象。例如：

from socketserver import ThreadingTCPServer

if __name__ == '__main__':
    serv = ThreadingTCPServer(('', 20000), EchoHandler)
    serv.serve_forever()

使用fork或線程服務(wù)器有個(gè)潛在問(wèn)題就是它們會(huì)為每個(gè)客戶端連接創(chuàng)建一個(gè)新的進(jìn)程或線程。 由于客戶端連接數(shù)是沒(méi)有限制的，因此一個(gè)惡意的黑客可以同時(shí)發(fā)送大量的連接讓你的服務(wù)器奔潰。

如果你擔(dān)心這個(gè)問(wèn)題，你可以創(chuàng)建一個(gè)預(yù)先分配大小的工作線程池或進(jìn)程池。 你先創(chuàng)建一個(gè)普通的非線程服務(wù)器，然后在一個(gè)線程池中使用?<span class="pre" style="box-sizing: border-box;">serve_forever()</span>?方法來(lái)啟動(dòng)它們。

if __name__ == '__main__':
    from threading import Thread
    NWORKERS = 16
    serv = TCPServer(('', 20000), EchoHandler)
    for n in range(NWORKERS):
        t = Thread(target=serv.serve_forever)
        t.daemon = True
        t.start()
    serv.serve_forever()

一般來(lái)講，一個(gè)?<span class="pre" style="box-sizing: border-box;">TCPServer</span>?在實(shí)例化的時(shí)候會(huì)綁定并激活相應(yīng)的?<span class="pre" style="box-sizing: border-box;">socket</span>?。 不過(guò)，有時(shí)候你想通過(guò)設(shè)置某些選項(xiàng)去調(diào)整底下的?socket?，可以設(shè)置參數(shù)?bind_and_activate=False`?。如下：

if __name__ == '__main__':
    serv = TCPServer(('', 20000), EchoHandler, bind_and_activate=False)
    # Set up various socket options
    serv.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, True)
    # Bind and activate
    serv.server_bind()
    serv.server_activate()
    serv.serve_forever()

上面的?<span class="pre" style="box-sizing: border-box;">socket</span>?選項(xiàng)是一個(gè)非常普遍的配置項(xiàng)，它允許服務(wù)器重新綁定一個(gè)之前使用過(guò)的端口號(hào)。 由于要被經(jīng)常使用到，它被放置到類變量中，可以直接在?<span class="pre" style="box-sizing: border-box;">TCPServer</span>?上面設(shè)置。 在實(shí)例化服務(wù)器的時(shí)候去設(shè)置它的值，如下所示：

if __name__ == '__main__':
    TCPServer.allow_reuse_address = True
    serv = TCPServer(('', 20000), EchoHandler)
    serv.serve_forever()

在上面示例中，我們演示了兩種不同的處理器基類（?<span class="pre" style="box-sizing: border-box;">BaseRequestHandler</span>?和<span class="pre" style="box-sizing: border-box;">StreamRequestHandler</span>?）。?<span class="pre" style="box-sizing: border-box;">StreamRequestHandler</span>?更加靈活點(diǎn)，能通過(guò)設(shè)置其他的類變量來(lái)支持一些新的特性。比如：

import socket

class EchoHandler(StreamRequestHandler):
    # Optional settings (defaults shown)
    timeout = 5                      # Timeout on all socket operations
    rbufsize = -1                    # Read buffer size
    wbufsize = 0                     # Write buffer size
    disable_nagle_algorithm = False  # Sets TCP_NODELAY socket option
    def handle(self):
        print('Got connection from', self.client_address)
        try:
            for line in self.rfile:
                # self.wfile is a file-like object for writing
                self.wfile.write(line)
        except socket.timeout:
            print('Timed out!')

最后，還需要注意的是巨大部分Python的高層網(wǎng)絡(luò)模塊（比如HTTP、XML-RPC等）都是建立在<span class="pre" style="box-sizing: border-box;">socketserver</span>?功能之上。 也就是說(shuō)，直接使用?<span class="pre" style="box-sizing: border-box;">socket</span>?庫(kù)來(lái)實(shí)現(xiàn)服務(wù)器也并不是很難。 下面是一個(gè)使用?<span class="pre" style="box-sizing: border-box;">socket</span>?直接編程實(shí)現(xiàn)的一個(gè)服務(wù)器簡(jiǎn)單例子：

from socket import socket, AF_INET, SOCK_STREAM

def echo_handler(address, client_sock):
    print('Got connection from {}'.format(address))
    while True:
        msg = client_sock.recv(8192)
        if not msg:
            break
        client_sock.sendall(msg)
    client_sock.close()

def echo_server(address, backlog=5):
    sock = socket(AF_INET, SOCK_STREAM)
    sock.bind(address)
    sock.listen(backlog)
    while True:
        client_sock, client_addr = sock.accept()
        echo_handler(client_addr, client_sock)

if __name__ == '__main__':
    echo_server(('', 20000))