Python-SocketIO 入门指南：实现实时双向通信

林广红Winthrop

于 2025-06-10 09:01:14 发布

阅读量244

点赞数 3

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00452/article/details/148548815

Python-SocketIO 入门指南：实现实时双向通信

python-socketio Python Socket.IO server and client 项目地址: https://gitcode.com/gh_mirrors/py/python-socketio

什么是 Socket.IO？

Socket.IO 是一种传输协议，它能够在客户端（通常是 Web 浏览器）和服务器之间实现基于事件的实时双向通信。虽然官方实现是基于 JavaScript 的，但 Python-SocketIO 项目提供了完整的 Python 实现，包含标准版本和 asyncio 异步版本。

Socket.IO 的核心优势在于它抽象了底层传输机制，开发者无需关心具体使用的是 WebSocket 还是 HTTP 长轮询等技术细节。它会自动选择最佳传输方式，并在连接断开时自动重连，为开发者提供了简单可靠的实时通信解决方案。

版本兼容性说明

Socket.IO 协议经历了多次修订，部分版本存在不兼容的情况，因此客户端和服务器必须使用兼容的版本才能正常工作。以下是 Python-SocketIO 与 JavaScript 参考实现的版本对应关系：

| JavaScript 版本 | Socket.IO 协议版本 | Engine.IO 协议版本 | Python-SocketIO 版本 | Python-EngineIO 版本 | |----------------|-------------------|-------------------|---------------------|---------------------| | 0.9.x | 1, 2 | 1, 2 | 不支持 | 不支持 | | 1.x 和 2.x | 3, 4 | 3 | 4.x | 3.x | | 3.x 和 4.x | 5 | 4 | 5.x | 4.x |

最佳实践建议：如果同时使用 Python 客户端和服务器，最简单的方法是保持两者的 Python-SocketIO 版本一致。如果与 JavaScript 等其他语言实现交互，则需要确保协议版本兼容。

客户端开发指南

基础客户端示例

下面展示一个标准的 Python Socket.IO 客户端实现：

import socketio

sio = socketio.Client()

@sio.event
def connect():
    print('连接已建立')

@sio.event
def my_message(data):
    print('收到消息:', data)
    sio.emit('my_response', {'response': '我的响应'})

@sio.event
def disconnect():
    print('与服务器断开连接')

sio.connect('http://localhost:5000')
sio.wait()

异步客户端示例 (Python 3.5+)

对于异步应用，可以使用 AsyncClient：

import asyncio
import socketio

sio = socketio.AsyncClient()

@sio.event
async def connect():
    print('连接已建立')

@sio.event
async def my_message(data):
    print('收到消息:', data)
    await sio.emit('my_response', {'response': '我的响应'})

@sio.event
async def disconnect():
    print('与服务器断开连接')

async def main():
    await sio.connect('http://localhost:5000')
    await sio.wait()

if __name__ == '__main__':
    asyncio.run(main())

客户端核心特性

多协议支持：兼容 JavaScript Socket.IO 参考服务器实现
Python 版本：支持 Python 3.8 及以上版本
双模式：提供标准 Python 和 asyncio 两种实现
事件驱动：使用装饰器简化事件处理逻辑
传输机制：自动选择 HTTP 长轮询或 WebSocket 传输
自动恢复：连接断开时自动尝试重连

服务器端开发指南

基于 Eventlet 的服务器示例

import eventlet
import socketio

sio = socketio.Server()
app = socketio.WSGIApp(sio, static_files={
    '/': {'content_type': 'text/html', 'filename': 'index.html'}
})

@sio.event
def connect(sid, environ):
    print('客户端连接:', sid)

@sio.event
def my_message(sid, data):
    print('收到消息:', data)

@sio.event
def disconnect(sid):
    print('客户端断开:', sid)

if __name__ == '__main__':
    eventlet.wsgi.server(eventlet.listen(('', 5000)), app)

基于 Asyncio 的服务器示例

from aiohttp import web
import socketio

sio = socketio.AsyncServer()
app = web.Application()
sio.attach(app)

async def index(request):
    with open('index.html') as f:
        return web.Response(text=f.read(), content_type='text/html')

@sio.event
def connect(sid, environ):
    print("客户端连接:", sid)

@sio.event
async def chat_message(sid, data):
    print("收到消息:", data)

@sio.event
def disconnect(sid):
    print('客户端断开:', sid)

app.router.add_static('/static', 'static')
app.router.add_get('/', index)

if __name__ == '__main__':
    web.run_app(app)