Add asynchronous socketio application server

Author: wu-clan

backend/app/task/README.md

@@ -1,6 +1,7 @@
 ## 任务介绍
 
-当前任务使用 Celery 实现，实施方案请查看 [#225](https://github.com/orgs/fastapi-practices/discussions/225)
+当前任务使用 Celery
+实现，实施方案请查看 [#225](https://github.com/fastapi-practices/fastapi_best_architecture/discussions/225)
 
 ## 添加任务
 

backend/common/socket.py

@@ -0,0 +1,26 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+import socketio
+
+from backend.common.log import log
+from backend.core.conf import settings
+
+sio = socketio.AsyncServer(
+    async_mode='asgi',
+    cors_credentials=True,
+    cors_allowed_origins=settings.CORS_ALLOWED_ORIGINS,
+    namespaces=['/ws'],
+    logger=True,
+    engineio_logger=True
+)
+
+
+@sio.event
+async def connect(sid, environ):
+    log.debug(sid, environ)
+    await sio.emit('message', {'data': 'Welcome!'}, to=sid)
+
+
+@sio.event
+async def disconnect(sid):
+    log.debug(sid)

backend/core/registrar.py

@@ -2,6 +2,8 @@
 # -*- coding: utf-8 -*-
 from contextlib import asynccontextmanager
 
+import socketio
+
 from asgi_correlation_id import CorrelationIdMiddleware
 from fastapi import Depends, FastAPI
 from fastapi_limiter import FastAPILimiter
@@ -11,6 +13,7 @@
 from backend.app.router import route
 from backend.common.exception.exception_handler import register_exception
 from backend.common.log import set_customize_logfile, setup_logging
+from backend.common.socket import sio
 from backend.core.conf import settings
 from backend.core.path_conf import STATIC_DIR
 from backend.database.db_mysql import create_table
@@ -79,6 +82,9 @@ def register_app():
     # 全局异常处理
     register_exception(app)
 
+    # socket 应用
+    register_socket_app(app)
+
     return app
 
 
@@ -106,6 +112,7 @@ def register_static_file(app: FastAPI):
 
         if not os.path.exists(STATIC_DIR):
             os.mkdir(STATIC_DIR)
+
         app.mount('/static', StaticFiles(directory=STATIC_DIR), name='static')
 
 
@@ -170,3 +177,14 @@ def register_page(app: FastAPI):
     :return:
     """
     add_pagination(app)
+
+
+def register_socket_app(app: FastAPI):
+    """
+    socketio
+
+    :param app:
+    :return:
+    """
+    socket_app = socketio.ASGIApp(sio, app)
+    app.mount('/ws', socket_app)

backend/pdm.lock

@@ -50,6 +50,7 @@ dependencies = [
     # https://github.com/celery/celery/issues/7874
     "celery-aio-pool==0.1.0rc6",
     "asgi-correlation-id>=4.3.3",
+    "python-socketio[asyncio]>=5.11.4",
 ]
 requires-python = ">=3.10,<3.13"
 readme = "README.md"

backend/pyproject.toml

@@ -12,6 +12,7 @@ async-timeout==4.0.3; python_full_version < "3.11.3"
 asyncmy==0.2.9
 attrs==24.2.0
 bcrypt==4.0.1
+bidict==0.23.1
 billiard==4.2.0
 casbin==1.34.0
 casbin-async-sqlalchemy-adapter==1.4.0
@@ -84,8 +85,11 @@ pytest==7.2.2
 pytest-pretty==1.2.0
 python-dateutil==2.9.0.post0
 python-dotenv==1.0.1
+python-engineio==4.9.1
 python-jose==3.3.0
 python-multipart==0.0.9
+python-socketio==5.11.4
+python-socketio[asyncio]==5.11.4
 pytz==2024.1
 pyyaml==6.0.2
 redis==5.1.0
@@ -95,6 +99,7 @@ rsa==4.9
 ruff==0.6.4
 setuptools==74.1.2
 shellingham==1.5.4
+simple-websocket==1.0.0
 simpleeval==0.9.13
 six==1.16.0
 sniffio==1.3.1
@@ -120,4 +125,5 @@ watchfiles==0.24.0
 wcwidth==0.2.13
 websockets==13.0.1
 win32-setctime==1.1.0; sys_platform == "win32"
+wsproto==1.2.0
 xdbsearchip==1.0.2