Python-SocketIO 服务器开发完全指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01091/article/details/148548820

Python-SocketIO 服务器开发完全指南

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

Socket.IO 是一个流行的实时通信协议，而 python-socketio 则是其 Python 实现。本文将深入讲解如何使用 python-socketio 构建功能强大的实时服务器应用。

核心概念与安装

python-socketio 提供了两种服务器实现：

socketio.Server：基于 Python 标准库的同步实现
socketio.AsyncServer：基于 asyncio 的异步实现

安装非常简单：

pip install python-socketio

服务器创建与运行

创建服务器实例

同步服务器创建：

import socketio
sio = socketio.Server()

异步服务器创建：

import socketio
sio = socketio.AsyncServer()

运行服务器

Socket.IO 服务器需要与 Web 服务器配合使用，支持两种集成方式：

WSGI 集成（同步）

app = socketio.WSGIApp(sio)

可与 Flask/Django 等 WSGI 应用集成：

from flask import Flask
flask_app = Flask(__name__)
app = socketio.WSGIApp(sio, flask_app)

ASGI 集成（异步）

app = socketio.ASGIApp(sio)

可与 FastAPI 等 ASGI 应用集成：

from fastapi import FastAPI
fastapi_app = FastAPI()
app = socketio.ASGIApp(sio, fastapi_app)

静态文件服务

开发环境下可配置静态文件服务：

static_files = {
    '/': 'index.html',
    '/static': './public'
}
app = socketio.WSGIApp(sio, static_files=static_files)

注意：生产环境应使用专业静态文件服务器。

事件处理机制

Socket.IO 的核心是基于事件的通信模型。

基本事件处理

@sio.event
def my_event(sid, data):
    print(f"收到来自 {sid} 的数据: {data}")

异步版本：

@sio.event
async def my_event(sid, data):
    await some_async_operation()

连接与断开事件

@sio.event
def connect(sid, environ, auth):
    if not validate_auth(auth):
        raise ConnectionRefusedError('认证失败')
    print(f"客户端 {sid} 已连接")

@sio.event
def disconnect(sid, reason):
    print(f"客户端 {sid} 已断开，原因: {reason}")

全局事件处理器

@sio.on('*')
def catch_all(event, sid, data):
    print(f"收到未处理事件 {event}: {data}")

事件发射与确认

向客户端发送事件

广播给所有客户端：

sio.emit('server_message', {'data': '广播消息'})

发送给特定客户端：

sio.emit('private_message', {'data': '私密消息'}, to=user_sid)

确认机制

服务器确认：

@sio.event
def need_ack(sid, data):
    return "处理成功", 123

请求客户端确认：

response = sio.call('ask_client', {'question': '你还好吗?'}, to=user_sid)

房间管理

房间机制允许对客户端进行分组通信。

@sio.event
def join_room(sid, room_name):
    sio.enter_room(sid, room_name)

@sio.event
def leave_room(sid, room_name):
    sio.leave_room(sid, room_name)

@sio.event
def chat_message(sid, data):
    sio.emit('new_message', data, room='chat_room', skip_sid=sid)

命名空间

命名空间允许多个逻辑连接共享物理连接。

装饰器方式

@sio.event(namespace='/chat')
def chat_message(sid, data):
    sio.emit('response', data, namespace='/chat')

类方式

class ChatNamespace(socketio.Namespace):
    def on_connect(self, sid, environ):
        print(f"客户端 {sid} 连接到聊天室")

    def on_message(self, sid, data):
        self.emit('response', data, room=sid)

sio.register_namespace(ChatNamespace('/chat'))

异步版本：

class AsyncChatNamespace(socketio.AsyncNamespace):
    async def on_message(self, sid, data):
        await self.emit('response', data, room=sid)

sio.register_namespace(AsyncChatNamespace('/chat'))