Flask Web 开发【 Chapter 5 】数据库

不好意思,这几天都没有学习与更新,每次放完假都需要 2-3 天调整自己的状态,现在我要重新开始学习了。

Chapter 5 数据库

5.5 使用 Flask-SQLAlchemy 管理数据库

安装 Flask-SQLAlchemy

pip install flask-sqlalchemy

在 Flask-SQLAlchemy 中,数据库使用 URL 指定。最流行的数据库引擎采用的数据库 URL 格式如下表所示。

Flask Web 开发【 Chapter 5 】数据库_第1张图片
FLask-SQLAlchemy数据库URL

程序使用的数据库 URL 必须保存到 Flask 配置对象的 SQLALCHEMY_DATABASE_URI 键中。

配置对象中还有一个很有用的选项,即 SQLALCHEMY_COMMIT_ON_TEARDOWN 键,将其设为 True 时,每次请求结束后都会自动提交数据库中的变动。其他配置选项的作用请参阅 FlaskSQLAlchemy 的文档。

hello.py:初始化及配置一个简单的 SQLite 数据库:

from flask_sqlalchemy import SQLAlchemy

basedir = os.path.abspath(os.path.dirname(__file__))

# 1.初始化 Flask 对象
app = Flask(__name__)

# 初始化以及配置一个简单的 SQLlite 数据库
app.config['SQLALCHEMY_DATABASE_URI'] = \
    'sqlite:///' + os.path.join(basedir, 'data.sqlite')
app.config['SQLALCHEMY_COMMIT_ON_TEARDOWN'] = True
db=SQLAlchemy(app)

db 对象是 SQLAlchemy 类的实例,表示程序使用的数据库,同时还获得了 Flask-SQLAlchemy 提供的所有功能。

5.6 定义模型

Flask-SQLAlchemy 创建的数据库实例为模型提供了一个基类以及一系列辅助类和辅助函 数,可用于定义模型的结构。

**hello.py:定义 Role 和 User 模型 **

# 定义 Role 和 User 模型
class Role(db.Model):
    __tablename__ = 'roles'
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(64), unique=True)

    def __repr__(self):
        return '' % self.name


class User(db.Model):
    __tablename__ = 'users'
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(64), unique=True, index=True)

    def __repr__(self):
        return '' % self.username

类变量 __tablename__定义在数据库中使用的表名。如果没有定义 __tablename__,FlaskSQLAlchemy 会使用一个默认名字,但默认的表名没有遵守使用复数形式进行命名的约定, 所以最好由我们自己来指定表名。其余的类变量都是该模型的属性,被定义为 db.Column 类的实例。

db.Column 类构造函数的第一个参数是数据库列和模型属性的类型。下表列出了一些可用的列类型以及在模型中使用的 Python 类型。

最常用的SQLAlchemy列类型:

Flask Web 开发【 Chapter 5 】数据库_第2张图片

最常使用的SQLAlchemy列选项:

Flask Web 开发【 Chapter 5 】数据库_第3张图片

Flask-SQLAlchemy 要求每个模型都要定义主键,这一列经常命名为 id。

这两个模型都定义了 repr() 方法,返回一个具有可读性的字符串表示模型,可在调试和测试时使用。

5.7 关系

关系型数据库使用关系把不同表中的行联系起来。下图所示的关系图表示用户和角色之 间的一种简单关系。这是角色到用户的一对多关系,因为一个角色可属于多个用户,而每 个用户都只能有一个角色。

Flask Web 开发【 Chapter 5 】数据库_第4张图片

hello.py:一对多关系在模型类中的表示方法 :

class Role(db.Model):
    # ...
    users = db.relationship('User',backref='role')

class User(db.Model):
    # ...
    role_id = db.Column(db.Integer,db.ForeignKey('roles.id'))

如上图所示,关系使用 users 表中的外键连接了两行。添加到 User 模型中的 role_id 列被定义为外键,就是这个外键建立起了关系。传给 db.ForeignKey() 的参数 'roles.id' 表明,这列的值是 roles 表中行的 id 值。

添加到 Role 模型中的 users 属性代表这个关系的面向对象视角。对于一个 Role 类的实例, 其 users 属性将返回与角色相关联的用户组成的列表。db.relationship() 的第一个参数表明这个关系的另一端是哪个模型。如果模型类尚未定义,可使用字符串形式指定。

db.relationship() 中的 backref 参数向 User 模型中添加一个 role 属性,从而定义反向关系。这一属性可替代 role_id 访问 Role 模型,此时获取的是模型对象,而不是外键的值。

大多数情况下,db.relationship() 都能自行找到关系中的外键,但有时却无法决定把哪一列作为外键。例如,如果 User 模型中有两个或以上的列定义为 Role 模型的外键, SQLAlchemy 就不知道该使用哪列。如果无法决定外键,你就要为 db.relationship() 提供额外参数,从而确定所用外键。下表列出了定义关系时常用的配置选项。

常用的 SQLALchemy 关系选项:

Flask Web 开发【 Chapter 5 】数据库_第5张图片

5.8 数据库操作

