Flask-SQLAlchemy 数据库操作指南

Flask-SQLAlchemy 是一个为 Flask 应用程序提供 SQLAlchemy 功能的扩展。它简化了在 Flask 中使用 SQLAlchemy 的过程，使得数据库操作更加便捷和优雅。本指南将详细介绍 Flask-SQLAlchemy 的使用方法，涵盖从安装配置到高级操作的各个方面。

一、安装和配置

首先，需要安装 Flask-SQLAlchemy：

bash
pip install Flask-SQLAlchemy

然后，在 Flask 应用程序中进行配置：

“`python
from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(name)
app.config[‘SQLALCHEMY_DATABASE_URI’] = ‘数据库连接字符串’ # 例如：’sqlite:///test.db’
app.config[‘SQLALCHEMY_TRACK_MODIFICATIONS’] = False # 性能优化
db = SQLAlchemy(app)
“`

SQLALCHEMY_DATABASE_URI 指定了数据库的连接字符串，可以支持多种数据库，例如：

• SQLite: sqlite:///test.db
• MySQL: mysql://username:password@host/database
• PostgreSQL: postgresql://username:password@host/database

SQLALCHEMY_TRACK_MODIFICATIONS 设置为 False 可以禁用对象修改跟踪，提升性能。

二、定义模型

使用 SQLAlchemy 的声明式方式定义数据库模型：

“`python
class User(db.Model):
id = db.Column(db.Integer, primary_key=True)
username = db.Column(db.String(80), unique=True, nullable=False)
email = db.Column(db.String(120), unique=True, nullable=False)

def __repr__(self):
    return '<User %r>' % self.username

“`

在这个例子中，我们定义了一个 User 模型，包含 id、username 和 email 三个字段。

三、创建数据库表

使用 db.create_all() 创建数据库表：

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

四、数据操作

1. 添加数据:

python
new_user = User(username='testuser', email='[email protected]')
db.session.add(new_user)
db.session.commit()

2. 查询数据:

“`python

查询所有用户

users = User.query.all()

根据主键查询

user = User.query.get(1)

使用 filter 查询

users = User.query.filter_by(username=’testuser’).all()
users = User.query.filter(User.username.startswith(‘test’)).all()

使用 order_by 排序

users = User.query.order_by(User.username).all()

使用 limit 限制结果数量

users = User.query.limit(5).all()

使用 offset 跳过结果

users = User.query.offset(5).limit(5).all()

使用 paginate 分页

from flask_sqlalchemy import Pagination
page = request.args.get(‘page’, 1, type=int)
pagination = User.query.paginate(page=page, per_page=10)
users = pagination.items
“`

3. 修改数据:

python
user = User.query.get(1)
user.username = 'newusername'
db.session.commit()

4. 删除数据:

python
user = User.query.get(1)
db.session.delete(user)
db.session.commit()

五、关系

Flask-SQLAlchemy 支持定义数据库表之间的关系，例如一对多、多对多等。

1. 一对多:

python
class Post(db.Model):
id = db.Column(db.Integer, primary_key=True)
title = db.Column(db.String(120), nullable=False)
content = db.Column(db.Text, nullable=False)
user_id = db.Column(db.Integer, db.ForeignKey('user.id'), nullable=False)
user = db.relationship('User', backref=db.backref('posts', lazy=True))

user_id 字段是外键，关联到 User 表的 id 字段。user 属性是一个关系，可以通过它访问关联的 User 对象。

2. 多对多:

“`python
tags = db.Table(‘tags’,
db.Column(‘tag_id’, db.Integer, db.ForeignKey(‘tag.id’), primary_key=True),
db.Column(‘post_id’, db.Integer, db.ForeignKey(‘post.id’), primary_key=True)
)

class Tag(db.Model):
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String(50), nullable=False)

class Post(db.Model):
# … other fields …
tags = db.relationship(‘Tag’, secondary=tags, lazy=’subquery’,
backref=db.backref(‘posts’, lazy=True))
“`

这里使用了关联表 tags 来实现多对多关系。

六、高级操作

1. 数据库迁移:

可以使用 Alembic 或 Flask-Migrate 进行数据库迁移，方便管理数据库 schema 的变更。

2. 原生 SQL 查询:

可以使用 db.session.execute() 执行原生 SQL 查询。

3. 事务:

可以使用 with db.session.begin_nested(): 进行嵌套事务操作。

4. 异步操作:

在异步环境下，可以使用 AsyncSession 进行数据库操作。

七、最佳实践

• 使用合适的数据库连接池。
• 避免在视图函数中进行复杂的数据库操作，可以使用服务层或 Repository 模式。
• 使用 ORM 提供的 API 进行数据操作，避免直接使用原生 SQL。
• 合理使用索引优化查询性能。

本指南详细介绍了 Flask-SQLAlchemy 的使用方法，涵盖了从基本配置到高级操作的各个方面。希望能够帮助你更好地使用 Flask-SQLAlchemy 进行数据库操作，构建高效、稳定的 Web 应用程序。 记住，实践出真知，多多练习才能熟练掌握。 不断探索 Flask-SQLAlchemy 的更多功能，可以让你在 Web 开发领域更加游刃有余。