FastAPI-SQLA 使用指南

FastAPI-SQLA 使用指南

FastAPI-SQLA 是一个专为 FastAPI 设计的 SQLAlchemy 扩展，简化了与数据库交互的过程，并支持分页、异步操作、SQLModel 及集成 pytest 进行测试。该库适用于生产环境，由 Dialogue MD 团队在蒙特利尔开发并维护。

本教程将指导您了解此项目的目录结构、启动文件以及配置文件的使用。

1. 项目目录结构及介绍

尽管具体的 GitHub 仓库没有直接提供在这里，我们通常可以预期一个基于 FastAPI-SQLA 的标准项目会有以下基本结构：

fastapi_sqla_project/
│
├── app
│   ├── models     # 存放 SQLAlchemy 或 SQLModel 定义的模型类
│   ├── routes     # 包含所有路由逻辑的文件夹
│   │   └── user.py    # 示例：处理用户相关端点
│   ├── dependencies.py # 依赖项注入定义，例如 SQLAlchemy 的 session
│   └── main.py      # 应用的主入口文件
│
├── tests            # 测试文件夹
│   └── test_user.py    # 对用户相关的功能进行单元测试
│
├── config.py        # 配置文件，存放数据库连接字符串等信息
├── requirements.txt # 项目所需包列表
└── README.md        # 项目说明文件

主要文件介绍

• main.py: 应用的核心启动文件，包含了初始化设置，如 lifespan 管理器和中间件的设置。
• models.py: 存储定义的数据库模型，每个类对应数据库中的一个表。
• dependencies.py: 提供依赖注入，确保路径操作函数能访问到 SQLAlchemy 的 Session 对象。
• config.py: 包含应用运行必要的配置，重点是数据库URL (sqlalchemy_url)。

2. 项目的启动文件介绍

启动文件通常指的是 app/main.py。其核心代码可能包括通过 FastAPI 提供的 lifespan 机制来启动和关闭 SQLAlchemy 连接，示例代码如下：

from fastapi import FastAPI
import fastapi_sqla

app = FastAPI()

@app.on_event("startup")
async def startup():
    await fastapi_sqla.startup()

@app.on_event("shutdown")
async def shutdown():
    await fastapi_sqla.shutdown()

或者采用推荐的异步上下文管理方式：

from fastapi import FastAPI
from contextlib import asynccontextmanager
import fastapi_sqla

@asynccontextmanager
async def lifespan(app: FastAPI):
    await fastapi_sqla.startup()
    yield
    await fastapi_sqla.shutdown()

app = FastAPI(lifespan=lifespan)

3. 项目的配置文件介绍

配置文件，如假设的 config.py，是用来存放敏感数据或应用配置的，例如数据库连接字符串。一个简单的 config.py 示例可能是这样的：

sqlalchemy_url = 'postgresql+asyncpg://username:password@host/dbname'

在实际应用中，你应该避免硬编码这些敏感信息，并考虑使用环境变量或外部秘密管理系统来安全地管理它们。

以上就是基于 FastAPI-SQLA 的项目的基本架构、启动流程及配置文件解读。请根据实际情况调整你的项目结构和配置。