六、Flask_数据库+session存储+蓝图

 

 

1 数据库相关

 

orm

ORM 全拼Object-Relation Mapping，中文意为 对象-关系映射。主要实现模型对象到关系数据库数据的映射

优点 :

• 只需要面向对象编程, 不需要面向数据库编写代码

  • 对数据库的操作都转化成对类属性和方法的操作

  • 不用编写各种数据库的sql语句
    

• 实现了数据模型与数据库的解耦, 屏蔽了不同数据库操作上的差异

  • 不再需要关注当前项目使用的是哪种数据库

  • 通过简单的配置就可以轻松更换数据库, 而不需要修改代码

缺点 :

• 相比较直接使用SQL语句操作数据库,有性能损失

• 根据对象的操作转换成SQL语句,根据查询的结果转化成对象, 在映射过程中有性能损失

 

1.1 Flask-SQLAlchemy

flask默认提供模型操作，但是并没有提供ORM，所以一般开发的时候我们会采用flask-SQLAlchemy模块来实现ORM操作。

SQLAlchemy是一个关系型数据库框架，它提供了高层的 ORM 和底层的原生数据库的操作。flask-sqlalchemy 是一个简化了 SQLAlchemy 操作的flask扩展。

SQLAlchemy: https://www.sqlalchemy.org/

 

安装 flask-sqlalchemy

pip install flask-sqlalchemy

 

如果连接的是mysql数据库，需要安装mysqldb驱动

pip install flask-mysqldb

 

安装flask-mysqldb时，注意

安装 flask-mysqldb的时候，python底层依赖于一个底层的模块 mysql-client模块
如果没有这个模块，则会报错如下：

Command "python setup.py egg_info" failed with error code 1 in /tmp/pip-install-21hysnd4/mysqlclient/

 

解决方案：

apt-get install libmysqlclient-dev python3-dev

运行上面的安装命令如果报错：
   dpkg 被中断，您必须手工运行 ‘sudo dpkg --configure -a’ 解决此问题。
则根据提示执行命令以下命令，再次安装mysqlclient
    sudo dpkg --configure -a
    apt-get install libmysqlclient-dev python3-dev

解决了mysqlclient问题以后，重新安装 flask-mysqldb即可。
pip install flask-mysqldb

 

1.2 数据库连接设置

在 Flask-SQLAlchemy 中，数据库使用URL指定，而且程序使用的数据库必须保存到Flask配置对象的 SQLALCHEMY_DATABASE_URI键中

config.py，配置文件代码：

class Config(object):
    DEBUG = True
    # 设置密钥，可以通过 base64.b64encode(os.urandom(48)) 来生成一个指定长度的随机字符串
    SECRET_KEY = "T1vEjTCjkGon5vU8C6Xq3ujNSQgHQje"
    # 数据库链接配置: #数据类型://登录账号:登录密码@数据库主机IP:数据库访问端口/数据库名称
    SQLALCHEMY_DATABASE_URI = "mysql://root:123@127.0.0.1:3306/flask_students"

 

其他设置：

# 动态追踪修改设置，如未设置只会提示警告
SQLALCHEMY_TRACK_MODIFICATIONS = True
#查询时会显示原始SQL语句
SQLALCHEMY_ECHO = True

 

配置完成需要去 MySQL 中创建项目所使用的数据库

$ mysql -uroot -p123
mysql > create database flask_students charset=utf8mb4;

 

常用的SQLAlchemy字段类型

类型名	python中类型	说明
Integer	int	普通整数，一般是32位
SmallInteger	int	取值范围小的整数，一般是16位
BigInteger	int或long	不限制精度的整数
Float	float	浮点数
Numeric	decimal.Decimal	普通数值，一般是32位
String	str	变长字符串
Text	str	变长字符串，对较长或不限长度的字符串做了优化
Unicode	unicode	变长Unicode字符串
UnicodeText	unicode	变长Unicode字符串，对较长或不限长度的字符串做了优化
Boolean	bool	布尔值
Date	datetime.date	日期
Time	datetime.datetime	日期和时间
LargeBinary	str	二进制文件

 

常用的SQLAlchemy列选项

