main.py 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
  1. import os
  2. from typing import Annotated
  3. import typer
  4. import uvicorn
  5. from alembic import command
  6. from alembic.config import Config
  7. from fastapi import FastAPI
  8. from app.common.enums import EnvironmentEnum
  9. fastapiadmin_cli = typer.Typer()
  10. alembic_cfg = Config("alembic.ini")
  11. def create_app() -> FastAPI:
  12. """
  13. 创建 FastAPI 应用实例并完成日志、中间件、路由与静态资源注册。
  14. 返回:
  15. - FastAPI: 已配置生命周期的应用对象。
  16. """
  17. from app.config.setting import settings
  18. from app.scripts.init_app import (
  19. lifespan,
  20. register_exceptions,
  21. register_files,
  22. register_middlewares,
  23. register_routers,
  24. reset_api_docs,
  25. )
  26. # 创建FastAPI应用
  27. app = FastAPI(**settings.FASTAPI_CONFIG, lifespan=lifespan)
  28. from app.core.logger import setup_logging
  29. # 初始化日志
  30. setup_logging()
  31. # 注册各种组件
  32. register_exceptions(app)
  33. # 注册中间件
  34. register_middlewares(app)
  35. # 注册路由
  36. register_routers(app)
  37. # 注册静态文件
  38. register_files(app)
  39. # 重设API文档
  40. reset_api_docs(app)
  41. return app
  42. # typer.Option是非必填;typer.Argument是必填
  43. @fastapiadmin_cli.command(
  44. name="run",
  45. help="启动 FastapiAdmin 服务, 运行 python main.py run --env=dev 不加参数默认 dev 环境",
  46. )
  47. def run(
  48. env: Annotated[
  49. EnvironmentEnum, typer.Option("--env", help="运行环境 (dev, prod)")
  50. ] = EnvironmentEnum.DEV,
  51. ) -> None:
  52. """
  53. 按指定环境加载配置并启动 Uvicorn(开发环境开启 reload)。
  54. 参数:
  55. - env (EnvironmentEnum): 运行环境,对应 `--env`。
  56. 返回:
  57. - None
  58. """
  59. try:
  60. # 设置环境变量
  61. os.environ["ENVIRONMENT"] = env.value
  62. typer.echo("项目启动中...")
  63. # 清除配置缓存,确保重新加载配置
  64. from app.config.setting import get_settings
  65. get_settings.cache_clear()
  66. settings = get_settings()
  67. from app.core.logger import setup_logging
  68. setup_logging()
  69. # 显示启动横幅
  70. from app.utils.banner import worship
  71. worship(env.value)
  72. # 启动uvicorn服务
  73. uvicorn.run(
  74. app="main:create_app",
  75. host=settings.SERVER_HOST,
  76. port=settings.SERVER_PORT,
  77. reload=env.value == EnvironmentEnum.DEV.value,
  78. factory=True,
  79. log_config=None,
  80. )
  81. finally:
  82. from app.core.logger import cleanup_logging
  83. cleanup_logging()
  84. @fastapiadmin_cli.command(
  85. name="revision",
  86. help="生成新的 Alembic 迁移脚本, 运行 python main.py revision --env=dev",
  87. )
  88. def revision(
  89. env: Annotated[
  90. EnvironmentEnum, typer.Option("--env", help="运行环境 (dev, prod)")
  91. ] = EnvironmentEnum.DEV,
  92. ) -> None:
  93. """
  94. 使用 Alembic 自动生成迁移脚本(autogenerate)。
  95. 参数:
  96. - env (EnvironmentEnum): 运行环境,用于加载对应数据库模型元数据。
  97. 返回:
  98. - None
  99. """
  100. os.environ["ENVIRONMENT"] = env.value
  101. from app.config.setting import get_settings
  102. get_settings.cache_clear()
  103. command.revision(alembic_cfg, autogenerate=True, message="迁移脚本")
  104. typer.echo("迁移脚本已生成")
  105. @fastapiadmin_cli.command(
  106. name="upgrade",
  107. help="应用最新的 Alembic 迁移, 运行 python main.py upgrade --env=dev",
  108. )
  109. def upgrade(
  110. env: Annotated[
  111. EnvironmentEnum, typer.Option("--env", help="运行环境 (dev, prod)")
  112. ] = EnvironmentEnum.DEV,
  113. ) -> None:
  114. """
  115. 将数据库升级到 Alembic 最新版本(head)。
  116. 参数:
  117. - env (EnvironmentEnum): 运行环境。
  118. 返回:
  119. - None
  120. """
  121. os.environ["ENVIRONMENT"] = env.value
  122. from app.config.setting import get_settings
  123. get_settings.cache_clear()
  124. command.upgrade(alembic_cfg, "head")
  125. typer.echo("所有迁移已应用。")
  126. if __name__ == "__main__":
  127. fastapiadmin_cli()