FastAPI项目使用SQLAlchemy设置外键关系失败如何解决

1. 调整类定义顺序 #

SQLAlchemy解析外键时需要被关联类已完成定义，你当前代码先定义了Exercise类，此时Animation类还未加载，会导致外键解析失败。优先调整两个类的定义顺序，先声明Animation再声明Exercise：

class Animation(Base):
   __tablename__="Animation"
   id=Column(Integer,primary_key=True,index=True,autoincrement=True)
   name=Column(VARCHAR(250))
   description=Column(VARCHAR(250))
   # 一对一关联可加上uselist=False限制返回单个对象而非列表
   exercise=relationship("Exercise", back_populates="animation", uselist=False)

class Exercise(Base):
   __tablename__= "Exercise"
   id=Column(Integer, primary_key= True) 
   name=Column(VARCHAR(250))
   animation_id=Column(Integer, ForeignKey('Animation.id'))
   animation=relationship("Animation", back_populates="exercise")

如果业务逻辑不允许调整类定义顺序，你已经用了字符串形式的外键ForeignKey('Animation.id')，只需要确认relationship的引用名称没有拼写错误即可。

2. 重新生成表结构 #

如果是在已存在的表上新增外键，需要重新创建表或者执行迁移脚本更新数据库结构，旧表没有对应外键约束自然不会生效。测试时可以直接删除旧数据库文件，执行Base.metadata.create_all(engine)重新生成所有表验证。

3. 开启数据库外键支持 #

如果你使用的是SQLite数据库，默认外键约束是关闭状态，需要手动开启才能触发关联校验：

from sqlalchemy import event
from sqlalchemy.engine import Engine

@event.listens_for(Engine, "connect")
def enable_sqlite_foreign_key(dbapi_connection, connection_record):
    cursor = dbapi_connection.cursor()
    cursor.execute("PRAGMA foreign_keys=ON")
    cursor.close()

4. 关联参数校验 #

双向关联的back_populates参数值必须和对应类的关联属性名完全一致，你当前代码的拼写是正确的，确认没有大小写、拼写错误即可。

内容的提问来源于stack exchange，提问作者Yiğit Er