选项名	说明
primary_key	如果为True，代表表的主键
unique	如果为True，代表这列不允许出现重复的值
index	如果为True，为这列创建索引，提高查询效率
nullable	如果为True，允许有空值，如果为False，不允许有空值
default	为这列定义默认值

 

常用的SQLAlchemy关系选项

backref	在关系的另一模型中添加反向引用,用于设置外键名称,在1查多的
primary join	明确指定两个模型之间使用的连表条件
uselist	如果为False，不使用列表，而使用标量值
order_by	指定关系中记录的排序方式
secondary	指定多对多关系中关系表的名字
secondary join	在SQLAlchemy中无法自行决定时，指定多对多关系中的二级连表条件

 

 

1.3 数据库基本操作

 

在Flask-SQLAlchemy中，插入、修改、删除操作，均由数据库会话管理

 

 

• 会话用 db.session 表示。在准备把数据写入数据库前，要先将数据添加到会话中然后调用 commit() 方法提交会话

 

 

在 Flask-SQLAlchemy 中，查询操作是通过 query 对象操作数据

 

 

• 最基本的查询是返回表中所有数据，可以通过过滤器进行更精确的数据库查询

 

 

定义模型类

测试先把模型类写在main.py文件中，一般会把模型创建到单独的文件中

from flask import Flask
from config import Config

app = Flask(__name__,template_folder='templates')
app.config.from_object(Config)


"""模型的创建"""
from flask_sqlalchemy import SQLAlchemy
db = SQLAlchemy(app)

class Course(db.Model):
    # 定义表名
    __tablename__ = 'tb_course'
    # 定义字段对象
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(64), unique=True)
    price = db.Column(db.Numeric(6,2))
    # repr()方法类似于django的__str__，用于打印模型对象时显示的字符串信息
    def __repr__(self):
        return 'Course:%s'% self.name

class Student(db.Model):
    __tablename__ = 'tb_student'
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(64), unique=True)
    email = db.Column(db.String(64),unique=True)
    age = db.Column(db.SmallInteger)
    sex = db.Column(db.Boolean,default=1)

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

class Teacher(db.Model):
    __tablename__ = 'tb_teacher'
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(64), unique=True)

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

@app.route("/")
def index():
    return "ok"

if __name__ == '__main__':
    app.run()

 

 

模型之间的关联

一对多

class Course(db.Model):
    ...
    teacher_id = db.Column(db.Integer, db.ForeignKey('tb_teacher.id'))

class Teacher(db.Model):
　　__tablename__ = 'tb_teacher'
    ...
    # 课程与老师之间的关联
    courses = db.relationship('Course', backref='teacher', lazy='subquery')
    ...

• 其中realtionship描述了Course和Teacher的关系。第一个参数为对应参照的类"Course"

• 第二个参数backref为类Teacher申明新属性的方法

• 第三个参数lazy决定了什么时候SQLALchemy从数据库中加载数据

  • 如果设置为子查询方式(subquery)，则会在加载完Teacher对象后，就立即加载与其关联的对象，这样会让总查询数量减少，但如果返回的条目数量很多，就会比较慢

    • 设置为 subquery 的话，teacher.courses 返回所有当前老师关联的课程列表

  • 另外,也可以设置为动态方式(dynamic)，这样关联对象会在被使用的时候再进行加载，并且在返回前进行过滤，如果返回的对象数很多，或者未来会变得很多，那最好采用这种方式

    • 设置为 dynamic 的话，Teacher.courses返回查询对象，并没有做真正的查询，可以利用查询对象做其他逻辑，比如：先排序再返回结果

 

多对多

achievement = db.Table('tb_achievement',  
    db.Column('student_id', db.Integer, db.ForeignKey('tb_student.id')),  
    db.Column('course_id', db.Integer, db.ForeignKey('tb_course.id'))  
)

class Course(db.Model):
    ...
    students = db.relationship('Student',secondary=achievement,  
                                    backref='courses',  
                                    lazy='dynamic')
class Student(db.Model):
    ...

 

常用的SQLAlchemy查询过滤器

