SocketServer

注意

SocketServer模块已被重命名为socketserverPython 3. 当将源代码转换为Python 3时,2to3工具将自动适应导入。

SocketServer模块简化了编写网络服务器的任务。

有四个基本的具体服务器类:

class SocketServer.TCPServer(server_address, RequestHandlerClass, bind_and_activate=True)

这使用Internet TCP协议,该协议在客户端和服务器之间提供连续的数据流。如果bind_and_activate为true,构造函数会自动尝试调用server_bind()server_activate()。其他参数传递给BaseServer基类。

class SocketServer.UDPServer(server_address, RequestHandlerClass, bind_and_activate=True)

这使用数据报,这些数据报是离散的信息包,可能无序到达或在运输途中丢失。参数与“相同” TCPServer

class SocketServer.UnixStreamServer(server_address, RequestHandlerClass, bind_and_activate=True)class SocketServer.UnixDatagramServer(server_address, RequestHandlerClass, bind_and_activate=True)

这些较少使用的类与TCP和UDP类相似,但使用Unix域套接字; 它们在非Unix平台上不可用。参数与“相同” TCPServer

这四个类同步处理请求; 每个请求必须完成才能开始下一个请求。如果每个请求需要很长时间才能完成,这是不合适的,因为它需要大量计算,或者因为它返回了很多客户端处理缓慢的数据。解决方案是创建一个单独的进程或线程来处理每个请求; 在ForkingMixInThreadingMixIn混合型类可用于支持异步行为。

创建一个服务器需要几个步骤。首先,您必须创建一个请求处理程序类,方法是继承BaseRequestHandler该类并重写其handle()方法; 此方法将处理传入的请求。其次,您必须实例化其中一个服务器类,并将其传递给服务器的地址和请求处理程序类。然后调用服务器对象的handle_request()or serve_forever()方法来处理一个或多个请求。最后,调用server_close()关闭套接字。

ThreadingMixIn线程连接行为继承时,应明确声明您希望线程在突然关闭时的行为方式。在ThreadingMixIn类定义的属性daemon_threads,这表明服务器是否应该等待线程终止。如果您希望线程自主行为,则应该明确设置该标志; 默认值是False,这意味着只有退出创建的所有线程后,Python才会ThreadingMixIn退出。

无论使用何种网络协议,服务器类都具有相同的外部方法和属性。

1.服务器创建说明

继承图中有五个类,其中四个代表四种类型的同步服务器:

+------------+
| BaseServer |
+------------+
      |
      v
+-----------+        +------------------+
| TCPServer |------->| UnixStreamServer |
+-----------+        +------------------+
      |
      v
+-----------+        +--------------------+
| UDPServer |------->| UnixDatagramServer |
+-----------+        +--------------------+

请注意,UnixDatagramServer源自而UDPServer不是源自UnixStreamServerIP和Unix流服务器之间的唯一区别是地址系列,这在两个Unix服务器类中都是重复的。

class SocketServer.ForkingMixInclass SocketServer.ThreadingMixIn

使用这些混合类可以创建每种类型服务器的分叉和线程版本。例如,ThreadingUDPServer创建如下:

class ThreadingUDPServer(ThreadingMixIn, UDPServer):
    pass

混合类首先出现,因为它覆盖了中定义的方法UDPServer。设置各种属性也会改变底层服务器机制的行为。

ForkingMixIn而下面提到的分叉类仅在支持的POSIX平台上可用fork()

class SocketServer.ForkingTCPServerclass SocketServer.ForkingUDPServerclass SocketServer.ThreadingTCPServerclass SocketServer.ThreadingUDPServer

这些类是使用混合类预定义的。

要实现一个服务,你必须从中派生一个类BaseRequestHandler并重新定义它的handle()方法。然后,您可以通过将其中一个服务器类与请求处理程序类相结合来运行各种版本的服务。对于数据报或流服务,请求处理程序类必须不同。这可以通过使用处理程序子类StreamRequestHandler或隐藏DatagramRequestHandler

当然,你还是要用你的头!例如,如果服务包含可以由不同请求修改的内存中的状态,则使用分叉服务器是没有意义的,因为子进程中的修改将永远达不到父进程中保留的初始状态并传递给每个子进程。在这种情况下,您可以使用线程服务器,但您可能必须使用锁来保护共享数据的完整性。

另一方面,如果您正在构建一个HTTP服务器,其中所有数据都存储在外部(例如,在文件系统中),则同时执行的类将基本上使服务“聋”,同时处理一个请求 - 可能用于很长一段时间,如果客户端收到所请求的所有数据的速度很慢。这里的线程或分叉服务器是合适的。

在某些情况下,可能需要同步处理部分请求,但要根据请求数据完成分叉子处理。这可以通过使用同步服务器并在请求处理程序类handle()方法中执行显式分支来实现。

