Python Socketio 介绍

发布时间:2024年01月16日

? ?socketio是一个Python库,用于处理实时网络通信,它实现了Socket.IO协议。Socket.IO是一个JavaScript库,用于实时、双向和基于事件的通信。它在浏览器和服务器之间建立一个持久的连接,允许它们进行实时通信。

? ?socketio.Client()socketio库中的一个类,用于创建一个Socket.IO客户端。这个客户端可以连接到一个Socket.IO服务器,并与其进行实时通信。

socketio.Client()的一些主要方法和事件:

  1. **connect(url,?kwargs): 这个方法用于连接到一个Socket.IO服务器。你需要提供服务器的URL。你还可以提供一些可选的关键字参数,如transports(指定连接使用的协议类型)。

  2. emit(event, data): 这个方法用于发送一个事件到服务器。你需要提供事件的名称和要发送的数据。

  3. on(event): 这个装饰器用于定义一个事件处理器。当客户端收到指定的事件时,它会调用相应的事件处理器。

  4. disconnect(): 这个方法用于断开与服务器的连接。

? ? ? ? 以下是一个简单的例子,展示了如何使用socketio.Client()

import socketio

sio = socketio.Client()

@sio.event
def connect():
    print("I'm connected!")

@sio.event
def disconnect():
    print("I'm disconnected!")

sio.connect('http://localhost:5000')
sio.emit('my event', {'data': 'Hello, world!'})
sio.disconnect()

? ? ? ?

? ? ? ? 我们首先创建了一个socketio.Client()实例。然后,我们定义了两个事件处理器:一个用于处理connect事件,另一个用于处理disconnect事件。然后,我们连接到服务器,发送一个名为my event的事件,然后断开连接。

socketio?库中的一些主要方法:

  1. socketio.Client(): 这是一个类,用于创建一个新的Socket.IO客户端实例。

  2. **sio.connect(url,?kwargs): 这个方法用于连接到一个Socket.IO服务器。你需要提供服务器的URL。你还可以提供一些可选的关键字参数,如transports(指定连接使用的协议类型)。

  3. sio.emit(event, data): 这个方法用于发送一个事件到服务器。你需要提供事件的名称和要发送的数据。

  4. sio.disconnect(): 这个方法用于断开与服务器的连接。

  5. sio.on(event, handler): 这个方法用于注册一个事件处理器。当客户端收到指定的事件时,它会调用相应的事件处理器。例如,你可以使用?sio.on('message', message_handler)?来注册一个处理 'message' 事件的处理器。

  6. sio.wait(): 这个方法会阻塞当前线程,直到客户端断开连接。这对于需要保持连接的应用(如聊天应用、实时游戏等)非常有用。

  7. **sio.start_background_task(target, *args,?kwargs): 这个方法用于启动一个后台任务。这对于需要在后台运行的长时间任务非常有用。

  8. sio.sleep(seconds): 这个方法会暂停当前线程指定的秒数。这对于需要在发送事件之间添加延迟的情况非常有用。

  9. sio.event: 这是一个装饰器,用于定义一个事件处理器。当客户端收到指定的事件时,它会调用相应的事件处理器。例如,你可以使用?@sio.event?来定义一个处理 'connect' 事件的处理器。

注意事项:

  1. 事件处理函数: 当你定义一个事件处理函数时,需要确保它能正确处理从服务器接收到的数据。如果处理函数抛出异常,可能会导致客户端断开连接。

  2. 线程安全:?socketio库是线程安全的,你可以在多个线程中使用同一个socketio.Client实例。但是,如果你在事件处理函数中访问共享数据,你需要确保这些访问是线程安全的。

  3. 连接状态: 在调用sio.emit()sio.disconnect()之前,你需要确保客户端已经连接到服务器。如果客户端没有连接到服务器,这些操作将会失败。

  4. 错误处理:?sio.connect()方法可能会抛出异常,例如,如果服务器无法连接。你需要确保你的代码能正确处理这些异常。

  5. 资源清理: 当你不再需要socketio.Client实例时,你应该调用sio.disconnect()来断开连接并释放资源。

  6. 阻塞操作:?sio.wait()方法是阻塞的,它会阻塞当前线程直到客户端断开连接。如果你不希望阻塞当前线程,你可以在一个单独的线程中调用这个方法。

  7. 后台任务: 如果你需要在后台运行长时间任务,你可以使用sio.start_background_task()方法。但是,你需要确保这个任务不会阻塞事件处理函数,否则可能会影响到客户端的响应性。

