mirror of
https://github.com/fastapiadmin/FastapiAdmin.git
synced 2026-09-25 21:57:48 +00:00
zhangtao
8949f6dc46
1. 调整多个测试文件中TestClient的导入顺序，统一放到conftest导入之后 2. 删除后端配置中无用的WebSocket限流配置，统一使用全局200次/10秒的限流策略 3. 精简平台、系统模块的路由初始化注释文档 4. 优化conftest.py中的数据库初始化导入顺序 5. 调整初始化日志输出格式，更清晰易懂 6. 前端开发环境配置切回本地后端地址，注释远程服务地址 7. 重构路由类的变量命名，提升可读性 8. 简化动态路由热重载逻辑，移除冗余缓存变量 9. 重构注册路由的代码，统一限流配置，调整导入顺序和挂载逻辑 10. 删除冗余的v1接口层统一导出文件
342 lines
16 KiB
Python
Executable File
342 lines
16 KiB
Python
Executable File
import os
|
||
from functools import lru_cache
|
||
from pathlib import Path
|
||
from typing import Any, Literal
|
||
from urllib.parse import quote_plus
|
||
|
||
from pydantic_settings import BaseSettings, SettingsConfigDict
|
||
|
||
from app.common.enums import EnvironmentEnum
|
||
from app.config.path_conf import BASE_DIR, ENV_DIR
|
||
|
||
|
||
class Settings(BaseSettings):
|
||
"""系统配置类"""
|
||
|
||
model_config = SettingsConfigDict(
|
||
env_file=ENV_DIR / f".env.{os.getenv('ENVIRONMENT')}",
|
||
env_file_encoding="utf-8",
|
||
extra="ignore",
|
||
case_sensitive=True, # 区分大小写
|
||
)
|
||
|
||
# ================================================= #
|
||
# ******************* 项目环境 ****************** #
|
||
# ================================================= #
|
||
ENVIRONMENT: EnvironmentEnum = EnvironmentEnum.DEV
|
||
|
||
# ================================================= #
|
||
# ******************* 服务器配置 ****************** #
|
||
# ================================================= #
|
||
SERVER_HOST: str = "0.0.0.0" # 允许访问的IP地址
|
||
SERVER_PORT: int = 8001 # 服务端口
|
||
|
||
# ================================================= #
|
||
# ******************* API文档配置 ****************** #
|
||
# ================================================= #
|
||
DEBUG: bool = True # 调试模式
|
||
TITLE: str = "🎉 FastapiAdmin 🎉 " # 文档标题
|
||
VERSION: str = "0.1.0" # 版本号
|
||
DESCRIPTION: str = (
|
||
"该项目是一个基于python的web服务框架，基于fastapi和sqlalchemy实现。" # 文档描述
|
||
)
|
||
SUMMARY: str = "接口汇总" # 文档概述
|
||
DOCS_URL: str = "/docs" # Swagger UI路径
|
||
REDOC_URL: str = "/redoc" # ReDoc路径
|
||
LJDOC_URL: str = "/ljdoc" # LangJin UI路径
|
||
ROOT_PATH: str = "/api/v1" # API路由前缀
|
||
|
||
# ================================================= #
|
||
# ******************** 日志配置 ******************** #
|
||
# ================================================= #
|
||
LOGGER_LEVEL: str = "DEBUG" # 日志级别
|
||
|
||
# ================================================= #
|
||
# ******************** 跨域配置 ******************** #
|
||
# ================================================= #
|
||
CORS_ORIGIN_ENABLE: bool = True # 是否启用跨域
|
||
ALLOW_ORIGINS: list[str] = ["*"] # 允许的域名列表
|
||
ALLOW_METHODS: list[str] = ["*"] # 允许的HTTP方法
|
||
ALLOW_HEADERS: list[str] = ["*"] # 允许的请求头
|
||
ALLOW_CREDENTIALS: bool = True # 是否允许携带cookie
|
||
CORS_EXPOSE_HEADERS: list[str] = ["X-Request-ID"]
|
||
|
||
# ================================================= #
|
||
# ******************* 登录认证配置 ****************** #
|
||
# ================================================= #
|
||
SECRET_KEY: str = "vgb0tnl9d58+6n-6h-ea&u^1#s0ccp!794=krylxcjq75vzps$" # JWT密钥
|
||
ALGORITHM: str = "HS256" # JWT算法
|
||
ACCESS_TOKEN_EXPIRE_MINUTES: int = 60 * 60 * 12 # access_token过期时间(秒)12 小时
|
||
REFRESH_TOKEN_EXPIRE_MINUTES: int = 60 * 60 * 12 # refresh_token过期时间(秒)12 小时
|
||
TOKEN_TYPE: str = "Bearer" # token类型（RFC 6750 标准大小写）
|
||
TOKEN_REQUEST_PATH_EXCLUDE: list[str] = ["api/v1/auth/login"] # JWT / RBAC 路由白名单
|
||
TOKEN_SLIDING_EXPIRE: bool = True # 是否启用滑动过期(用户操作时自动续期)
|
||
|
||
# 多租户中间件白名单路径（不需要租户上下文的公开接口）
|
||
TENANT_WHITELIST_PATHS: list[str] = [
|
||
"/api/v1/system/auth/",
|
||
"/api/v1/health",
|
||
"/api/v1/common/health",
|
||
]
|
||
|
||
# ================================================= #
|
||
# ******************* 支付配置 ******************* #
|
||
# ================================================= #
|
||
PAYMENT_GATEWAY: str = "mock" # alipay / wxpay / mock
|
||
# 支付宝
|
||
PAYMENT_ALIPAY_APP_ID: str = ""
|
||
PAYMENT_ALIPAY_PRIVATE_KEY: str = ""
|
||
PAYMENT_ALIPAY_PUBLIC_KEY: str = ""
|
||
PAYMENT_ALIPAY_SANDBOX: bool = True
|
||
# 微信支付
|
||
PAYMENT_WXPAY_APP_ID: str = ""
|
||
PAYMENT_WXPAY_MCH_ID: str = ""
|
||
PAYMENT_WXPAY_API_KEY: str = ""
|
||
# 站点 URL（用于生成支付通知 URL）
|
||
SITE_URL: str = "http://localhost:8001"
|
||
|
||
# 多租户：通配子域与登录租户一致（默认关闭；生产按 base 解析 {code}.base）
|
||
TENANT_HOST_ENFORCE: bool = False
|
||
TENANT_HOST_BASE_DOMAIN: str = ""
|
||
TENANT_HOST_IGNORE_PREFIXES: list[str] = ["www", "api", "admin"]
|
||
|
||
# ================================================= #
|
||
# ******************** 数据库配置 ******************* #
|
||
# ================================================= #
|
||
SQL_DB_ENABLE: bool = True # 是否启用数据库
|
||
DATABASE_ECHO: bool | Literal["debug"] = False # 是否显示SQL日志
|
||
ECHO_POOL: bool | Literal["debug"] = False # 是否显示连接池日志
|
||
POOL_SIZE: int = 10 # 连接池大小
|
||
MAX_OVERFLOW: int = 20 # 最大溢出连接数
|
||
POOL_TIMEOUT: int = 30 # 连接超时时间(秒)
|
||
POOL_RECYCLE: int = 1800 # 连接回收时间(秒)
|
||
POOL_USE_LIFO: bool = True # 是否使用LIFO连接池
|
||
POOL_PRE_PING: bool = True # 是否开启连接预检
|
||
FUTURE: bool = True # 是否使用SQLAlchemy 2.0特性
|
||
AUTOCOMMIT: bool = False # 是否自动提交（映射 SQLAlchemy sessionmaker(autocommit=...)）
|
||
AUTOFLUSH: bool = False # 是否自动刷新（映射 SQLAlchemy sessionmaker(autoflush=...)）
|
||
AUTOFETCH: bool | None = None # 兼容旧环境变量名（保留别名，避免 .env 中已有 AUTOFETCH 的部署报错）
|
||
EXPIRE_ON_COMMIT: bool = False # 是否在提交时过期
|
||
|
||
# MySQL/PostgreSQL数据库连接
|
||
DATABASE_TYPE: Literal["mysql", "postgres", "sqlite"] = "mysql"
|
||
DATABASE_HOST: str = "localhost"
|
||
DATABASE_PORT: int = 3306
|
||
DATABASE_USER: str = "root"
|
||
DATABASE_PASSWORD: str = ""
|
||
DATABASE_NAME: str = "fastapiadmin"
|
||
|
||
# ================================================= #
|
||
# ******************** Redis配置 ******************* #
|
||
# ================================================= #
|
||
REDIS_ENABLE: bool = True # 是否启用Redis
|
||
REDIS_HOST: str = "localhost"
|
||
REDIS_PORT: int = 6379
|
||
REDIS_DB_NAME: int = 1
|
||
REDIS_USER: str = ""
|
||
REDIS_PASSWORD: str = ""
|
||
REDIS_URL: str = "" # 完整 Redis URL，优先级最高（redis://user:pass@host:port/db）
|
||
|
||
# ================================================= #
|
||
# ******************** 验证码配置 ******************* #
|
||
# ================================================= #
|
||
CAPTCHA_ENABLE: bool = True # 是否启用验证码
|
||
CAPTCHA_EXPIRE_SECONDS: int = 60 * 1 # 验证码过期时间(秒) 1分钟
|
||
CAPTCHA_FONT_SIZE: int = 32 # 字体大小
|
||
CAPTCHA_FONT_PATH: str = "static/assets/font/Arial.ttf" # 字体路径
|
||
|
||
# ================================================= #
|
||
# ***************** 第三方 OAuth 登录（可选）********* #
|
||
# ================================================= #
|
||
# 自动注册用户的默认角色 ID 列表（须与库中角色主键一致）
|
||
OAUTH_DEFAULT_ROLE_IDS: list[int] = [2]
|
||
# 回调异常时回跳的前端地址（与前端实际 /login 一致，含协议与端口）
|
||
OAUTH_FRONTEND_FALLBACK: str = "http://127.0.0.1:5173/login"
|
||
OAUTH_GITHUB_CLIENT_ID: str = ""
|
||
OAUTH_GITHUB_CLIENT_SECRET: str = ""
|
||
OAUTH_GITEE_CLIENT_ID: str = ""
|
||
OAUTH_GITEE_CLIENT_SECRET: str = ""
|
||
OAUTH_WECHAT_OPEN_APP_ID: str = ""
|
||
OAUTH_WECHAT_OPEN_APP_SECRET: str = ""
|
||
OAUTH_QQ_APP_ID: str = ""
|
||
OAUTH_QQ_APP_SECRET: str = ""
|
||
|
||
# ================================================= #
|
||
# ******************* 外部 HTTP（httpx）******************* #
|
||
# ================================================= #
|
||
HTTPX_DEFAULT_TIMEOUT: float = 10.0 # 对外请求默认超时（秒），见 app/common/httpx_defaults.py
|
||
IP_LOCATION_ENABLE: bool = True # 是否启用 IP 归属地查询（登录时对外发起 HTTP 请求）
|
||
|
||
# ================================================= #
|
||
# ********************* 日志配置 ******************* #
|
||
# ================================================= #
|
||
# 是否额外写入 JSON Lines（loguru ``serialize=True``，与控制台/info.log 同源，便于日志平台采集）
|
||
LOG_JSON_FILE_ENABLE: bool = False
|
||
LOG_JSON_FILE_NAME: str = "app.jsonl" # 相对 LOG_DIR
|
||
LOG_JSON_RETENTION_DAYS: int = 7 # JSON 文件保留天数（通常比文本日志短）
|
||
|
||
OPERATION_LOG_RECORD: bool = True # 是否记录操作日志
|
||
IGNORE_OPERATION_FUNCTION: list[str] = ["get_captcha_for_login"] # 忽略记录的函数
|
||
OPERATION_RECORD_METHOD: list[str] = [
|
||
"POST",
|
||
"PUT",
|
||
"PATCH",
|
||
"DELETE",
|
||
"HEAD",
|
||
"OPTIONS",
|
||
] # 需要记录的请求方法
|
||
|
||
# ================================================= #
|
||
# ******************* Gzip压缩配置 ******************* #
|
||
# ================================================= #
|
||
GZIP_ENABLE: bool = True # 是否启用Gzip
|
||
GZIP_MIN_SIZE: int = 1000 # 最小压缩大小(字节)
|
||
GZIP_COMPRESS_LEVEL: int = 9 # 压缩级别(1-9)
|
||
|
||
# ================================================= #
|
||
# ***************** 安全响应头配置 ***************** #
|
||
# ================================================= #
|
||
HSTS_ENABLE: bool = False # 是否启用 HSTS（生产环境建议 True，开发环境 False）
|
||
|
||
# ================================================= #
|
||
# ***************** 静态文件配置 ***************** #
|
||
# ================================================= #
|
||
STATIC_ENABLE: bool = True # 是否启用静态文件
|
||
STATIC_URL: str = "/static" # 访问路由
|
||
STATIC_DIR: str = "static" # 目录名
|
||
STATIC_ROOT: Path = BASE_DIR.joinpath(STATIC_DIR) # 绝对路径
|
||
|
||
# ================================================= #
|
||
# ***************** 动态文件配置 ***************** #
|
||
# ================================================= #
|
||
UPLOAD_FILE_PATH: Path = Path("static/upload") # 上传目录
|
||
UPLOAD_MACHINE: str = "A" # 上传机器标识
|
||
ALLOWED_EXTENSIONS: list[str] = [ # 允许的文件类型
|
||
".gif",
|
||
".jpg",
|
||
".jpeg",
|
||
".png",
|
||
".ico",
|
||
".svg",
|
||
".xls",
|
||
".xlsx",
|
||
]
|
||
MAX_FILE_SIZE: int = 10 * 1024 * 1024 # 最大文件大小(10MB)
|
||
|
||
# ================================================= #
|
||
# ***************** Swagger配置 ***************** #
|
||
# ================================================= #
|
||
SWAGGER_CSS_URL: str = "static/swagger/swagger-ui/swagger-ui.css"
|
||
SWAGGER_JS_URL: str = "static/swagger/swagger-ui/swagger-ui-bundle.js"
|
||
REDOC_JS_URL: str = "static/swagger/redoc/bundles/redoc.standalone.js"
|
||
FAVICON_URL: str = "static/image/favicon.ico"
|
||
|
||
# ================================================= #
|
||
# ******************* AI大模型配置 ****************** #
|
||
# ================================================= #
|
||
OPENAI_API_KEY: str = ""
|
||
OPENAI_MODEL: str = ""
|
||
OPENAI_BASE_URL: str = "" # API Base URL，如 https://api.minimax.chat/v1
|
||
|
||
# ================================================= #
|
||
# ******************* ChromaDB配置 ****************** #
|
||
# ================================================= #
|
||
CHROMA_PERSIST_DIR: str = str(BASE_DIR / "data" / "chroma") # ChromaDB 持久化目录
|
||
CHROMA_COLLECTION_NAME: str = "knowledge_base" # ChromaDB 集合名称
|
||
|
||
# ================================================= #
|
||
# ******************* 请求限制配置 ****************** #
|
||
# ================================================= #
|
||
REQUEST_LIMITER_REDIS_PREFIX: str = "fastapiadmin:request_limiter:"
|
||
RATE_LIMITER_TIMES: int = 200
|
||
RATE_LIMITER_SECONDS: int = 10
|
||
|
||
# ================================================= #
|
||
# ******************* 重构配置 ******************* #
|
||
# ================================================= #
|
||
@property
|
||
def MIDDLEWARE_LIST(self) -> list[str | None]:
|
||
# 中间件列表（注册时逆序叠加：下列第一项在列表中最前，最终位于最外层，优先生效）
|
||
# 中间件执行顺序（从外到内）：
|
||
# CORS → RequestLog → SecurityHeaders → GZip → CorrelationId → 业务路由
|
||
MIDDLEWARES: list[str | None] = [
|
||
"app.core.middlewares.CustomCORSMiddleware" if self.CORS_ORIGIN_ENABLE else None,
|
||
"app.core.middlewares.RequestLogMiddleware" if self.OPERATION_LOG_RECORD else None,
|
||
"app.core.middlewares.CustomGZipMiddleware" if self.GZIP_ENABLE else None,
|
||
"app.core.middlewares.SecurityHeadersMiddleware", # 安全响应头
|
||
"app.core.middlewares.CorrelationIdMiddleware", # 请求上下文
|
||
"app.core.middlewares.TenantMiddleware", # 租户上下文（需 JWT）
|
||
]
|
||
return MIDDLEWARES
|
||
|
||
@property
|
||
def EVENT_LIST(self) -> list[str | None]:
|
||
EVENTS: list[str | None] = [
|
||
"app.core.database.redis_connect" if self.REDIS_ENABLE else None,
|
||
]
|
||
return EVENTS
|
||
|
||
@property
|
||
def ASYNC_DB_URI(self) -> str:
|
||
if self.DATABASE_TYPE not in ("mysql", "postgres", "sqlite"):
|
||
raise ValueError(
|
||
f"数据库驱动不支持: {self.DATABASE_TYPE}, 异步数据库请选择 mysql、postgres、sqlite"
|
||
)
|
||
db_connect: str = ""
|
||
if self.DATABASE_TYPE == "mysql":
|
||
db_connect = f"mysql+asyncmy://{self.DATABASE_USER}:{quote_plus(self.DATABASE_PASSWORD)}@{self.DATABASE_HOST}:{self.DATABASE_PORT}/{self.DATABASE_NAME}?charset=utf8mb4"
|
||
elif self.DATABASE_TYPE == "postgres":
|
||
db_connect = f"postgresql+asyncpg://{self.DATABASE_USER}:{quote_plus(self.DATABASE_PASSWORD)}@{self.DATABASE_HOST}:{self.DATABASE_PORT}/{self.DATABASE_NAME}"
|
||
else:
|
||
db_connect = f"sqlite+aiosqlite:///{self.DATABASE_NAME}.db"
|
||
return db_connect
|
||
|
||
@property
|
||
def DB_URI(self) -> str:
|
||
if self.DATABASE_TYPE not in ("mysql", "postgres", "sqlite"):
|
||
raise ValueError(
|
||
f"数据库驱动不支持: {self.DATABASE_TYPE}, 同步数据库请选择 mysql、postgres、sqlite"
|
||
)
|
||
db_connect: str = ""
|
||
if self.DATABASE_TYPE == "mysql":
|
||
db_connect = f"mysql+pymysql://{self.DATABASE_USER}:{quote_plus(self.DATABASE_PASSWORD)}@{self.DATABASE_HOST}:{self.DATABASE_PORT}/{self.DATABASE_NAME}?charset=utf8mb4"
|
||
elif self.DATABASE_TYPE == "postgres":
|
||
db_connect = f"postgresql+psycopg://{self.DATABASE_USER}:{quote_plus(self.DATABASE_PASSWORD)}@{self.DATABASE_HOST}:{self.DATABASE_PORT}/{self.DATABASE_NAME}"
|
||
else:
|
||
db_connect = f"sqlite:///{self.DATABASE_NAME}.db"
|
||
return db_connect
|
||
|
||
@property
|
||
def REDIS_URI(self) -> str:
|
||
return f"redis://{self.REDIS_USER}:{self.REDIS_PASSWORD}@{self.REDIS_HOST}:{self.REDIS_PORT}/{self.REDIS_DB_NAME}"
|
||
|
||
@property
|
||
def FASTAPI_CONFIG(self) -> dict[str, Any]:
|
||
return {
|
||
"debug": self.DEBUG,
|
||
"title": self.TITLE,
|
||
"version": self.VERSION,
|
||
"description": self.DESCRIPTION,
|
||
"summary": self.SUMMARY,
|
||
"docs_url": None,
|
||
"redoc_url": None,
|
||
"root_path": self.ROOT_PATH,
|
||
"responses": {
|
||
200: {"description": "成功"},
|
||
400: {"description": "请求参数错误"},
|
||
401: {"description": "未认证"},
|
||
403: {"description": "未授权"},
|
||
404: {"description": "资源不存在"},
|
||
422: {"description": "请求参数验证错误"},
|
||
500: {"description": "服务器内部错误"},
|
||
},
|
||
}
|
||
|
||
|
||
@lru_cache(maxsize=1)
|
||
def get_settings() -> Settings:
|
||
return Settings()
|
||
|
||
|
||
settings = get_settings()
|