• FastAPI + Tortoise-ORM:异步数据库操作优秀实践

FastAPI + Tortoise-ORM:异步数据库操作优秀实践

2025-04-27 10:40:52 栏目:宝塔面板 188 阅读

在构建现代 Web 应用时,我们越来越追求 高性能 + 易维护 + 强扩展性。FastAPI 与 Tortoise-ORM 这对组合,正是实现 异步数据库操作 的黄金搭档。

本文将带你一步步搞定:

  • Tortoise-ORM 快速配置与初始化
  • 异步模型定义与操作
  • 项目结构推荐
  • 实用技巧与注意事项

为什么选 Tortoise-ORM?

Tortoise-ORM 是一个 类 Django 风格的异步 ORM,优雅 + 轻量 + 高性能。

优点包括:

  • 原生支持 async / await,异步性能更佳
  • 语法清晰,易于上手
  • 支持多数据库(PostgreSQL、MySQL、SQLite)
  • 自带迁移工具、强类型提示、关系管理

安装依赖

pip install fastapi[all] tortoise-orm

如果你使用 Alembic 等迁移工具,可以跳过,Tortoise 自带 aerich:

pip install aerich

目录结构推荐

app/
├── main.py              # 项目入口
├── models/              # 数据模型
│   └── user.py
├── schemas/             # Pydantic 模型
│   └── user.py
├── api/                 # 路由逻辑
│   └── user.py
├── core/
│   └── config.py        # 配置项
│   └── db.py            # 数据库初始化

定义模型(models/user.py)

from tortoise import fields
from tortoise.models import Model

class User(Model):
    id = fields.IntField(pk=True)
    name = fields.CharField(max_length=50)
    email = fields.CharField(max_length=100, unique=True)

    class Meta:
        table = "user"

配置数据库连接(core/db.py)

from tortoise.contrib.fastapi import register_tortoise
from fastapi import FastAPI

def init_db(app: FastAPI):
    register_tortoise(
        app,
        db_url="sqlite://db.sqlite3",  # 可替换为 mysql/postgres
        modules={"models": ["app.models.user"]},  # 关键点
        generate_schemas=True,  # 启动时自动创建表
        add_exception_handlers=True
    )

说明:

  • modules={"models": ["app.models.user"]} 指定模型路径(可传多个)
  • 会自动导入并注册这些模型

初始化数据库(main.py)

from fastapi import FastAPI
from app.core.db import init_db
from app.api import user

app = FastAPI()

init_db(app)  # 初始化 ORM

app.include_router(user.router)

编写接口(api/user.py)

from fastapi import APIRouter, HTTPException
from app.models.user import User
from app.schemas.user import UserIn, UserOut

router = APIRouter()

@router.post("/users", response_model=UserOut)
asyncdefcreate_user(user: UserIn):
    existing = await User.get_or_none(email=user.email)
    if existing:
        raise HTTPException(status_code=400, detail="邮箱已存在")
    user_obj = await User.create(**user.dict())
    return user_obj

@router.get("/users/{user_id}", response_model=UserOut)
asyncdefget_user(user_id: int):
    user = await User.get_or_none(id=user_id)
    ifnot user:
        raise HTTPException(status_code=404, detail="用户不存在")
    return user

Pydantic 模型(schemas/user.py)

from pydantic import BaseModel, EmailStr

class UserIn(BaseModel):
    name: str
    email: EmailStr

class UserOut(UserIn):
    id: int

使用 Aerich 管理迁移(可选)

初始化:

aerich init -t app.core.db.TORTOISE_ORM

生成迁移:

aerich init-db
aerich migrate
aerich upgrade

使用建议 & 常见问题

推荐做法:

  • 所有 ORM 操作都使用 await
  • 异步接口必须加 async def
  • 初始化模块路径必须写对,否则不会加载模型
  • 不建议手动写 SQL,除非非常必要

常见坑:

  • 没注册模型路径,表不会生成!
  • await 忘写,会返回协程对象
  • 生产环境请关闭 generate_schemas=True,使用迁移工具更稳

总结

