mirror of
https://github.com/fastapiadmin/FastapiAdmin.git
synced 2026-09-21 12:52:26 +00:00
zhangtao
73f2823692
1. 重构后端API路由、CRUD与模块结构，整合日志管理，移除废弃demo代码 2. 优化前端组件类型定义、样式与路由配置，修复权限判断逻辑 3. 调整默认排序规则、滚动条样式与工具类函数，更新依赖与配置文件 4. 修复多处类型不匹配与默认值问题，完善表单与菜单验证逻辑
243 lines
8.0 KiB
Python
243 lines
8.0 KiB
Python
|
|
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.responses import HTMLResponse
|
|
from fastapi.staticfiles import StaticFiles
|
|
from fastapi_cache import FastAPICache
|
|
from fastapi_cache.backends.redis import RedisBackend
|
|
from fastapi_limiter import FastAPILimiter
|
|
from fastapi_limiter.depends import RateLimiter, WebSocketRateLimiter
|
|
|
|
from .config.setting import settings
|
|
from .core.exceptions import handle_exception
|
|
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
|
|
|
|
|
|
@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
|
|
from app.core.ap_scheduler import SchedulerUtil
|
|
|
|
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("✅ 全局事件模块加载完成")
|
|
await ParamsService.init_config_service(redis=app.state.redis)
|
|
logger.info("✅ Redis系统配置初始化完成")
|
|
await DictDataService.init_dict_service(redis=app.state.redis)
|
|
logger.info("✅ Redis数据字典初始化完成")
|
|
await TenantService.init_tenant_config_cache(redis=app.state.redis)
|
|
logger.info("✅ Redis租户配置初始化完成")
|
|
await SchedulerUtil.init_scheduler(redis=app.state.redis)
|
|
logger.info("✅ 定时任务调度器初始化完成")
|
|
await FastAPILimiter.init(
|
|
redis=app.state.redis,
|
|
prefix=settings.REQUEST_LIMITER_REDIS_PREFIX,
|
|
http_callback=http_limit_callback,
|
|
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,
|
|
)
|
|
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,
|
|
)
|
|
|
|
except Exception as e:
|
|
logger.error(f"❌ 应用初始化失败: {e!s}")
|
|
raise SystemExit(1)
|
|
|
|
yield
|
|
|
|
try:
|
|
await SchedulerUtil.shutdown(wait=True)
|
|
logger.info("✅ 定时任务调度器已关闭")
|
|
await FastAPICache.clear()
|
|
logger.info("✅ fastapi-cache2 已关闭")
|
|
await FastAPILimiter.close()
|
|
logger.info("✅ 请求限制器已关闭")
|
|
await import_modules_async(modules=settings.EVENT_LIST, desc="全局事件", app=app, status=False)
|
|
logger.info("✅ 全局事件模块卸载完成")
|
|
from app.core.database import async_engine
|
|
await async_engine.dispose()
|
|
logger.info("✅ 数据库引擎连接池已释放")
|
|
|
|
console_close()
|
|
|
|
except Exception as e:
|
|
logger.error(f"❌ 应用关闭过程中发生错误: {e!s}")
|
|
|
|
|
|
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.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
|
|
|
|
# 获取动态路由实例
|
|
app.include_router(
|
|
router=get_dynamic_router(),
|
|
dependencies=[Depends(RateLimiter(times=200, seconds=10))],
|
|
)
|
|
# 保存 app 引用，供热重载时操作 app.routes
|
|
set_app_ref(app)
|
|
|
|
logger.info("✅ 应用启动完成")
|
|
|
|
|
|
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,
|
|
)
|
|
|
|
|
|
def reset_api_docs(app: FastAPI) -> None:
|
|
"""
|
|
使用本地静态资源自定义 API 文档页面（Swagger UI 与 ReDoc）。
|
|
|
|
参数:
|
|
- app (FastAPI): FastAPI 应用实例。
|
|
|
|
返回:
|
|
- None
|
|
"""
|
|
|
|
@app.get(str(app.swagger_ui_oauth2_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),
|
|
title=app.title + " - Swagger UI",
|
|
oauth2_redirect_url=app.swagger_ui_oauth2_redirect_url,
|
|
swagger_js_url=settings.SWAGGER_JS_URL,
|
|
swagger_css_url=settings.SWAGGER_CSS_URL,
|
|
swagger_favicon_url=settings.FAVICON_URL,
|
|
)
|
|
|
|
@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),
|
|
title=app.title + " - ReDoc",
|
|
redoc_js_url=settings.REDOC_JS_URL,
|
|
redoc_favicon_url=settings.FAVICON_URL,
|
|
)
|