FastAPI-SocketIO 项目教程

1. 项目的目录结构及介绍

FastAPI-SocketIO 项目的目录结构如下：

fastapi-socketio/
├── CONTRIBUTORS.md
├── LICENSE
├── Pipfile
├── Pipfile.lock
├── README.md
├── setup.py
├── fastapi_socketio/
│   ├── __init__.py
│   └── socket_manager.py
├── examples/
│   └── fastapi_socketio/
│       ├── app.py
│       └── socket_handlers.py
└── tests/
    └── test_socket_manager.py

目录结构介绍

• CONTRIBUTORS.md: 贡献者列表。
• LICENSE: 项目许可证。
• Pipfile 和 Pipfile.lock: 用于管理项目依赖。
• README.md: 项目说明文档。
• setup.py: 项目安装脚本。
• fastapi_socketio/: 核心库目录，包含 __init__.py 和 socket_manager.py。
• examples/: 示例代码目录，包含 app.py 和 socket_handlers.py。
• tests/: 测试代码目录，包含 test_socket_manager.py。

2. 项目的启动文件介绍

项目的启动文件位于 examples/fastapi_socketio/app.py。以下是启动文件的代码示例：

from fastapi import FastAPI
from fastapi_socketio import SocketManager
import uvicorn

app = FastAPI()
socket_manager = SocketManager(app=app, mount_location="/ws")

@socket_manager.on('connect', namespace="/ws")
async def connect(sid, environ):
    print(sid)
    print(environ)

if __name__ == "__main__":
    uvicorn.run(app, host="localhost", port=8000)

启动文件介绍

• FastAPI 实例化：创建一个 FastAPI 应用实例。
• SocketManager 实例化：将 SocketManager 与 FastAPI 应用关联，并指定挂载位置为 /ws。
• connect 事件处理：处理客户端连接事件，打印连接的客户端 ID 和环境信息。
• uvicorn.run：使用 Uvicorn 运行 FastAPI 应用。

3. 项目的配置文件介绍

项目的配置文件主要是 Pipfile 和 Pipfile.lock，它们用于管理项目的依赖。

Pipfile 示例

[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"

[packages]
fastapi = "*"
fastapi-socketio = "*"
uvicorn = "*"

[dev-packages]
pytest = "*"

[requires]
python_version = "3.8"

Pipfile 介绍

• [[source]]: 指定依赖源。
• [packages]: 项目运行所需的依赖包。
• [dev-packages]: 开发环境所需的依赖包。
• [requires]: 指定所需的 Python 版本。

通过这些配置文件，可以方便地管理项目的依赖关系，确保项目在不同环境中的一致性和可重复性。