mirror of
https://github.com/fastapiadmin/FastapiAdmin.git
synced 2026-09-22 05:02:57 +00:00
refactor: 完成项目大规模代码重构与依赖清理
这是一次综合性的重构更新,包含以下主要变更: 1. 升级Python版本到3.12,更新依赖配置 2. 替换旧的.j2模板为.jinja2格式,新增代码生成模板 3. 重构权限过滤策略,更新权限枚举与模型配置 4. 移除Prefect依赖,替换为自研拓扑并行执行引擎 5. 重构认证与上下文管理,拆分租户/请求上下文 6. 简化响应模型、CRUD与服务层代码 7. 清理废弃的支付网关模块,重构订单定时任务 8. 更新在线用户、监控等模块的接口与路由 9. 优化邮件模板与工具类,新增邮件模板文件 10. 修复数据库会话配置与类型提示
This commit is contained in:
+29
-127
@@ -1,14 +1,9 @@
|
||||
|
||||
from collections.abc import AsyncGenerator
|
||||
from typing import Any
|
||||
|
||||
from fastapi import Depends, FastAPI
|
||||
from fastapi.concurrency import asynccontextmanager
|
||||
from fastapi.openapi.docs import (
|
||||
get_redoc_html,
|
||||
get_swagger_ui_html,
|
||||
get_swagger_ui_oauth2_redirect_html,
|
||||
)
|
||||
from fastapi.openapi.docs import get_redoc_html, get_swagger_ui_html, get_swagger_ui_oauth2_redirect_html
|
||||
from fastapi.responses import HTMLResponse
|
||||
from fastapi.staticfiles import StaticFiles
|
||||
from fastapi_cache import FastAPICache
|
||||
@@ -22,20 +17,11 @@ from .core.http_limit import http_limit_callback, ws_limit_callback
|
||||
from .core.logger import logger
|
||||
from .scripts.initialize import InitializeData
|
||||
from .utils.common_util import import_module, import_modules_async
|
||||
from .utils.console import console_close, console_run
|
||||
from .utils.console import console_end, console_start
|
||||
|
||||
|
||||
@asynccontextmanager
|
||||
async def lifespan(app: FastAPI) -> AsyncGenerator[Any, Any]:
|
||||
"""
|
||||
自定义 FastAPI 应用生命周期。
|
||||
|
||||
参数:
|
||||
- app (FastAPI): FastAPI 应用实例。
|
||||
|
||||
返回:
|
||||
- AsyncGenerator[Any, Any]: 生命周期上下文生成器。
|
||||
"""
|
||||
from app.api.v1.module_platform.tenant.service import TenantService
|
||||
from app.api.v1.module_system.dict.service import DictDataService
|
||||
from app.api.v1.module_system.params.service import ParamsService
|
||||
@@ -43,16 +29,14 @@ async def lifespan(app: FastAPI) -> AsyncGenerator[Any, Any]:
|
||||
|
||||
try:
|
||||
await InitializeData().init_db()
|
||||
logger.info(f"✅ {settings.DATABASE_TYPE}数据库初始化完成")
|
||||
await import_modules_async(
|
||||
modules=settings.EVENT_LIST, desc="全局事件", app=app, status=True
|
||||
)
|
||||
logger.info("✅ %s数据库初始化完成", settings.DATABASE_TYPE)
|
||||
await import_modules_async(modules=settings.EVENT_LIST, desc="全局事件", app=app, status=True)
|
||||
logger.info("✅ 全局事件模块加载完成")
|
||||
await ParamsService.init_config_service(redis=app.state.redis)
|
||||
logger.info("✅ Redis系统配置初始化完成")
|
||||
await DictDataService.init_dict_service(redis=app.state.redis)
|
||||
await ParamsService.init_cache(redis=app.state.redis)
|
||||
logger.info("✅ Redis系统参数初始化完成")
|
||||
await DictDataService.init_cache(redis=app.state.redis)
|
||||
logger.info("✅ Redis数据字典初始化完成")
|
||||
await TenantService.init_tenant_config_cache(redis=app.state.redis)
|
||||
await TenantService.init_cache(redis=app.state.redis)
|
||||
logger.info("✅ Redis租户配置初始化完成")
|
||||
await SchedulerUtil.init_scheduler(redis=app.state.redis)
|
||||
logger.info("✅ 定时任务调度器初始化完成")
|
||||
@@ -63,30 +47,17 @@ async def lifespan(app: FastAPI) -> AsyncGenerator[Any, Any]:
|
||||
ws_callback=ws_limit_callback,
|
||||
)
|
||||
logger.info("✅ 请求限流器初始化完成")
|
||||
# fastapi-cache2 初始化:复用 app.state.redis 主连接
|
||||
FastAPICache.init(
|
||||
backend=RedisBackend(app.state.redis),
|
||||
prefix="fastapi-admin-cache",
|
||||
expire=300, # 默认 5 分钟
|
||||
enable=True,
|
||||
)
|
||||
FastAPICache.init(backend=RedisBackend(app.state.redis), prefix="fastapi-admin-cache", expire=300, enable=True)
|
||||
logger.info("✅ fastapi-cache2 初始化完成")
|
||||
|
||||
# 导入并显示最终的启动信息面板
|
||||
from app.common.enums import EnvironmentEnum
|
||||
|
||||
console_run(
|
||||
host=settings.SERVER_HOST,
|
||||
port=settings.SERVER_PORT,
|
||||
reload=settings.ENVIRONMENT == EnvironmentEnum.DEV,
|
||||
database_ready=True,
|
||||
redis_ready=True,
|
||||
scheduler_ready=SchedulerUtil.is_running(),
|
||||
limiter_ready=True,
|
||||
console_start(
|
||||
host=settings.SERVER_HOST, port=settings.SERVER_PORT,
|
||||
reload=settings.ENVIRONMENT,
|
||||
database_ready=True, redis_ready=True,
|
||||
scheduler_ready=SchedulerUtil.is_running(), limiter_ready=True,
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"❌ 应用初始化失败: {e!s}")
|
||||
logger.error("❌ 应用初始化失败: %s", e)
|
||||
raise SystemExit(1)
|
||||
|
||||
yield
|
||||
@@ -103,128 +74,59 @@ async def lifespan(app: FastAPI) -> AsyncGenerator[Any, Any]:
|
||||
from app.core.database import async_engine
|
||||
await async_engine.dispose()
|
||||
logger.info("✅ 数据库引擎连接池已释放")
|
||||
|
||||
console_close()
|
||||
|
||||
console_end()
|
||||
except Exception as e:
|
||||
logger.error(f"❌ 应用关闭过程中发生错误: {e!s}")
|
||||
logger.error("❌ 应用关闭过程中发生错误: %s", e)
|
||||
raise SystemExit(1)
|
||||
|
||||
|
||||
def register_middlewares(app: FastAPI) -> None:
|
||||
"""
|
||||
注册全局中间件。
|
||||
|
||||
参数:
|
||||
- app (FastAPI): FastAPI 应用实例。
|
||||
|
||||
返回:
|
||||
- None
|
||||
"""
|
||||
|
||||
for middleware in settings.MIDDLEWARE_LIST[::-1]:
|
||||
if not middleware:
|
||||
continue
|
||||
middleware = import_module(middleware, desc="中间件")
|
||||
app.add_middleware(middleware)
|
||||
|
||||
# 注册多租户 ORM 过滤器(导入即触发 @event.listens_for 注册)
|
||||
import app.core.tenant_filter # noqa: F401
|
||||
|
||||
|
||||
def register_exceptions(app: FastAPI) -> None:
|
||||
"""
|
||||
统一注册异常处理器。
|
||||
|
||||
参数:
|
||||
- app (FastAPI): FastAPI 应用实例。
|
||||
|
||||
返回:
|
||||
- None
|
||||
"""
|
||||
handle_exception(app)
|
||||
|
||||
|
||||
def register_routers(app: FastAPI) -> None:
|
||||
"""
|
||||
注册根路由。
|
||||
|
||||
参数:
|
||||
- app (FastAPI): FastAPI 应用实例。
|
||||
|
||||
返回:
|
||||
- None
|
||||
"""
|
||||
from app.api.v1.module_common import common_router
|
||||
from app.api.v1.module_monitor import monitor_router
|
||||
from app.api.v1.module_platform import platform_router
|
||||
from app.api.v1.module_system import system_router
|
||||
|
||||
# 业务路由(带速率限制)
|
||||
app.include_router(common_router, dependencies=[Depends(RateLimiter(times=200, seconds=10))])
|
||||
app.include_router(system_router, dependencies=[Depends(RateLimiter(times=200, seconds=10))])
|
||||
app.include_router(platform_router, dependencies=[Depends(RateLimiter(times=200, seconds=10))])
|
||||
app.include_router(monitor_router, dependencies=[Depends(RateLimiter(times=200, seconds=10))])
|
||||
|
||||
from app.core.discover import get_dynamic_router, set_app_ref
|
||||
from app.plugin.module_ai.chat.ws import WS_AI
|
||||
|
||||
# 手动注册WebSocket路由,不使用速率限制器
|
||||
app.include_router(
|
||||
router=WS_AI, dependencies=[Depends(WebSocketRateLimiter(times=1, seconds=5))]
|
||||
)
|
||||
# 先将动态路由注册到应用,使用速率限制器
|
||||
from app.core.discover import get_dynamic_router, set_app_ref
|
||||
for router in (common_router, system_router, platform_router, monitor_router):
|
||||
app.include_router(router, dependencies=[Depends(RateLimiter(times=settings.RATE_LIMITER_TIMES, seconds=settings.RATE_LIMITER_SECONDS))])
|
||||
|
||||
# 获取动态路由实例
|
||||
app.include_router(
|
||||
router=get_dynamic_router(),
|
||||
dependencies=[Depends(RateLimiter(times=200, seconds=10))],
|
||||
)
|
||||
# 保存 app 引用,供热重载时操作 app.routes
|
||||
app.include_router(router=get_dynamic_router(), dependencies=[Depends(RateLimiter(times=settings.RATE_LIMITER_TIMES, seconds=settings.RATE_LIMITER_SECONDS))])
|
||||
set_app_ref(app)
|
||||
|
||||
logger.info("✅ 应用启动完成")
|
||||
app.include_router(router=WS_AI, dependencies=[Depends(WebSocketRateLimiter(times=settings.WS_RATE_LIMITER_TIMES, seconds=settings.WS_RATE_LIMITER_SECONDS))])
|
||||
|
||||
|
||||
def register_files(app: FastAPI) -> None:
|
||||
"""
|
||||
注册静态资源挂载和文件相关配置。
|
||||
|
||||
参数:
|
||||
- app (FastAPI): FastAPI 应用实例。
|
||||
|
||||
返回:
|
||||
- None
|
||||
"""
|
||||
# 挂载静态文件目录
|
||||
if settings.STATIC_ENABLE:
|
||||
# 确保静态资源根目录存在
|
||||
settings.STATIC_ROOT.mkdir(parents=True, exist_ok=True)
|
||||
app.mount(
|
||||
path=settings.STATIC_URL,
|
||||
app=StaticFiles(directory=settings.STATIC_ROOT),
|
||||
name=settings.STATIC_DIR,
|
||||
)
|
||||
app.mount(path=settings.STATIC_URL, app=StaticFiles(directory=settings.STATIC_ROOT), name=settings.STATIC_DIR)
|
||||
|
||||
|
||||
def reset_api_docs(app: FastAPI) -> None:
|
||||
"""
|
||||
使用本地静态资源自定义 API 文档页面(Swagger UI 与 ReDoc)。
|
||||
swagger_ui_redirect_url = str(app.swagger_ui_oauth2_redirect_url)
|
||||
root_openapi_url = str(app.root_path) + str(app.openapi_url)
|
||||
|
||||
参数:
|
||||
- app (FastAPI): FastAPI 应用实例。
|
||||
|
||||
返回:
|
||||
- None
|
||||
"""
|
||||
|
||||
@app.get(str(app.swagger_ui_oauth2_redirect_url), include_in_schema=False)
|
||||
@app.get(swagger_ui_redirect_url, include_in_schema=False)
|
||||
async def swagger_ui_redirect():
|
||||
return get_swagger_ui_oauth2_redirect_html()
|
||||
|
||||
@app.get(settings.DOCS_URL, include_in_schema=False)
|
||||
async def custom_swagger_ui_html() -> HTMLResponse:
|
||||
return get_swagger_ui_html(
|
||||
openapi_url=str(app.root_path) + str(app.openapi_url),
|
||||
openapi_url=root_openapi_url,
|
||||
title=app.title + " - Swagger UI",
|
||||
oauth2_redirect_url=app.swagger_ui_oauth2_redirect_url,
|
||||
swagger_js_url=settings.SWAGGER_JS_URL,
|
||||
@@ -235,7 +137,7 @@ def reset_api_docs(app: FastAPI) -> None:
|
||||
@app.get(settings.REDOC_URL, include_in_schema=False)
|
||||
async def custom_redoc_html():
|
||||
return get_redoc_html(
|
||||
openapi_url=str(app.root_path) + str(app.openapi_url),
|
||||
openapi_url=root_openapi_url,
|
||||
title=app.title + " - ReDoc",
|
||||
redoc_js_url=settings.REDOC_JS_URL,
|
||||
redoc_favicon_url=settings.FAVICON_URL,
|
||||
|
||||
Reference in New Issue
Block a user