Files
FastapiAdmin/backend/app/core/database.py
T
zhangtao c2ca6d19ac refactor: 优化代码注释和文档字符串格式
style: 统一代码风格和格式

docs: 完善函数和方法的文档字符串

refactor(base_model): 移除冗余的表名和表参数生成方法

refactor(constant): 更新返回码注释格式

refactor(router_class): 添加路由处理器的详细文档

refactor(database): 完善数据库连接函数的文档

refactor(security): 添加认证类和方法的详细文档

refactor(validator): 更新验证器函数的文档格式

refactor(serialize): 优化序列化工具类的文档

refactor(response): 完善响应类的文档字符串

refactor(dependencies): 添加依赖函数的详细文档

refactor(initialize): 完善初始化脚本的文档

refactor(plugin): 添加生命周期和中间件注册的文档

refactor(service): 完善服务层方法的文档

refactor(controller): 添加控制器方法的详细文档

refactor(crud): 完善CRUD操作的文档字符串

refactor(schema): 简化模型类并移除冗余字段

refactor(param): 更新查询参数类的注释格式

refactor(template): 优化代码生成模板的格式

refactor(console): 添加控制台输出功能的实现

refactor(util): 完善工具函数的文档字符串
2025-10-18 16:31:28 +08:00

139 lines
4.6 KiB
Python

# -*- coding: utf-8 -*-
from redis.asyncio import Redis
from redis import exceptions
from motor.motor_asyncio import AsyncIOMotorClient
from fastapi import FastAPI
from sqlalchemy import create_engine, Engine
from sqlalchemy.orm import sessionmaker
from sqlalchemy.ext.asyncio import (
create_async_engine,
async_sessionmaker,
AsyncSession,
AsyncEngine
)
from app.core.logger import logger
from app.config.setting import settings
from app.core.exceptions import CustomException
# 同步数据库引擎
engine: Engine = create_engine(
url=settings.DB_URI,
echo=settings.DATABASE_ECHO,
pool_pre_ping=settings.POOL_PRE_PING,
pool_recycle=settings.POOL_RECYCLE,
)
# 同步数据库会话工厂
SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
# 异步数据库引擎
async_engine: AsyncEngine = create_async_engine(
url=settings.ASYNC_DB_URI,
echo=settings.DATABASE_ECHO,
echo_pool=settings.ECHO_POOL,
pool_pre_ping=settings.POOL_PRE_PING,
future=settings.FUTURE,
pool_recycle=settings.POOL_RECYCLE,
# pool_size=settings.POOL_SIZE, # sqlite 不支持
# max_overflow=settings.MAX_OVERFLOW, # sqlite 不支持
# pool_timeout=settings.POOL_TIMEOUT, # sqlite 不支持
)
# 异步数据库会话工厂
AsyncSessionLocal = async_sessionmaker(
bind=async_engine,
autocommit=settings.AUTOCOMMIT,
autoflush=settings.AUTOFETCH,
expire_on_commit=settings.EXPIRE_ON_COMMIT,
class_=AsyncSession
)
def session_connect() -> AsyncSession:
"""
获取异步数据库会话连接。
返回:
- AsyncSession: 异步数据库会话连接。
"""
try:
if not settings.SQL_DB_ENABLE:
raise CustomException(msg="请先开启数据库连接", data="请启用 app/config/setting.py: SQL_DB_ENABLE")
return AsyncSessionLocal()
except Exception as e:
raise CustomException(msg=f"数据库连接失败: {e}")
async def redis_connect(app: FastAPI, status: bool) -> Redis | None:
"""
创建或关闭Redis连接。
参数:
- app (FastAPI): FastAPI应用实例。
- status (bool): 连接状态,True为创建连接,False为关闭连接。
返回:
- Redis | None: Redis连接实例,如果连接失败则返回None。
"""
if not settings.REDIS_ENABLE:
raise CustomException(msg="请先开启Redis连接", data="请启用 app/core/config.py: REDIS_ENABLE")
if status:
try:
rd = await Redis.from_url(
url=settings.REDIS_URI,
encoding='utf-8',
decode_responses=True,
health_check_interval=20,
max_connections=settings.POOL_SIZE,
socket_timeout=settings.POOL_TIMEOUT
)
app.state.redis = rd
if await rd.ping():
logger.info("✅️ Redis连接成功...")
return rd
raise CustomException(msg="Redis连接失败")
except exceptions.AuthenticationError as e:
raise exceptions.AuthenticationError(f"Redis认证失败: {e}")
except exceptions.TimeoutError as e:
raise exceptions.TimeoutError(f"Redis连接超时: {e}")
except exceptions.RedisError as e:
raise exceptions.RedisError(f"Redis连接错误: {e}")
else:
await app.state.redis.close()
logger.info('Redis连接已关闭')
async def mongodb_connect(app: FastAPI, status: bool) -> AsyncIOMotorClient | None:
"""
创建或关闭MongoDB连接。
参数:
- app (FastAPI): FastAPI应用实例。
- status (bool): 连接状态,True为创建连接,False为关闭连接。
返回:
- AsyncIOMotorClient | None: MongoDB异步客户端实例,如果连接失败则返回None。
"""
if not settings.MONGO_DB_ENABLE:
raise CustomException(msg="请先开启MongoDB连接", data="请启用 app/core/config.py: MONGO_DB_ENABLE")
if status:
try:
client = AsyncIOMotorClient(
settings.MONGO_DB_URI,
maxPoolSize=settings.POOL_SIZE,
minPoolSize=settings.MAX_OVERFLOW,
serverSelectionTimeoutMS=settings.POOL_TIMEOUT * 1000
)
app.state.mongo_client = client
app.state.mongo = client[settings.MONGO_DB_NAME]
data = await client.server_info()
logger.info("MongoDB连接成功...", data)
return client
except Exception as e:
raise ValueError(f"MongoDB连接失败: {e}")
else:
app.state.mongo_client.close()
logger.info("❌️ MongoDB连接已关闭")