过滤器	说明
filter()	把过滤器添加到原查询上，返回一个新查询
filter_by()	把等值过滤器添加到原查询上，返回一个新查询
limit()	使用指定的值限定原查询返回的结果
offset()	偏移原查询返回的结果，返回一个新查询
order_by()	根据指定条件对原查询结果进行排序，返回一个新查询
group_by()	根据指定条件对原查询结果进行分组，返回一个新查询

 

常用的SQLAlchemy查询结果的方法

all()	以列表形式返回查询的所有结果
first()	返回查询的第一个结果，如果未查到，返回None
first_or_404()	返回查询的第一个结果，如果未查到，返回404
get()	返回指定主键对应的行，如不存在，返回None
get_or_404()	返回指定主键对应的行，如不存在，返回404
count()	返回查询结果的数量
paginate()	返回一个Paginate对象，它包含指定范围内的结果

 

创建和删除表

创建表

db.create_all()  # 注意，create_all()方法执行的时候，需要放在模型的后面
# 上面这段语句，后面我们需要转移代码到flask-script的自定义命令中。
# 执行了一次以后，需要注释掉。

删除表

db.drop_all()

 

添加数据

插入一条数据

student1 = Student(name='xiaoming')
db.session.add(student1)
db.session.commit()
#再次插入一条数据
student2 = Role(name='xiaohong')
db.session.add(student2)
db.session.commit()

 

一次插入多条数据

st1 = Student(name='wang',email='[e-mail]',age=22)
st2 = Student(name='zhang',email='[e-mail]',age=22)
st3 = Student(name='chen',email='[e-mail]',age=22)
st4 = Student(name='zhou',email='[e-mail]',age=22)
st5 = Student(name='tang',email='[e-mail]',age=22)
st6 = Student(name='wu',email='[e-mail]',age=22)
st7 = Student(name='qian',email='[e-mail]',age=22)
st8 = Student(name='liu',email='[e-mail]',age=22)
st9 = Student(name='li',email='[e-mail]',age=22)
st10 = Student(name='sun',email='[e-mail]',age=22)
db.session.add_all([st1,st2,st3,st4,st5,st6,st7,st8,st9,st10])
db.session.commit()

 

题

查询所有学生数据

查询有多少个学生

查询第1个学生

查询id为4的学生[3种方式]

查询名字结尾字符为g的所有学生数据[开始/包含]

查询名字不等于wang的所有学生数据[2种方式]

查询名字和邮箱都以 li 开头的所有数据[2种方式]

查询age是 18 或者 `email` 以 `163.com` 结尾的所有学生

查询id为 [1, 3, 5, 7, 9] 的用户列表

查询name为liu的学生数据

查询所有学生数据，并以年龄排序

分页查询，每页3个，查询第2页的数据

 

 

查询

 

filter_by精确查询

例如：返回名字等于wang的所有人

Student.query.filter_by(name='xiaoming').all()

 

first()返回查询到的第一个对象【first获取一条数据,all获取多条数据】

Student.query.first()

 

all()返回查询到的所有对象

Student.query.all()

 

filter模糊查询，返回名字结尾字符为g的所有数据

Student.query.filter(Student.name.endswith('g')).all()

 

get():参数为主键，如果主键不存在没有返回内容

Student.query.get()

 

逻辑非，返回名字不等于wang的所有数据

Student.query.filter(Student.name!='wang').all()

 

逻辑与，需要导入and，返回and()条件满足的所有数据

from sqlalchemy import and_
Student.query.filter(and_(Student.name!='wang',Student.email.endswith('163.com'))).all()

 

逻辑或，需要导入or_

from sqlalchemy import or_
Student.query.filter(or_(Student.name!='wang',Student.email.endswith('163.com'))).all()

 

查询数据后删除

student = Student.query.first()
db.session.delete(student)
db.session.commit()

 

更新数据

student = Student.query.first()
student.name = 'dong'
db.session.commit()

 

 

关联查询

假设：老师和课程的关系是一对多的关系，一个老师可以授课多个课程，一个课程只由一个老师授课。

 

• 查询老师授课的所有课程

#查询讲师表id为1的老师
teacher = Teacher.query.get(1)
#查询当前老师的所有课程, 根据模型中关联关系来查询数据
print(teacher.courses)

• 查询课程所属讲师

course = Course.query.get(2)

print(course)

