Flask-SQLAlchemy模型与表定义完全指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00657/article/details/148527419

Flask-SQLAlchemy模型与表定义完全指南

flask-sqlalchemy Adds SQLAlchemy support to Flask 项目地址: https://gitcode.com/gh_mirrors/fl/flask-sqlalchemy

概述

Flask-SQLAlchemy作为Flask生态中处理数据库操作的核心扩展，提供了简洁而强大的ORM功能。本文将深入讲解如何使用Flask-SQLAlchemy定义数据模型和表结构，帮助开发者构建健壮的数据库应用。

基础类初始化

在SQLAlchemy 2.x中，模型定义的基础类选择变得更加灵活。开发者可以根据需求选择不同的基类：

from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from sqlalchemy.orm import DeclarativeBase

class Base(DeclarativeBase):
    pass

如果需要数据类支持，可以添加MappedAsDataclass作为父类：

from sqlalchemy.orm import DeclarativeBase, MappedAsDataclass

class Base(DeclarativeBase, MappedAsDataclass):
    pass

元数据配置

良好的命名约定对于数据库维护至关重要，特别是在使用迁移工具时：

from sqlalchemy import MetaData

class Base(DeclarativeBase):
    metadata = MetaData(naming_convention={
        "ix": 'ix_%(column_0_label)s',
        "uq": "uq_%(table_name)s_%(column_0_name)s",
        "ck": "ck_%(table_name)s_%(constraint_name)s",
        "fk": "fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s",
        "pk": "pk_%(table_name)s"
    })

扩展初始化

定义好基础类后，创建SQLAlchemy实例：

db = SQLAlchemy(model_class=Base)

模型定义

Flask-SQLAlchemy简化了模型定义过程，自动处理表名和主键等常见需求：

from sqlalchemy.orm import Mapped, mapped_column

class User(db.Model):
    id: Mapped[int] = mapped_column(primary_key=True)
    username: Mapped[str] = mapped_column(unique=True)
    email: Mapped[str]

模型创建

定义模型后，需要显式创建数据库表：

with app.app_context():
    db.create_all()

注意：如果模型分布在多个子模块中，确保在使用create_all前导入所有模型。

表定义

对于不需要完整模型的情况，可以直接定义表结构：

import sqlalchemy as sa

user_book_m2m = db.Table(
    "user_book",
    sa.Column("user_id", sa.ForeignKey(User.id), primary_key=True),
    sa.Column("book_id", sa.ForeignKey(Book.id), primary_key=True),
)

这种定义方式特别适合多对多关系的中间表。

表反射

当连接已有数据库时，可以使用反射功能自动获取表结构：

with app.app_context():
    db.reflect()

# 默认绑定键的表
class Book(db.Model):
    __table__ = db.metadata.tables["book"]

# 特定绑定键的表
class User(db.Model):
    __table__ = db.metadatas["auth"].tables["user"]

虽然反射功能强大，但建议仅在必要时使用。显式定义模型可以获得更好的IDE支持和迁移管理。