FastAPI Websocket RPC 项目教程

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

FastAPI Websocket RPC 项目的目录结构如下：

fastapi_websocket_rpc/
├── examples/
│   ├── basic_example.py
│   ├── proxy_example.py
│   └── ...
├── fastapi_websocket_rpc/
│   ├── __init__.py
│   ├── client.py
│   ├── endpoint.py
│   ├── methods.py
│   └── ...
├── tests/
│   ├── __init__.py
│   ├── test_client.py
│   ├── test_endpoint.py
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── setup.py
└── ...

目录结构介绍

• examples/: 包含项目的示例代码，如 basic_example.py 和 proxy_example.py。
• fastapi_websocket_rpc/: 核心代码目录，包含客户端、服务端和方法处理等模块。
  • __init__.py: 初始化文件。
  • client.py: 客户端实现。
  • endpoint.py: 服务端端点实现。
  • methods.py: 方法处理实现。
• tests/: 测试代码目录，包含各种测试用例。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• setup.py: 项目安装配置文件。

2. 项目的启动文件介绍

项目的启动文件通常位于 examples/ 目录下，例如 basic_example.py。以下是 basic_example.py 的示例代码：

from fastapi import FastAPI
from fastapi_websocket_rpc import RpcMethodsBase, WebsocketRPCEndpoint

app = FastAPI()

# 定义服务端方法
class ConcatServer(RpcMethodsBase):
    async def concat(self, a: str = "", b: str = ""):
        return a + b

# 添加 RPC 端点
endpoint = WebsocketRPCEndpoint(ConcatServer())
endpoint.register_route(app, "/ws")

# 启动服务
if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host="0.0.0.0", port=8000)

启动文件介绍

• from fastapi import FastAPI: 导入 FastAPI 框架。
• from fastapi_websocket_rpc import RpcMethodsBase, WebsocketRPCEndpoint: 导入 RPC 相关模块。
• app = FastAPI(): 创建 FastAPI 应用实例。
• class ConcatServer(RpcMethodsBase): 定义服务端方法类。
• endpoint = WebsocketRPCEndpoint(ConcatServer()): 创建 RPC 端点实例。
• endpoint.register_route(app, "/ws"): 注册路由。
• if __name__ == "__main__":: 启动服务。

3. 项目的配置文件介绍

项目的配置文件主要是 setup.py，用于项目的安装和分发。以下是 setup.py 的示例代码：

from setuptools import setup, find_packages

setup(
    name="fastapi_websocket_rpc",
    version="0.1.26",
    packages=find_packages(),
    install_requires=[
        "fastapi",
        "websockets",
        "tenacity",
    ],
    author="Or Weis",
    author_email="[e-mail]",
    description="A fast and durable bidirectional JSON RPC channel over Websockets and FastApi",
    long_description=open("README.md").read(),
    long_description_content_type="text/markdown",
    url="https://github.com/permitio/fastapi_websocket_rpc",
    classifiers=[
        "Programming Language :: Python :: 3",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
    ],
    python_requires='>=3.7',
)

配置文件介绍

• name: 项目名称。
• version: 项目版本。
• packages: 包含的包。
• `install_