add plugin route injection

Author: wu-clan

backend/alembic/env.py

@@ -16,7 +16,7 @@
 from backend.common.model import MappedBase
 from backend.core import path_conf
 from backend.database.db import SQLALCHEMY_DATABASE_URL
-from backend.plugin.plugin import get_plugin_models
+from backend.plugin.tools import get_plugin_models
 
 # import your new model here
 from backend.app.admin.model import *  # noqa: F401

backend/app/router.py

@@ -6,8 +6,8 @@
 from backend.app.generator.api.router import v1 as generator_v1
 from backend.app.task.api.router import v1 as task_v1
 
-route = APIRouter()
+router = APIRouter()
 
-route.include_router(admin_v1)
-route.include_router(generator_v1)
-route.include_router(task_v1)
+router.include_router(admin_v1)
+router.include_router(generator_v1)
+router.include_router(task_v1)

backend/core/registrar.py

@@ -10,7 +10,7 @@
 from fastapi_pagination import add_pagination
 from starlette.middleware.authentication import AuthenticationMiddleware
 
-from backend.app.router import route
+from backend.app.router import router
 from backend.common.exception.exception_handler import register_exception
 from backend.common.log import set_customize_logfile, setup_logging
 from backend.core.conf import settings
@@ -20,6 +20,7 @@
 from backend.middleware.jwt_auth_middleware import JwtAuthMiddleware
 from backend.middleware.opera_log_middleware import OperaLogMiddleware
 from backend.middleware.state_middleware import StateMiddleware
+from backend.plugin.tools import register_plugin_router
 from backend.utils.demo_site import demo_site
 from backend.utils.health_check import ensure_unique_route_names, http_limit_callback
 from backend.utils.openapi import simplify_operation_ids
@@ -39,7 +40,9 @@ async def register_init(app: FastAPI):
     await redis_client.open()
     # 初始化 limiter
     await FastAPILimiter.init(
-        redis=redis_client, prefix=settings.REQUEST_LIMITER_REDIS_PREFIX, http_callback=http_limit_callback
+        redis=redis_client,
+        prefix=settings.REQUEST_LIMITER_REDIS_PREFIX,
+        http_callback=http_limit_callback,
     )
 
     yield
@@ -77,6 +80,7 @@ def register_app():
 
     # 路由
     register_router(app)
+    register_plugin_router(app)
 
     # 分页
     register_page(app)
@@ -156,7 +160,7 @@ def register_router(app: FastAPI):
     dependencies = [Depends(demo_site)] if settings.DEMO_MODE else None
 
     # API
-    app.include_router(route, dependencies=dependencies)
+    app.include_router(router, dependencies=dependencies)
 
     # Extra
     ensure_unique_route_names(app)

backend/plugin/notice/plugin.toml

@@ -1,4 +1,9 @@
-# 属于哪个 app，如果为独立 app，则应设置为 'original'
+# 属于哪个 app，如果为独立 app，应设置为 ''
 app = 'admin'
-# api 版本，将生成对应版本路由
-api_version = 'v1'
+
+# api 配置，仅针对于非独立 app
+[api]
+# api 注入模块，将生成对应路由
+module = 'v1.sys'
+# 路由 prefix 配置
+prefix = 'notices'

backend/plugin/plugin.py

@@ -0,0 +1,89 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+import inspect
+import os
+
+import rtoml
+
+from fastapi import FastAPI
+
+from backend.core.path_conf import PLUGIN_DIR
+from backend.utils.import_parse import import_module_cached
+
+
+def get_plugins() -> list[str]:
+    """获取插件"""
+    plugin_packages = []
+
+    for item in os.listdir(PLUGIN_DIR):
+        item_path = os.path.join(PLUGIN_DIR, item)
+
+        if os.path.isdir(item_path):
+            if '__init__.py' in os.listdir(item_path):
+                plugin_packages.append(item)
+
+    return plugin_packages
+
+
+def get_plugin_models() -> list:
+    """获取插件所有模型类"""
+    classes = []
+    plugins = get_plugins()
+    for plugin in plugins:
+        module_path = f'backend.plugin.{plugin}.model'
+        module = import_module_cached(module_path)
+        for name, obj in inspect.getmembers(module):
+            if inspect.isclass(obj):
+                classes.append(obj)
+    return classes
+
+
+def register_plugin_router(app: FastAPI):
+    """
+    插件路由注入
+
+    :param app:
+    :return:
+    """
+    plugins = get_plugins()
+    for plugin in plugins:
+        toml_path = os.path.join(PLUGIN_DIR, plugin, 'plugin.toml')
+        if not os.path.exists(toml_path):
+            raise FileNotFoundError('插件缺少 plugin.toml 配置文件')
+
+        toml_data = rtoml.load(toml_path)
+        app_name = toml_data.get('app', '')
+        api_module = toml_data.get('api', {}).get('module', '')
+        prefix = toml_data.get('api', {}).get('prefix', '')
+
+        if app_name:
+            if '.' in api_module:
+                module_path = f'backend.app.{app_name}.api.{api_module}'
+            else:
+                module_path = f'backend.app.{app_name}.api'
+        else:
+            module_path = 'backend.app'
+
+        try:
+            module = import_module_cached(module_path)
+        except ImportError as e:
+            raise ImportError(f'导入模块 {module_path} 失败：{e}') from e
+        else:
+            if app_name and '.' in api_module:
+                # 从 backend.app.xxx.api.vx.xxx.__init__.py 文件中获取路由
+                router = getattr(module, 'router', None)
+            else:
+                if 'api' in module_path:
+                    # 从 backend.app.xxx.api 下的 router.py 文件中获取路由
+                    router = getattr(module, api_module.split('.')[0], None)
+                else:
+                    # 从 backend.app 下的 router.py 文件中获取路由
+                    router = getattr(module, 'router', None)
+
+            if not router:
+                raise ImportError(f'模块 {module_path} 中不存在路由')
+
+            if app_name:
+                app.include_router(router, prefix=f'/{prefix}')
+            else:
+                app.include_router(router)

backend/plugin/tools.py

@@ -45,6 +45,7 @@ dependencies = [
     "python-jose>=3.3.0",
     "python-socketio>=5.12.0",
     "redis[hiredis]>=5.2.0",
+    "rtoml>=0.12.0",
     "sqlalchemy-crud-plus==1.6.0",
     "sqlalchemy[asyncio]>=2.0.30",
     "user-agents==2.2.0",

backend/pyproject.toml

@@ -91,6 +91,7 @@ pyyaml==6.0.2
 redis==5.2.1
 rich==13.9.4
 rsa==4.9
+rtoml==0.12.0
 ruff==0.9.5
 shellingham==1.5.4
 simple-websocket==1.1.0