在既不支持线程也不支持线程的环境中处理多个同时发生的请求的另一种方法fork()是维护一个部分完成的请求的明确表,并select()用于决定下一个请求的哪个请求(或者是否处理新的传入请求)。这对于每个客户端可能长时间连接的流服务(如果线程或子进程无法使用)尤其重要。请参阅asyncore另一种管理此方法。

2.服务器对象

class SocketServer.BaseServer(server_address, RequestHandlerClass)

这是模块中所有服务器对象的超类。它定义了下面给出的接口,但不实现大部分方法,这些方法在子类中完成。两个参数被存储在相应的server_addressRequestHandlerClass属性。

fileno()

返回服务器正在侦听的套接字的整数文件描述符。这个功能最常被传递到select.select(),以允许在同一个进程中监视多个服务器。

handle_request()

处理单个请求。这个函数调用下面的方法依次是:get_request()verify_request(),和process_request()。如果用户提供handle()的处理程序类的handle_error()方法引发异常,则将调用服务器的方法。如果在timeout几秒钟内没有收到请求,handle_timeout()则会被调用并handle_request()返回。

serve_forever(poll_interval=0.5)

处理请求直到有明确的shutdown()请求。轮询每个poll_interval秒关闭。忽略该timeout属性。如果您需要执行定期任务,请在另一个线程中执行。

shutdown()

告诉serve_forever()循环停止并等到它结束。

2.6版本中的新功能。

server_close()

清理服务器。可能会被覆盖。

2.6版本中的新功能。

address_family

服务器套接字所属的协议族。常见的例子是socket.AF_INETsocket.AF_UNIX

RequestHandlerClass

用户提供的请求处理程序类; 将为每个请求创建此类的一个实例。

server_address

服务器正在侦听的地址。地址格式因协议族而异; socket有关详细信息,请参阅该模块的文档。对于Internet协议,这是一个元组,其中包含一个给出地址的字符串和一个整数端口号:('127.0.0.1', 80)例如。

socket

服务器将侦听传入请求的套接字对象。

服务器类支持以下类变量:

allow_reuse_address

服务器是否允许重用地址。这默认为False,并且可以在子类中设置来更改策略。

request_queue_size

请求队列的大小。如果处理单个请求需要很长时间,则在服务器繁忙时到达的任何请求都将放入队列中,直至request_queue_size请求。一旦队列满了,来自客户端的进一步请求将会出现“连接被拒绝”错误。默认值通常是5,但这可以由子类覆盖。

socket_type

服务器使用的套接字的类型; socket.SOCK_STREAM并且socket.SOCK_DGRAM是两个共同的价值。

timeout

超时持续时间,以秒为单位或者None如果不需要超时。如果handle_request()在超时期限内未收到任何传入请求,handle_timeout()则调用该方法。

有多种服务器方法可以被基类服务器类的子类覆盖,比如TCPServer:这些方法对服务器对象的外部用户无用。

finish_request()

实际上通过实例化RequestHandlerClass和调用它的handle()方法来处理请求。

get_request()

必须接受来自套接字的请求,并返回包含要用于与客户端通信的套接字对象的2元组以及客户端的地址。

handle_error(request, client_address)

如果实例的handle()方法RequestHandlerClass引发异常,则调用此函数。默认操作是将回溯打印到标准输出并继续处理更多请求。

handle_timeout()

当该timeout属性被设置None为非超时值并超时时间已过且未收到请求时,将调用此函数。forking服务器的默认动作是收集已退出的任何子进程的状态,而在线程服务器中,此方法不执行任何操作。

process_request(request, client_address)

调用finish_request()来创建一个实例RequestHandlerClass。如果需要,这个函数可以创建一个新的进程或线程来处理请求; 这个ForkingMixInThreadingMixIn类是这样做的。

server_activate()

由服务器的构造函数调用以激活服务器。TCP服务器的默认行为只是listen()在服务器的套接字上调用。可能会被覆盖。

server_bind()

由服务器的构造函数调用以将套接字绑定到所需的地址。可能会被覆盖。

verify_request(request, client_address)

必须返回一个布尔值; 如果值是True,请求将被处理,如果是False,请求将被拒绝。该功能可以被覆盖以实现服务器的访问控制。默认实现总是返回True

3.请求处理程序对象

class SocketServer.BaseRequestHandler

这是所有请求处理程序对象的超类。它定义了下面给出的接口。一个具体的请求处理子类必须定义一个新的handle()方法,并且可以重载其他任何方法。为每个请求创建一个新的子类实例。

setup()

handle()方法执行任何初始化操作之前调用。默认实现什么都不做。

handle()

该功能必须完成服务请求所需的全部工作。默认实现什么都不做。有几个实例属性可用; 该请求可用作为self.request; 客户地址为self.client_address; 和服务器实例self.server,以防万一它需要访问每个服务器的信息。