FastAPI + Tortoise-ORM 能让你拥有:

  • 异步数据库高性能
  • 简洁优雅的模型定义
  • 良好的开发体验与类型安全

如果你追求异步、类型提示、快速开发,这是非常值得一试的组合!

本文地址:https://www.yitenyun.com/114.html

搜索文章

Tags

数据库 API FastAPI Calcite 电商系统 MySQL Web 应用 异步数据库 数据同步 ACK 双主架构 循环复制 Deepseek 宝塔面板 Linux宝塔 Docker 生命周期 JumpServer JumpServer安装 堡垒机安装 Linux安装JumpServer esxi esxi6 root密码不对 无法登录 web无法登录 序列 核心机制 Windows Windows server net3.5 .NET 安装出错 宝塔面板打不开 宝塔面板无法访问 SSL 堡垒机 跳板机 HTTPS 查看硬件 Linux查看硬件 Linux查看CPU Linux查看内存 无法访问宝塔面板 Windows宝塔 Mysql重置密码 HTTPS加密 连接控制 机制 ES 协同 Oracle 处理机制 Serverless 无服务器 语言 OB 单机版 scp Linux的scp怎么用 scp上传 scp下载 scp命令 Spring SQL 动态查询 存储 缓存方案 缓存架构 缓存穿透 技术 日志文件 MIXED 3 分页查询 索引 运维 架构 InnoDB 响应模型 修改DNS Centos7如何修改DNS Rsync RocketMQ 长轮询 配置 监控 HexHub Redis 电商 系统 Linux 安全 服务器 MySQL 9.3 异步化 防火墙 黑客 聚簇 非聚簇 查询 sftp 服务器 参数 数据 主库 SQLark PostgreSQL group by 自定义序列化 管理口 业务 SQLite-Web SQLite 数据库管理工具 开源 存储引擎 Doris SeaTunnel MVCC 人工智能 向量数据库 推荐系统 数据库锁 R edis 线程 共享锁 线上 库存 预扣 PG DBA 网络架构 工具 网络配置 加密 场景 AI 助手 Ftp ​Redis 机器学习 推荐模型 流量 数据备份 Python B+Tree ID 字段 RDB AOF 缓存 redo log 重做日志 高可用 优化 万能公式 • 索引 • 数据库 Redis 8.0 核心架构 订阅机制 Canal 信息化 智能运维 网络故障 INSERT COMPACT GreatSQL 连接数 云原生 微软 SQL Server AI功能 Hash 字段 Web 同城 双活 Postgres OTel Iceberg IT运维 prometheus Alert 不宕机 自动重启 Netstat Linux 服务器 端口 引擎 性能 大模型 SVM Embedding 高效统计 今天这篇文章就跟大家 向量库 Milvus Entity 开发 分库 分表 DBMS 管理系统 MongoDB 容器 sqlmock 虚拟服务器 虚拟机 内存 崖山 新版本 OAuth2 Token ZODB 单点故障 LRU mini-redis INCR指令 JOIN Undo Log 容器化 悲观锁 乐观锁 数据集成工具 分布式 集中式 SpringAI openHalo 窗口 函数 QPS 高并发 磁盘架构 数据脱敏 加密算法 PostGIS 排行榜 排序 Testcloud 云端自动化 Redka Redisson 锁芯 聚簇索引 非聚簇索引 数据类型 启动故障 大表 业务场景 分页 数据结构 意向锁 记录锁 EasyExcel MySQL8 Pottery 模型 原子性 StarRocks 数据仓库 Recursive 分布式架构 分布式锁​ R2DBC AIOPS InfluxDB 1 IT Caffeine CP dbt 数据转换工具 RAG HelixDB 工具链 事务 Java 发件箱模式 SSH MCP 开放协议 网络 Web 接口 部署 池化技术 连接池 数据分类 字典 filelock 对象 传统数据库 向量化 速度 服务器中毒 Go 数据库迁移 事务隔离 双引擎 分页方案 排版 数据页 优化器 读写 单线程 仪表盘 频繁 Codis Order 线程安全 Crash 代码 LLM 订单 日志 Pump 事务同步 List 类型 UUIDv7 主键 Ansible