# 根据外键只能查询到ID数值, SQLAlchemy不会帮我们把ID转换成模型
print( course.teacher_id )

# 要获取外键对应的模型数据,需要找到主键模型里面的  db.relationship 里面的 backref
print( course.teacher.name )

 

1.4 数据库迁移

• 在开发过程中，需要修改数据库模型，而且还要在修改之后更新数据库。最直接的方式就是删除旧表，但这样会丢失数据。

• 更好的解决办法是使用数据库迁移框架，它可以追踪数据库模式的变化，然后把变动应用到数据库中。

• 在Flask中可以使用Flask-Migrate扩展，来实现数据迁移。并且集成到Flask-Script中，所有操作通过命令就能完成。

• 为了导出数据库迁移命令，Flask-Migrate提供了一个MigrateCommand类，可以附加到flask-script的manager对象上。

 

首先要在虚拟环境中安装Flask-Migrate

pip install flask-migrate

配置

manage = Manager(app)

"""模型的创建"""
from flask_sqlalchemy import SQLAlchemy
db = SQLAlchemy(app)



#第一个参数是Flask的实例，第二个参数是Sqlalchemy数据库实例
migrate = Migrate(app,db)

#manager是Flask-Script的实例，这条语句在flask-Script中添加一个db命令
manage.add_command('db',MigrateCommand)

 

创建迁移版本仓库

#这个命令会创建migrations文件夹，所有迁移文件都放在里面。
python main.py db init

 

创建迁移版本

• 自动创建迁移版本有两个函数

  • upgrade()：函数把迁移中的改动应用到数据库中。

  • downgrade()：函数则将改动删除。

• 自动创建的迁移脚本会根据模型定义和数据库当前状态的差异，生成upgrade()和downgrade()函数的内容。

• 对比不一定完全正确，有可能会遗漏一些细节，需要进行检查

python main.py db migrate -m 'initial migration'

# 这里等同于django里面的 makemigrations，生成迁移版本文件

 

升级版本库的版本

python main.py db upgrade 

 

降级版本库的版本

python main.py db downgrade

 

版本库的历史管理

可以根据history命令找到版本号,然后传给downgrade命令:

  python manage.py db history输出格式：<base> ->  版本号 (head), initial migration

 

回滚到指定版本

python manage.py db downgrade # 默认返回上一个版本
python manage.py db downgrade 版本号   # 返回到指定版本号对应的版本

 

数据迁移的步骤：

1. 初始化数据迁移的目录
python manage.py db init

2. 数据库的数据迁移版本初始化
python manage.py db migrate -m 'initial migration'

3. 升级版本[创建表/创建字段/修改字段]
python manage.py db upgrade 

4. 降级版本[删除表/删除字段/恢复字段]
python manage.py db downgrade

 

模块推荐

文档: https://faker.readthedocs.io/en/master/locales/zh_CN.html

github: https://github.com/joke2k/faker

 

2 flask-session

允许设置session到指定存储的空间中, 文档:

安装命令: https://pythonhosted.org/Flask-Session/

pip install flask-Session

 

使用session之前,必须配置一下配置项

# 设置密钥，可以通过 base64.b64encode(os.urandom(48)) 来生成一个指定长度的随机字符串
SECRET_KEY = "T1vEjTCjkGon5vU8C6Xq3ujNSQgHQje"

 

2.1 redis保存session的基本配置

配置文件信息：

import redis
class Config(object):
    DEBUG = True
    SECRET_KEY = "*(%#4sxcz(^(#$#8423"
    # 数据库链接配置:
    #数据类型://登录账号:登录密码@数据库主机IP:数据库访问端口/数据库名称
    SQLALCHEMY_DATABASE_URI = "mysql://root:123@127.0.0.1:3306/flask_students"
    # 设置mysql的错误跟踪信息显示
    SQLALCHEMY_TRACK_MODIFICATIONS = True
    # 打印每次模型操作对应的SQL语句
    SQLALCHEMY_ECHO = True
    # 把session保存到redis中
    # session存储方式为redis
    SESSION_TYPE="redis"
    # 如果设置session的生命周期是否是会话期, 为True，则关闭浏览器session就失效
    SESSION_PERMANENT = False
    # 是否对发送到浏览器上session的cookie值进行加密
    SESSION_USE_SIGNER = False
    # 保存到redis的session数的名称前缀
    SESSION_KEY_PREFIX = "session:"
    # session保存数据到redis时启用的链接对象
    SESSION_REDIS = redis.Redis(host='127.0.0.1', port='6379')  # 用于连接redis的配置

 

