一、前期回顾昨天我们了解了什么是ORM以及使用ORM的优势以及如何在Fast API中集成数据库二、今日学习模型设计如何使用 Tortoise ORM 定义数据表结构数据库迁移使用 Aerich 工具管理数据库版本接口开发实现一个基于单表的用户登录接口安全提示本文示例为教学演示密码采用明文存储。在生产环境中请务必使用passlib或bcrypt对密码进行哈希加密处理三、创建模型、模块导出、Aerich 数据库迁移。创建模型1、在我们创建的app软件包的目录下创建一个models的软件包在里面用于创建模型在app软件包下创建一个user.py的文件我们可以在这个文件中创建一个user模型定义一些需要的字段from tortoise import models, fields class User(models.Model): id fields.IntField(pkTrue) username fields.CharField(max_length50,uniqueTrue) password fields.CharField(max_length50) email fields.CharField(max_length100,uniqueTrue) created_at fields.DatetimeField(auto_now_addTrue) class Meta: tablet_user我们可以看到User模型继承了tortoise下的modls然后一定要写id这个为模型中的主键然后其他字段可以根据使用需求来增加一些约束比如username这个字段可以增加唯一约束增加一些字数限制的约束以下为一些常用的字段类型模块导出创建好模型后我们需要导出User模型在app/models/init.py文件中进行导出from app.models.user import User __all__ [User] #一边俩下划线Aerich 数据库迁移什么是AerichAerich是一个专为Tortoise ORM设计的数据库迁移工具。核心功能自动生成迁移文件对比当前模型定义与数据库实际状态自动生成增量 SQL 变更脚本。版本化管理通过迁移文件记录数据库结构的演进历史支持升级和回滚。CLI 驱动提供命令行工具如aerich init-db,aerich migrate,aerich upgrade来管理整个迁移生命周期。多数据库支持兼容 PostgreSQL、MySQL、SQLite 等 Tortoise ORM 支持的后端。首次迁移生成迁移文件aerich init -t app.config.TORTOISE_ORM-t后面为数据库配置的TORTOISE_ORM路径即为app目录下的config文件下的TORTOISE_ORM常量名后续自己在做练习的时候不在这个目录下记得要更改这个生成迁移文件的命令初始迁移并应用到数据库此命令只能第一次执行迁移时使用aerich init-db#第二次及以后生成迁移文件aerich migrate --name 描述名--name 描述名可加可不加加的话就是给你的迁移文件生成一个名字#第二次及以后迁移并应用到数据库aerich upgrade四、单表增删改查现在准备工作基本完成我们可以进行写表的增删改查接口了创建专门写接口的文件我们在前面每创建一个模型就单独创建一个文件在写接口的文档也是同理我这里在app目录下创建了个叫api的软件包里面专门存放写的接口文件在里面创建一个user.py的文件写user的接口逻辑打开app/api/user.py文件下写入写入先创建一个路由器APIRouterfrom fastapi import APIRouter user_router APIRouter( prefix/users, tags[用户], )我们先写一个简单的登录接口没有返回token和加密的在app下创建一个叫schemas的软件包然后在软件包下创建一个user.py文件定义pydantic对象,接受前端传递的json参数:# 从 pydantic 库中导入 BaseModel 和 Field 两个核心类 # pydantic 是一个用于数据验证和设置管理的 Python 库 from pydantic import BaseModel, Field # 定义一个用户创建请求的数据模型类 # 继承自 BaseModel这是 pydantic 中定义数据模型的基础类 class UserLogin(BaseModel): #Field中可以进行一些校验或限制比如...为必传参数None为可传可不传 username:strField( ..., title用户名, description用户名, exampleadmin ) password:strField( ..., title密码, description密码, example123123 )在app/api/user.py下写#装饰器post请求的路由 user_router.post(/login) # async 关键字声明这是一个异步函数可以使用 await 调用异步操作 async def get_user(user_request:UserLogin): # await与async同时出现有async必须要加await user await User.filter(usernameuser_request.username, passworduser_request.password).first() if not user: return {code:400,msg:用户名或密码错误} return {code:200,msg:登录成功,data:{username:user.username,user_id:user.id}}在main.py中将路由器挂载到主 FastAPI 应用# 从 user 模块导入路由器实例 from app.api.user import user_router # 将路由器挂载到主 FastAPI 应用 app.include_router(user_router)连接数据库先添加个数据我这里选择用软件自带的数据库添加完之后然后来接口文档测试一下输入uvicorn main:app --reload启动点击测试登录成功五、总结一、 核心知识脉络本次学习完成了从数据库模型设计到接口落地的完整闭环主要涵盖三大模块模型层使用 Tortoise ORM 定义User模型掌握主键声明、字段约束唯一/长度及元数据表名配置并通过__all__规范模块导出。迁移层引入 Aerich 工具管理数据库版本区分首次初始化init-db与后续迭代migrateupgrade的命令差异实现模型变更的增量同步。接口层基于APIRouter模块化组织路由结合 Pydantic Schema 完成请求参数校验实现异步登录查询接口并挂载至主应用。二、 关键技术要点Tortoise ORM 规范模型必须继承models.Model且显式定义pkTrue的主键字段所有数据库操作均为异步必须配合await使用。Aerich 命令边界aerich init-db仅限项目首次执行后续任何模型修改严禁重复使用该命令否则会导致迁移历史混乱。Pydantic 校验使用Field(...)标记必填参数通过title/description/examples增强 Swagger 文档可读性注V2 版本推荐使用examples替代example。路由模块化通过APIRouter(prefix, tags)定义子路由再经app.include_router()挂载避免单文件代码膨胀。三、 避坑与安全提醒密码安全当前示例为明文存储密码仅用于教学演示。生产环境必须使用passlib/bcrypt进行哈希加密同时建议将密码字段长度调整为 255 以容纳哈希值。循环导入模型、Schema、路由文件之间需保持单向依赖避免交叉引用导致ImportError。迁移配置路径aerich init -t后的配置路径必须与实际项目中TORTOISE_ORM常量的位置完全一致路径错误会导致迁移失败。