数据库操作与git的操作十分相似

  • 创建数据表 db.create_all() 创建sqlite数据库文件data.sqlite,改动模型后,更新数据库时只能删除旧表 db.drop_all(),然后重新 db.create_all() 创建,但是会导致原有数据的丢失。
  • 插入记录 只需要调用模型的关键字参数形式的构造函数,如 admin_role = Role(name='Admin)',主键 idFlask-SQLAlchemy 管理,不需要明确设置
  • 同步模型改动到数据库 使用 db.session 数据库事务对象管理对数据库的改动,如添加记录到数据库 db.session.add(admin_role)
  • 提交操作 db.session.commit()
  • 修改记录 首先修改模型对象属性值,然后 db.session.add(), db.session.commit()
  • 删除记录 首先db.session.delete( model obj) 然后提交到仓库 db.session.commit()

hello.py文件添加

# 数据库对象的创建及初始化
def Create_database():
    # 创建数据库文件及表,
    # ? 程序如何识别所有需要创建数据表的对象 ?
    db.create_all()
    # 插入行
    admin_role = Role(name='Admin')
    mod_role = Role(name='Moderator')
    user_role = Role(name='User')
    user_john = User( username='john', role = admin_role )
    user_susan = User( username='susan', role = user_role )
    user_david = User( username='david', role = user_role )

    # 添加到会话
    db.session.add( admin_role )
    db.session.add( mod_role )
    db.session.add( user_role )
    db.session.add( user_john  )
    db.session.add( user_susan )
    db.session.add( user_david )

    # db.session.add_all( [admin_role, mod_role, user_role, user_john , user_susan, user_david] )
    # 提交到数据库
    db.session.commit()
    # db.session.rollback() 将添加到数据库会话中的所有对象还原到他们在数据库中的状态,相当于git中的checkout
    # 删除数据
    # db.session.delete(mod_role)
    # db.session.commit()
 
 def __init__(self):
    Create_database()

5.9 在视图函数中操作数据库

**hello.py:在视图函数中操作数据库 **

def index():
    # name = None
    form = NameForm()
    if form.validate_on_submit():
        user = User.query.filter_by(username=form.name.data).first()
        if user is None:
            user = User(username = form.name.data)
            db.session.add(user)
            session['known']=False
        else:
            session['known'] = True
        session['name'] = form.name.data
        form.name.data = ''
        return redirect(url_for('index'))
    return render_template('index.html', form=form, name=session.get('name'),know = session.get('known',False))

在这个修改后的版本中,提交表单后,程序会使用 filter_by() 查询过滤器在数据库中查找提交的名字。变量 known 被写入用户会话中,因此重定向之后,可以把数据传给模板, 用来显示自定义的欢迎消息。注意,要想让程序正常运行,你必须按照前面介绍的方法,在 Python shell 中创建数据库表(我是用 Create_database() 方法创建这个数据库的)。

对应的模板新版本如下所示。这个模板使用 known 参数在欢迎消息中加入了第二行, 从而对已知用户和新用户显示不同的内容。

修改 index.html

#...
{% block page_content %}
    
    {{ wtf.quick_form(form) }}
    {#    

The local date and time is {{ moment(current_time).format('LLL') }}.

#} {#

That was {{ moment(current_time).fromNow(refresh=True) }}.

#} {% endblock %} #...

5.10 集成 Python shell

每次启动 shell 都要导入数据库实例和模型,通过设置让 Flask-Scriptshell 自动导入特定的对象

hello.py:为 shell 命令添加一个上下文

from flask_script import shell

# 创建 shell 的上下文环境
def make_shell_context():
    return dict(app=app, db=db, User=User, Role=Role)
# 配置 manager 的命令行
manager.add_command("shell", Shell(make_context = make_shell_context))

5.11 使用 Flask-Migrate 实现数据库的迁移

开发过程中有时候需要修改数据库模型,并更新到数据库,需要用到数据库迁移框架,推荐 Alembic,及 Flask - Migrate扩展(封装了Alembic),所有的操作通过 Flask-Script完成

5.11.1 修改数据库
  • 安装 pip install flask-migrate
  • hello.py 文件修改
from flask_migrate import Migrate, MigrateCommand
...
# 创建数据库迁移对象
Migrate(app, db)
# 配置 flask_script 命令
manager.add('db', MigrateCommand)
  • 创建迁移仓库 >>> python hello.py db init,会创建 migrations文件夹,放置所有的迁移脚本,迁移仓库中的要进行版本控制。
  • 在 Alembic 中,数据库的迁移用 迁移脚本 表示,脚本中有两个函数 upgrade()downgrade() 前者应用修改,后者删除修改,数据库可以重置到修改历史的任一点。
    • revision 手动创建迁移,upgrade()downgrade() 都是空的,开发者需要使用 Operations对象指令实现具体操作
    • migrate 命令自动创建,会根据模型定义和数据库当前状态之间的差异自动生成 upgrade()downgrade() 的内容

这一章看的迷迷糊糊的,还有我不知道怎么切出 python shell(按照书上的方法会启动服务),参考了很多别人的东西关于迁移的内容也是不知道怎么执行,就这样了吧。

你可能感兴趣的:(Flask Web 开发【 Chapter 5 】数据库)