主文件信息main.py，代码

from flask import Flask
from config import Config
from flask_session import Session
from flask import session
app = Flask(__name__,template_folder='templates')
app.config.from_object(Config)

Session(app)

@app.route("/")
def index():
    return "ok"

@app.route("/set_session")
def set_session():
    """设置session"""
    session["username"] = "小明"
    return "ok"

if __name__ == '__main__':
    app.run()

 

2.2 SQLAlchemy存储session的基本配置

需要手动创建session表，在项目第一次启动的时候，使用db.create_all()来完成创建

db = SQLAlchemy(app)

app.config['SESSION_TYPE'] = 'sqlalchemy'  # session类型为sqlalchemy
app.config['SESSION_SQLALCHEMY'] = db # SQLAlchemy对象
app.config['SESSION_SQLALCHEMY_TABLE'] = 'session' # session要保存的表名称
app.config['SESSION_PERMANENT'] = True  # 如果设置为True，则关闭浏览器session就失效。
app.config['SESSION_USE_SIGNER'] = False  # 是否对发送到浏览器上session的cookie值进行加密
app.config['SESSION_KEY_PREFIX'] = 'session:'  # 保存到session中的值的前缀

Session(app)

 

 

3 蓝图

3.1 模块化

随着flask程序越来越复杂,我们需要对程序进行模块化的处理,之前学习过python的模块化管理,于是针对一个简单的flask程序进行模块化处理

简单来说，Blueprint 是一个存储视图方法的容器，这些操作在这个Blueprint 被注册到一个应用之后就可以被调用，Flask 可以通过Blueprint来组织URL以及处理请求。

• 一个项目可以具有多个Blueprint

• 可以将一个Blueprint注册到任何一个未使用的URL下比如 “/”、“/sample”或者子域名

• 在一个应用中，一个模块可以注册多次

• Blueprint可以单独具有自己的模板、静态文件或者其它的通用操作方法，它并不是必须要实现应用的视图和函数的

• 在一个应用初始化时，就应该要注册需要使用的Blueprint

但是一个Blueprint并不是一个完整的应用，它不能独立于应用运行，而必须要注册到某一个应用中。

Blueprint对象用起来和一个应用/Flask对象差不多，最大的区别在于一个 蓝图对象没有办法独立运行，必须将它注册到一个应用对象上才能生效

 

使用蓝图可以分为四个步骤

1. 创建一个蓝图的包,例如users,并在__init__.py文件中创建蓝图对象

users=Blueprint('users',__name__)

 

2. 在这个蓝图目录下, 创建views.py文件,保存当前蓝图使用的视图函数

@admin.route('/')
def home():
    return 'user.home'

 

3. 在users/init.py中引入views.py中所有的视图函数

from flask import Blueprint
# 等同于原来在 manage.py里面的 app = Flask()
users=Blueprint('users',__name__)

from .views import *

 

3.2 运行机制

• 蓝图是保存了一组将来可以在应用对象上执行的操作，注册路由就是一种操作

• 当在app对象上调用 route 装饰器注册路由时,这个操作将修改对象的url_map路由表

• 然而，蓝图对象根本没有路由表，当我们在蓝图对象上调用route装饰器注册路由时,它只是在内部的一个延迟操作记录列表defered_functions中添加了一个项

• 当执行app对象的 register_blueprint() 方法时，应用对象将从蓝图对象的 defered_functions 列表中取出每一项，并以自身作为参数执行该匿名函数，即调用应用对象的 add_url_rule() 方法，这将真正的修改应用对象的usr_map路由表

 

3.3 蓝图的url前缀

当我们在应用对象上注册一个蓝图时，可以指定一个url_prefix关键字参数（这个参数默认是/）

 

 

3.4 注册蓝图中的静态文件的相关路由

 

和应用对象不同，蓝图对象创建时不会默认注册静态目录的路由。需要我们在 创建时指定 static_folder 参数。

