Python asyncore socket客户端实现方法详解

在Python中，asyncore模块是用于创建异步网络客户端/服务器的模块，可以通过该模块来进行非阻塞式socket编程。在这篇攻略中，我们将详细讲解asyncore模块在socket客户端中的使用方法。

步骤一：导入必要的模块

使用asyncore模块需要导入它以及socket模块。

import asyncore
import socket

步骤二：创建类并继承asyncore.dispatcher

class EchoClient(asyncore.dispatcher):
    def __init__(self, host, port):
        asyncore.dispatcher.__init__(self)

        self.create_socket(socket.AF_INET, socket.SOCK_STREAM)

        self.connect((host, port))

    def handle_connect(self):
        pass

    def handle_close(self):
        self.close()

    def handle_read(self):
        data = self.recv(8192)
        if data:
            print(data)

这里我们创建了一个名为EchoClient的类，并让它继承asyncore.dispatcher类。__init__方法中我们利用create_socket方法创建了一个socket连接。然后，使用connect方法连接到我们想要连接的host和port。

由于我们只是需要创建一个客户端，所以handle_connect方法不需要做任何反应。handle_close方法只是简单的关闭socket连接。而在handle_read方法中，我们也只是简单的获取数据并打印。

步骤三：创建客户端对象

if __name__ == "__main__":
    client = EchoClient(host="localhost", port=8080)
    asyncore.loop()

在主程序中，我们创建EchoClient对象，并使用host和port初始化。最后，我们使用asyncore.loop方法来开始循环监听io事件。

到此，一个简单的asyncore socket客户端就创建好了。

示例一

让我们来看一个简单的示例，通过该示例我们可以清楚的看到asyncore方法与其他socket客户端方法的异同之处。

假设我们的服务器端逻辑如下：

import socket

def main():
    HOST = "localhost"
    PORT = 8080
    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
        s.bind((HOST, PORT))
        s.listen()
        conn, addr = s.accept()
        with conn:
            print("Connected by", addr)
            while True:
                data = conn.recv(1024)
                if not data:
                    break
                conn.sendall(data)

if __name__ == '__main__':
    main()

这里我们创建了一个简单的socket服务器，绑定在localhost的8080端口，可以接收来自客户端的连接，并将客户端发来的数据原封不动的返回给客户端。

现在我们来创建客户端：

class EchoClient(asyncore.dispatcher):
    def __init__(self, host, port, message):
        asyncore.dispatcher.__init__(self)

        self.create_socket(socket.AF_INET, socket.SOCK_STREAM)

        self.connect((host, port))

        self.outbox = message

    def handle_connect(self):
        pass

    def handle_close(self):
        self.close()

    def handle_read(self):
        data = self.recv(8192)
        if data:
            print(data)
            self.outbox = b''

    def handle_write(self):
        if self.outbox:
            sent = self.send(self.outbox)
            self.outbox = self.outbox[sent:]

if __name__ == "__main__":
    client = EchoClient(host="localhost", port=8080, message=b"Hello World!")
    asyncore.loop()

将该程序运行起来，我们能够看到来自服务器的回应：

b'Hello World!'

如你所见，在handle_read方法中，我们打印了来自服务器的数据。同时，在handle_write方法中，我们发送一条消息给服务器。

示例二

为了让我们更好的理解asyncore的工作原理，这次我们编写的客户端不仅要向服务器发送数据，还要接收来自服务器的响应。

服务器

此次，我们的服务器端逻辑如下：

import socket
import time

def main():
    HOST = "localhost"
    PORT = 8080
    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
        s.bind((HOST, PORT))
        s.listen()
        conn, addr = s.accept()
        with conn:
            print("Connected by", addr)
            while True:
                data = conn.recv(1024)
                if not data:
                    break
                time.sleep(2) # 模拟耗时操作
                conn.sendall(b"Hello, " + data)

if __name__ == '__main__':
    main()

这里的服务器与之前的服务器不同之处在于，它会对每一次客户端发送到服务器的数据进行处理，并将处理后的结果返回给客户端。

客户端

客户端逻辑：

class EchoClient(asyncore.dispatcher):
    def __init__(self, host, port):
        asyncore.dispatcher.__init__(self)

        self.create_socket(socket.AF_INET, socket.SOCK_STREAM)

        self.connect((host, port))

        self.outbox = b"Hello World!"

    def handle_connect(self):
        pass

    def handle_close(self):
        self.close()

    def handle_read(self):
        data = self.recv(8192)
        if data:
            print(data)

    def writable(self):
        return (len(self.outbox) > 0)

    def handle_write(self):
        sent = self.send(self.outbox)
        self.outbox = self.outbox[sent:]

if __name__ == "__main__":
    client = EchoClient(host="localhost", port=8080)
    asyncore.loop()

该客户端程序首先会向服务器发送一条消息（"Hello World!"），然后等待来自服务器的响应。当服务器处理完成之后，发送处理结果给客户端。

在客户端程序中，我们已经重写了writable方法，它的作用就是告诉asyncore该client是否可以写入数据。在该方法中，我们只需要判断outbox是否为空即可。

到此，你已经学会了如何使用asyncore模块创建一个socket客户端。如果你还需要更深入学习该模块，可以参考Python官方文档。