fix and optimize plugin router inject

Author: wu-clan

backend/app/admin/api/v1/sys/__init__.py

@@ -22,7 +22,7 @@
 router.include_router(dept_router, prefix='/depts', tags=['系统部门'])
 router.include_router(dict_data_router, prefix='/dict-datas', tags=['系统字典数据'])
 router.include_router(dict_type_router, prefix='/dict-types', tags=['系统字典类型'])
-router.include_router(menu_router, prefix='/menus', tags=['系统目录'])
+router.include_router(menu_router, prefix='/menus', tags=['系统菜单'])
 router.include_router(role_router, prefix='/roles', tags=['系统角色'])
 router.include_router(user_router, prefix='/users', tags=['系统用户'])
 router.include_router(data_rule_router, prefix='/data-rules', tags=['系统数据权限规则'])

backend/core/registrar.py

@@ -10,7 +10,6 @@
 from fastapi_pagination import add_pagination
 from starlette.middleware.authentication import AuthenticationMiddleware
 
-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
@@ -159,8 +158,11 @@ def register_router(app: FastAPI):
     dependencies = [Depends(demo_site)] if settings.DEMO_MODE else None
 
     # API
-    new_router = plugin_router_inject(router)
-    app.include_router(new_router, dependencies=dependencies)
+    plugin_router_inject()
+
+    from backend.app.router import router  # 必须在插件路由注入后导入
+
+    app.include_router(router, dependencies=dependencies)
 
     # Extra
     ensure_unique_route_names(app)

backend/main.py

@@ -1,20 +1,5 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-from pathlib import Path
-
-import uvicorn
-
 from backend.core.registrar import register_app
 
 app = register_app()
-
-
-if __name__ == '__main__':
-    # 如果你喜欢在 IDE 中进行 DEBUG，main 启动方法会很有帮助
-    # 如果你喜欢通过 print 方式进行调试，建议使用 fastapi cli 方式启动服务
-    try:
-        config = uvicorn.Config(app=f'{Path(__file__).stem}:app', reload=True)
-        server = uvicorn.Server(config)
-        server.run()
-    except Exception as e:
-        raise e

backend/plugin/notice/schema/notice.py

@@ -13,7 +13,7 @@ class NoticeSchemaBase(SchemaBase):
     type: int
     author: str
     source: str
-    status: StatusType = Field(StatusType.enable)
+    status: StatusType = Field(default=StatusType.enable)
     content: str
 
 

backend/plugin/tools.py

@@ -1,6 +1,5 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-import importlib
 import inspect
 import os
 import warnings
@@ -10,6 +9,7 @@
 from fastapi import APIRouter
 
 from backend.core.path_conf import PLUGIN_DIR
+from backend.utils.import_parse import import_module_cached
 
 
 def get_plugins() -> list[str]:
@@ -32,19 +32,18 @@ def get_plugin_models() -> list:
     plugins = get_plugins()
     for plugin in plugins:
         module_path = f'backend.plugin.{plugin}.model'
-        module = importlib.import_module(module_path)
+        module = import_module_cached(module_path)
         for name, obj in inspect.getmembers(module):
             if inspect.isclass(obj):
                 classes.append(obj)
     return classes
 
 
-def plugin_router_inject(router: APIRouter) -> APIRouter:
+def plugin_router_inject() -> None:
     """
     插件路由注入
 
-    :param router: 源总路由器
-    :return: 注入插件路由后的总路由器
+    :return:
     """
     plugins = get_plugins()
     for plugin in plugins:
@@ -66,17 +65,17 @@ def plugin_router_inject(router: APIRouter) -> APIRouter:
 
         # 路由注入
         if app_name:
-            # 非独立应用：将插件中的路由注入到源程序对应模块的路由中
+            # 非独立应用：将插件路由注入到对应模块的路由中
             for root, _, api_files in os.walk(plugin_api_path):
                 for file in api_files:
                     if file.endswith('.py') and file != '__init__.py':
-                        api_files_path = os.path.join(root, file)
+                        file_path = os.path.join(root, file)
 
                         # 获取插件路由模块
-                        path_to_module_str = os.path.relpath(api_files_path, PLUGIN_DIR).replace(os.sep, '.')[:-3]
+                        path_to_module_str = os.path.relpath(file_path, PLUGIN_DIR).replace(os.sep, '.')[:-3]
                         module_path = f'backend.plugin.{path_to_module_str}'
                         try:
-                            module = importlib.import_module(module_path)
+                            module = import_module_cached(module_path)
                         except ImportError as e:
                             raise ImportError(f'导入模块 {module_path} 失败：{e}') from e
                         plugin_router = getattr(module, 'router', None)
@@ -91,7 +90,7 @@ def plugin_router_inject(router: APIRouter) -> APIRouter:
                         relative_path = os.path.relpath(root, plugin_api_path)
                         target_module_path = f'backend.app.{app_name}.api.{relative_path.replace(os.sep, ".")}'
                         try:
-                            target_module = importlib.import_module(target_module_path)
+                            target_module = import_module_cached(target_module_path)
                         except ImportError as e:
                             raise ImportError(f'导入目标模块 {target_module_path} 失败：{e}') from e
                         target_router = getattr(target_module, 'router', None)
@@ -102,18 +101,21 @@ def plugin_router_inject(router: APIRouter) -> APIRouter:
                         target_router.include_router(
                             router=plugin_router,
                             prefix=prefix,
-                            tags=tags if type(tags) is list else [tags],
+                            tags=tags if tags == [] else [tags],
                         )
         else:
-            # 独立应用：将插件中的路由直接注入到 app 中
+            # 独立应用：将插件中的路由直接注入到总路由中
             module_path = f'backend.plugin.{plugin}.api.router'
             try:
-                target_module = importlib.import_module(module_path)
+                module = import_module_cached(module_path)
             except ImportError as e:
                 raise ImportError(f'导入目标模块 {module_path} 失败：{e}') from e
-            target_router = getattr(target_module, 'router', None)
-            if not target_router or not isinstance(target_router, APIRouter):
+            plugin_router = getattr(module, 'router', None)
+            if not plugin_router or not isinstance(plugin_router, APIRouter):
                 raise AttributeError(f'目标模块 {module_path} 中没有有效的 router，请检查插件文件是否完整')
-            router.include_router(target_router)
+            target_module_path = 'backend.app.router'
+            target_module = import_module_cached(target_module_path)
+            target_router = getattr(target_module, 'router')
 
-    return router
+            # 将插件路由注入到目标 router 中
+            target_router.include_router(plugin_router)

backend/run.py

@@ -0,0 +1,14 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+import uvicorn
+
+if __name__ == '__main__':
+    # 为什么独立此启动文件：https://stackoverflow.com/questions/64003384
+    # 如果你喜欢在 IDE 中进行 DEBUG，可在 IDE 中直接右键启动此文件
+    # 如果你喜欢通过 print 方式进行调试，建议使用 fastapi cli 方式启动服务
+    try:
+        config = uvicorn.Config(app='backend.main:app', reload=True)
+        server = uvicorn.Server(config)
+        server.run()
+    except Exception as e:
+        raise e