下面的示例将蓝图所在目录下的static_users目录设置为静态目录

 

# users/__init__.py，代码：
user_blu = Blueprint("users",__name__,static_folder='static_users')

# 启动文件 main.py，代码：
from users import user_blu
app.register_blueprint(user_blu,url_prefix='/users')

 

 现在就可以使用/admin/static_admin/ 访问static_admin目录下的静态文件了

 

定制静态目录URL规则 ：可以在创建蓝图对象时使用 static_url_path 来改变静态目录的路由

 

 下面的示例将为 static_admin 文件夹的路由设置为 /lib

admin = Blueprint("admin",__name__,static_folder='static_admin',static_url_path='/lib')
app.register_blueprint(admin,url_prefix='/admin')

 

 

 

3.5 设置蓝图中模版的目录

 

蓝图对象默认的模板目录为系统的模版目录，可以在创建蓝图对象时使用 template_folder 关键字参数设置模板目录

admin = Blueprint('admin',__name__,template_folder='templates_users')

 

创建蓝图中的模板目录template_users :

 

 

 

 注:如果在 templates 中存在和 templates_users 有同名模板文件时, 则系统会优先使用 templates 中的文件

 

 

4 扩展

调整session配置

分析SQLAlachemy的构造方式可以发现，初始化并非一定要传递app应用对象到内部，事实上它提供了init_app方法给我们后续调用。而 init_app 方法是flask框架要求任何的第三方组件都要实现这个方法。

init_app方法内部就是要第三方组件开发者编写一些使用当前组建的默认配置项以及把当前组件设置成一个对象，加载到app对象内部extensions字典才能让开发者在flask框架内部配置和使用当前组件。

我们可以利用这种组件开发机制，那么把配置代码抽离出去。

配置文件中：

import redis
from flask_sqlalchemy import SQLAlchemy
# 创建db对象
db = SQLAlchemy()
class Config(object):
    DEBUG = True
    SECRET_KEY = "*(%#4sxcz(^(#$#8423"
    # 数据库链接配置:
    #数据类型://登录账号:登录密码@数据库主机IP:数据库访问端口/数据库名称
    SQLALCHEMY_DATABASE_URI = "mysql://root:123@127.0.0.1:3306/flask_students"
    # 设置mysql的错误跟踪信息显示
    SQLALCHEMY_TRACK_MODIFICATIONS = True
    # 打印每次模型操作对应的SQL语句
    SQLALCHEMY_ECHO = True

    """把session保存到redis中"""
    # session存储方式为redis
    # SESSION_TYPE="redis"
    # # 如果设置session的生命周期是否是会话期, 为True，则关闭浏览器session就失效
    # SESSION_PERMANENT = False
    # # 是否对发送到浏览器上session的cookie值进行加密
    # SESSION_USE_SIGNER = False
    # # 保存到redis的session数的名称前缀
    # SESSION_KEY_PREFIX = "session:"
    # # session保存数据到redis时启用的链接对象
    # SESSION_REDIS = redis.Redis(host='127.0.0.1', port='6379')  # 用于连接redis的配置

    SESSION_TYPE= 'sqlalchemy'  # session的存储方式为sqlalchemy
    SESSION_SQLALCHEMY= db  # SQLAlchemy对象
    SESSION_SQLALCHEMY_TABLE= 'sessions'  # session要保存的表名称
    SESSION_PERMANENT= True  # 如果设置为True，则关闭浏览器session就失效。
    SESSION_USE_SIGNER= False  # 是否对发送到浏览器上session的cookie值进行加密
    SESSION_KEY_PREFIX= 'session:'  # 保存到session中的值的前缀

 

启动文件main.py，代码：

 

from flask import Flask
from config import Config,db
from flask_session import Session

from flask import session

app = Flask(__name__,template_folder='templates')
app.config.from_object(Config)

# 把app加载到db对象中
db.init_app(app)

Session(app)

@app.route("/")
def index():
    return "ok"

@app.route("/set_session")
def set_session():
    """设置session"""
    session["username"] = "小明"
    return "ok"

if __name__ == '__main__':
    # db.create_all()
    print( app.url_map )
    app.run()