self.request数据报或流服务的类型不同。对于流服务,self.request是一个套接字对象; 对于数据报服务来说,self.request是一对字符串和套接字。

finish()

handle()执行所需清理操作的方法后调用。默认实现什么都不做。如果setup()引发异常,则不会调用该函数。

class SocketServer.StreamRequestHandlerclass SocketServer.DatagramRequestHandler

这些BaseRequestHandler子类重写setup()finish()方法,提供self.rfileself.wfile属性。该self.rfileself.wfile属性可以被读取或写入,分别获得请求的数据或者数据返回给客户端。

4.例子

4.1. SocketServer.TCPServer Example

这是服务器端:

import SocketServer

class MyTCPHandler(SocketServer.BaseRequestHandler):
    """
    The request handler class for our server.

    It is instantiated once per connection to the server, and must
    override the handle() method to implement communication to the
    client.
    """

    def handle(self):
        # self.request is the TCP socket connected to the client
        self.data = self.request.recv(1024).strip()
        print "{} wrote:".format(self.client_address[0])
        print self.data
        # just send back the same data, but upper-cased
        self.request.sendall(self.data.upper())

if __name__ == "__main__":
    HOST, PORT = "localhost", 9999

    # Create the server, binding to localhost on port 9999
    server = SocketServer.TCPServer((HOST, PORT), MyTCPHandler)

    # Activate the server; this will keep running until you
    # interrupt the program with Ctrl-C
    server.serve_forever()

另一个请求处理程序类,它使用流(通过提供标准文件接口来简化通信的文件类对象):

class MyTCPHandler(SocketServer.StreamRequestHandler):

    def handle(self):
        # self.rfile is a file-like object created by the handler;
        # we can now use e.g. readline() instead of raw recv() calls
        self.data = self.rfile.readline().strip()
        print "{} wrote:".format(self.client_address[0])
        print self.data
        # Likewise, self.wfile is a file-like object used to write back
        # to the client
        self.wfile.write(self.data.upper())

区别在于readline()第二个处理程序中的调用会recv()多次调用,直到遇到换行符为止,而recv()第一个处理程序中的单个调用将仅返回一次sendall()调用中从客户端发送的内容。

这是客户端:

import socket
import sys

HOST, PORT = "localhost", 9999
data = " ".join(sys.argv[1:])

# Create a socket (SOCK_STREAM means a TCP socket)
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)

try:
    # Connect to server and send data
    sock.connect((HOST, PORT))
    sock.sendall(data + "\n")

    # Receive data from the server and shut down
    received = sock.recv(1024)
finally:
    sock.close()

print "Sent:     {}".format(data)
print "Received: {}".format(received)

示例的输出应该如下所示:

服务器:

$ python TCPServer.py
127.0.0.1 wrote:
hello world with TCP
127.0.0.1 wrote:
python is nice

客户:

$ python TCPClient.py hello world with TCP
Sent:     hello world with TCP
Received: HELLO WORLD WITH TCP
$ python TCPClient.py python is nice
Sent:     python is nice
Received: PYTHON IS NICE

4.2。SocketServer.UDPServer

这是服务器端:

import SocketServer

class MyUDPHandler(SocketServer.BaseRequestHandler):
    """
    This class works similar to the TCP handler class, except that
    self.request consists of a pair of data and client socket, and since
    there is no connection the client address must be given explicitly
    when sending data back via sendto().
    """

    def handle(self):
        data = self.request[0].strip()
        socket = self.request[1]
        print "{} wrote:".format(self.client_address[0])
        print data
        socket.sendto(data.upper(), self.client_address)

if __name__ == "__main__":
    HOST, PORT = "localhost", 9999
    server = SocketServer.UDPServer((HOST, PORT), MyUDPHandler)
    server.serve_forever()

这是客户端:

import socket
import sys

HOST, PORT = "localhost", 9999
data = " ".join(sys.argv[1:])

# SOCK_DGRAM is the socket type to use for UDP sockets
sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)

# As you can see, there is no connect() call; UDP has no connections.
# Instead, data is directly sent to the recipient via sendto().
sock.sendto(data + "\n", (HOST, PORT))
received = sock.recv(1024)

print "Sent:     {}".format(data)
print "Received: {}".format(received)

示例的输出应该与TCP服务器示例完全一样。

4.3。异步混合

要构建异步处理程序,请使用ThreadingMixInForkingMixIn类。

ThreadingMixIn班的一个例子:

import socket
import threading
import SocketServer

class 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):
    pass

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

示例的输出应该如下所示:

$ 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

所述ForkingMixIn类被以相同的方式使用的,所不同的是,服务器将生成一个新的过程为每个请求。仅在支持的POSIX平台上可用fork()

扫码关注云+社区

领取腾讯云代金券