socketio.Client类的装饰器

? ? ? ? 在Python中,装饰器是一种特殊类型的函数,它可以修改其他函数的行为。

? ?@sio.event@sio.onsocketio.Client类的装饰器,它们用于注册事件处理器。

? ? ? ??@sio.event: 这个装饰器用于注册一个处理器,当客户端触发特定的Socket.IO事件时,这个处理器会被调用。事件的名称由处理器函数的名称决定。

? ? ? ??@sio.on: 这个装饰器用于注册一个处理器,当客户端触发特定的Socket.IO事件时,这个处理器会被调用。事件的名称由装饰器的参数决定。

? ? ? ? 这两个装饰器的主要目的是将事件处理器与特定的事件关联起来。当这些事件发生时,相应的处理器会被自动调用。这使得你可以在处理器中编写处理事件的代码,而不需要在主程序中显式调用这些处理器。这样可以使你的代码更加清晰和模块化。

@sio.event@sio.on有什么区别

@sio.event@sio.on都是用于注册事件处理器的装饰器,但它们的使用方式略有不同:

  • @sio.event:这个装饰器根据被修饰的函数的名称来确定对应的事件。例如,如果你有一个名为connect的函数并且它被@sio.event装饰,那么这个函数会在客户端收到connect事件时被调用。
@sio.event
def connect():
    print("Connected to the server!")
  • @sio.on:这个装饰器需要一个参数,这个参数是你想要处理的事件的名称。例如,如果你有一个名为handle_connect的函数并且它被@sio.on('connect')装饰,那么这个函数会在客户端收到connect事件时被调用。
@sio.on('connect')
def handle_connect():
    print("Connected to the server!")

? ? ? ? 总的来说,@sio.event@sio.on都可以用来注册事件处理器,选择使用哪一个主要取决于你的编程风格和需求。如果你希望函数名和事件名保持一致,那么@sio.event可能更适合你。如果你希望能够自由地为函数命名,那么@sio.on可能更适合你。

socketio库中其他修饰器

  • @sio.middleware: 这个装饰器用于注册中间件函数。中间件函数在每个事件处理器之前运行,它们可以用于处理跨越多个事件的逻辑,例如身份验证或日志记录。
@sio.middleware
def print_event(sid, data):
    print("Socket ID: ", sid, ", Event data: ", data)
  • @sio.exception_handler(): 这个装饰器用于注册异常处理器。异常处理器在事件处理器抛出异常时运行,它们可以用于处理事件处理器中未捕获的异常。
@sio.exception_handler(ValueError)
def handle_value_error(e):
    print("A ValueError occurred: ", e)

? ? ? ? 需要注意的是,这些装饰器的用途更加特定,它们不像@sio.event@sio.on那样常用。在大多数应用中,你可能只需要使用@sio.event@sio.on

Socket.IO内置事件

? ? ? ? Socket.IO定义了一些内置的事件,这些事件在客户端和服务器之间的通信过程中自动触发。以下是一些常见的内置事件:

  1. connect: 当客户端成功连接到服务器时触发。

  2. disconnect: 当客户端从服务器断开连接时触发。

  3. message?或?data: 当客户端接收到来自服务器的消息时触发。

  4. error: 当发生错误时触发。

除了这些内置事件,你还可以定义自己的自定义事件。自定义事件的名称可以是任何字符串,只要它不与内置事件的名称冲突。你可以使用socket.emit('my event', data)来发送一个自定义事件,然后在另一端使用socket.on('my event', function(data) {})来接收这个事件。

需要注意的是,虽然Socket.IO允许你定义自己的自定义事件,但是在设计你的应用时,你应该尽量使用内置事件,只有在必要的时候才使用自定义事件。这是因为内置事件已经被优化过,而且它们的行为在所有的Socket.IO实现中都是一致的。

文章来源:https://blog.csdn.net/weixin_47420447/article/details/135614138
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。