跳转至

Flask框架

add_circle2025-03-05update2025-03-06

Flask诞生于2010年,是Armin ronacher(人名)用 Python 语言基于 Werkzeug 工具箱编写的轻量级Web开发框架。

Flask 本身相当于一个内核,其他几乎所有的功能都要用到扩展(邮件扩展Flask-Mail,用户认证Flask-Login,数据库Flask-SQLAlchemy),都需要用第三方的扩展来实现。比如可以用 Flask 扩展加入ORM、窗体验证工具,文件上传、身份验证等。Flask 没有默认使用的数据库,你可以选择 MySQL,也可以用 NoSQL。

其 WSGI 工具箱采用 Werkzeug(路由模块),模板引擎则使用 Jinja2。Itsdangrous这两个也是 Flask 框架的核心。

_images/flask-horizontal.png

官网文档:https://flask.palletsprojects.com/en/stable/

中文文档:https://dormousehole.readthedocs.io/en/latest/

异步版本:https://quart.palletsprojects.com/en/latest/

Flask常用第三方扩展包:

  • Flask-SQLalchemy:操作数据库,ORM;
  • Flask-script:终端脚本工具,脚手架;
  • Flask-migrate:管理迁移数据库;
  • Flask-Session:Session存储方式指定;
  • Flask-WTF:表单;
  • Flask-Mail:邮件;
  • Flask-Bable:提供国际化和本地化支持,翻译;
  • Flask-Login:认证用户状态;
  • Flask-OpenID:认证, OAuth;
  • Flask-RESTful:开发REST API的工具;
  • Flask JSON-RPC: 开发rpc远程服务[过程]调用
  • Flask-Bootstrap:集成前端Twitter Bootstrap框架
  • Flask-Moment:本地化日期和时间
  • Flask-Admin:简单而可扩展的管理接口的框架

可以通过 https://pypi.org/search/?c=Framework+%3A%3A+Flask 查看更多flask官方推荐的扩展

老三样:django,flask和 tornado,twisted

新三样:FastAPI,django,Flask[Quart]

1. 准备

目前最新版本是3.x版本,我们学习上有直接使用flask3.x即可。

mkvirtualenv flask -p python3

# anaconda创建虚拟环境
# conda create -n flask python=3.13 flask
# 进入/切换到指定名称的虚拟环境,如果不带任何参数,则默认回到全局环境base中。
# conda activate <虚拟环境名称>
# 退出当前虚拟环境
# conda deactivate

2. 安装

终端下执行安装命令:

pip install flask -i https://mirrors.aliyun.com/pypi/simple

3. 创建flask项目

与django不同,flask不会提供任何的自动操作,所以需要手动创建项目目录与启动项目的管理文件。

例如,创建项目目录 flaskdemo,在目录中创建manage.py.在pycharm中打开项目并指定上面创建的虚拟环境(下图中的Interperter表示Python解释器,此处)

image-20250220175723812

创建一个flask框架的启动文件。名字可以是app.py/run.py/main.py/index.py/manage.py/start.py

manage.py,代码:

from flask import Flask
app = Flask(__name__)

@app.route('/')
def index():
    return 'Hello World'

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

代码分析:

# 导入Flask类
from flask import Flask

"""
import_name      Flask程序所在的包(模块),传 __name__ 就可以
                 其可以决定 Flask 在访问静态文件时查找的路径
static_path      静态文件访问路径(不推荐使用,使用 static_url_path 代替)
static_url_path  静态文件访问路径,可以不传,默认为:/ + static_folder
static_folder    静态文件存储的文件夹,可以不传,默认为 static
template_folder  模板文件存储的文件夹,可以不传,默认为 templates
"""
app = Flask(import_name=__name__)


# 编写路由视图
# flask的路由是通过给视图添加装饰器的方式进行编写的。当然也可以分离到另一个文件中。
# flask的视图函数,flask中默认允许通过return返回html格式数据给客户端。
@app.route('/')
def index():
    return "<h1>hello world</h1>"

# 加载项目配置
class Config(object):
    # 开启调试模式
    DEBUG = True

# flask中支持多种配置方式,通过app.config来进行加载,我们会这里常用的是配置类
app.config.from_object( Config )


# 指定服务器IP和端口
if __name__ == '__main__':
    # 运行flask
    app.run(host="0.0.0.0", port=5000)

4. 路由的基本定义

路由和视图的名称必须全局唯一,不能出现重复,否则报错。

# 指定访问路径为 demo1
@app.route('/demo1')
def demo1():
    return 'demo1'

什么是路由?

路由就是一种映射关系。是绑定应用程序和url地址的一种一对一的映射关系!我们在开发过程中,编写项目时所使用的路由往往是指代了框架/项目中用于完成路由功能的类,这个类一般就是路由类,简称路由。

4.1 url中可以传递路由参数, 2种方式

路由参数就是url路径的一部分。

任意路由参数接收

# 路由传递参数[没有限定类型]
@app.route('/user/<user_id>')
def user_info(user_id):
    return 'hello %s' % user_id

限定路由参数接收

限定路由参数的类型,flask系统自带转换器编写在werkzeug.routing.py文件中。底部可以看到以下字典:

DEFAULT_CONVERTERS = {
    "default": UnicodeConverter,
    "string": UnicodeConverter,
    "any": AnyConverter,
    "path": PathConverter,
    "int": IntegerConverter,
    "float": FloatConverter,
    "uuid": UUIDConverter,
}

系统自带的转换器具体使用方式在每种转换器的注释代码中有写,请留意每种转换器初始化的参数。

转换器名称 描述
string 默认类型,接受不带斜杠的任何文本
int 接受正整数
float 接受正浮点值
path 接收string但也接受斜线
uuid 接受UUID(通用唯一识别码)字符串 xxxx-xxxx-xxxxx-xxxxx

代码:

# 限定类型传递路由参数
# flask内置的所有路由转换器是由werkzeug.routing的DEFAULT_CONVERTERS字典进行配置的。
# flask的所有路由转换器,本质上就是路由经过正则来进行匹配获取参数值的。所有的路由转换器都必须直接或间接继承于BaseConverter路由转换器基类
@app.route("/sms/<int(min=10,max=100):mobile>")
def sms(mobile):
    return f"mobile={mobile}"

4.1.1 自定义路由参数转换器

也叫正则匹配路由参数.

在 web 开发中,可能会出现限制用户访问规则的场景,那么这个时候就需要用到正则匹配,根据自己的规则去限定请求参数再进行访问

具体实现步骤为:

  • 导入转换器基类:在 Flask 中,所有的路由的匹配规则都是使用转换器对象进行记录
  • 自定义转换器:自定义类继承于转换器基类BaseConverter
  • 添加转换器到默认的转换器字典中
  • 使用自定义转换器实现自定义匹配规则

4.1.2 代码实现

  • 导入转换器基类
from werkzeug.routing import BaseConverter
  • 自定义转换器
# 自定义正则转换器
from werkzeug.routing import BaseConverter
class RegexConverter(BaseConverter):
    def __init__(self,map,*args):
        super().__init__(map)
        # 正则参数
        self.regex = args[0]
  • 添加转换器到默认的转换器字典中,并指定转换器使用时名字为: re
# 将自定义转换器添加到转换器字典中,并指定转换器使用时名字为: re
app.url_map.converters['re'] = RegexConverter
  • 使用转换器去实现自定义匹配规则
  • 当前此处定义的规则是:手机号码
# 自定义路由转换器
from werkzeug.routing import BaseConverter

class RegexConverter(BaseConverter):
    def __init__(self,map,*args):
        super().__init__(map)
        # 正则参数
        self.regex = args[0]

# 将自定义转换器添加到转换器字典中,并指定转换器使用时名字为: re
app.url_map.converters['re'] = RegexConverter

# 正则匹配路由
@app.route("/sms/<re('1[3-9]\d{9}'):mobile>")
def sms(mobile):
    return f"mobile={mobile}"

运行测试:http://127.0.0.1:5000/login/1311111111 ,如果访问的url不符合规则,会提示找不到页面

课堂代码:

from flask import Flask,request
# 初始化
app = Flask(import_name=__name__)

# 编写路由视图
@app.route(rule='/')
def index():
    return "<h1>hello world!</h1>"

# 关于路由参数的限制,flask内置的类型不够具体,在开发中,我们经常接受参数,需要更加精确的限制
# 这时候,可以使用正则匹配路由参数
# 正则匹配路由参数,其实就是扩展flask内置的路由限定类型,需要完成4个步骤
# 1. 引入flask的路由转换器
from werkzeug.routing import BaseConverter
# 2. 创建自定义路由转换器
class MobileConverter(BaseConverter):
    """手机号码类型限制"""
    def __init__(self,map,*args):
        super().__init__(map)
        self.regex = "1[3-9]\d{9}"
# 3. 把自定义转换器添加到flask默认的转换器字典中,也就是和原来的int,float等放在一块
app.url_map.converters['mob'] = MobileConverter

# 4. 类似原来的路由参数限制一样,调用自定义转换器名称即可
@app.route(rule='/user/<mob:mobile>')
def user(mobile):
    return mobile

# 1. 引入flask的路由转换器
from werkzeug.routing import BaseConverter
# 2. 创建自定义路由转换器
class RegexConverter(BaseConverter):
    """根据正则进行参数限制"""
    def __init__(self,map,*args):
        super().__init__(map)
        self.regex = args[0]
# 3. 把自定义转换器添加到flask默认的转换器字典中,也就是和原来的int,float等放在一块
app.url_map.converters['re'] = RegexConverter

# 4. 类似原来的路由参数限制一样,调用自定义转换器名称即可
@app.route(rule='/user/<re("\w+@\w+\.\w+"):email>')
def user2(email):
    print(app.url_map) # 获取所有的路由列表
    return email

# 声明和加载配置
class Config():
    DEBUG = True
app.config.from_object(Config)

if __name__ == '__main__':
    # 运行flask
    app.run(host="0.0.0.0")

4.2 路由限定请求方式

from flask import Flask,request
# 限制客户端的http请求方法,注意这里与django不一样,flask并没有默认没有内置csrf攻击防范
@app.route(rule="/user", methods=["post","put","get","delete","patch"])
def user():
    # 例如:地址栏中通过  http://127.0.0.1:5000/user?user=1 返回本视图
    print(request.method) # 获取本次客户端的http请求方法         GET
    print(request.query_string)  # 获取本次客户端的查询字符串    b'user=1'
    print(request.path)  # 获取本次客户端请求的路由路径部分[去掉域名端口]    /user
    print(request.url) # 获取本次客户端请求的http url地址        http://127.0.0.1:5000/user?user=1
    # 直接从请求中取到请求方式并返回
    return request.method

5. http的请求与响应

5.1 请求

文档: http://docs.jinkan.org/docs/flask/api.html#flask.request

  • request:flask中代表当前请求的 request 对象
  • 作用:在视图函数中取出本次请求数据
  • 导入from flask import request
  • 代码位置
  • ​ 代理类 from flask.app import Request,
  • ​ 源码类:from werkzeug.wrappers.Request
  • ​ 父类:from werkzeug.wrappers.base_request

常用的属性如下:

属性 说明 类型
data 记录请求体的数据,并转换为字符串
只要是通过其他属性无法识别转换的请求体数据
最终都是保留到data属性中
例如:有些公司开发小程序,原生IOS或者安卓,这一类客户端有时候发送过来的数据就不一样是普通的表单,查询字符串或ajax
bytes类型
form 记录请求中的html表单数据 MultiDict
args 记录请求中的查询字符串,也可以是query_string MultiDict
cookies 记录请求中的cookie信息 Dict
headers 记录请求中的请求头 EnvironHeaders
method 记录请求使用的HTTP方法 GET/POST
url 记录请求的URL地址 string
files 记录请求上传的文件列表 *
json 记录ajax请求的json数据 json

5.1.1 获取请求中各项数据

from flask import Flask,request
from urllib.parse import parse_qs

from werkzeug.datastructures import ImmutableMultiDict

app = Flask(__name__)

@app.route("/args", methods=["POST"])
def args():
    """获取查询字符串 """
    # 获取原生查询字符串 query_string
    # print( request.query_string )
    # print( parse_qs( request.query_string.decode() ) )
    """POST 127.0.0.1:5000/args?username=xiaoming&pwd=123
    b'username=xiaoming&pwd=123'
    {'username': ['xiaoming'], 'pwd': ['123']}
    """
    # 获取解析后的查询字符串
    # print(request.args)
    # print(request.args.get("username"))
    # print(request.args.get("lve"))
    # print(request.args.getlist("lve"))
    """POST /args?username=xiaoming&pwd=123&lve=shoping&lve=game
    ImmutableMultiDict([('username', 'xiaoming'), ('pwd', '123')]) # ImmutableMultiDict 是 一个有序字典,类似from collections import OrderedDict
    xiaoming
    shoping
    ['shoping', 'game']
    """
    print(request.args.to_dict(flat=True))
    print(request.args.to_dict(flat=False))
    print(request.args)
    """POST 127.0.0.1:5000/args?username=xiaoming&pwd=123&lve=shoping&lve=game
    {'username': 'xiaoming', 'pwd': '123', 'lve': 'shoping'}
    {'username': ['xiaoming'], 'pwd': ['123'], 'lve': ['shoping', 'game']}
    """
    return "hello"

@app.route(rule="/data",methods=["post","put","patch"])
def data():
    """接受客户端发送过来的原生请求体数据,是request.json,request.form,request.files等无法接收的数据,全部会保留到这里"""
    print(request.data)

    # 接受表单提交的数据
    print(request.form) # ImmutableMultiDict([('username', 'xiaoming'), ('password', '123456')])
    print(request.form.get("username"))

    # 接收上传,files是一个列表
    print( request.files ) # ImmutableMultiDict([('avatar', <FileStorage: 'hlw.jpg' ('image/jpeg')>)])
    avatar = request.files.get("avatar")  # ImmutableMultiDict([('avatar', <FileStorage: 'hlw.jpg' ('image/jpeg')>)])
    print(avatar)  # <FileStorage: 'hlw.jpg' ('image/jpeg')>

    # 接受ajax或其他客户端提交过来的json数据
    print( request.json ) # {'username': 'xiaoming', 'password': '123456'}

    # 获取请求头信息
    print()
    print()
    print( request.headers ) # 获取全部的而请求头信息
    print( request.headers.get("Host") )
    print( request.headers.get("Company")) # OldBoyEdu

    # 本次请求的url地址
    print( request.url) # http://127.0.0.1:5000/data
    print( request.path ) # /data
    print( request.remote_addr ) # /127.0.0.1

    return "hello"

if __name__ == '__main__':
    app.run(host="0.0.0.0",port=5000,debug=True)

5.2 响应

flask默认支持2种响应方式:

数据响应: 默认响应html文本,也可以返回 JSON格式,或其他格式

页面响应: 重定向

​ url_for 视图之间的跳转

响应的时候,flask也支持自定义http响应状态码

5.2.1 响应html文本

from flask import make_response

@app.route("/")
def index():
    # [默认支持]响应html文本
    return "<img src='http://flask.pocoo.org/static/logo.png'>"
    return make_response("<h1>hello user</h1>") # 等同于上面的一段

5.2.2 返回JSON数据

在 Flask 中可以直接使用 jsonify 生成一个 JSON 的响应

from flask import Flask, request, jsonify
# jsonify 就是json里面的jsonify

@app.route("/")
def index():
    # 也可以响应json格式代码
    # data = {
    #     "id":1,
    #     "uname":"xiaoming"
    # }
    data = [
        {"id":1,"username":"liulaoshi","age":18},
        {"id":2,"username":"liulaoshi","age":17},
        {"id":3,"username":"liulaoshi","age":16},
        {"id":4,"username":"liulaoshi","age":15},
    ]
    return jsonify(data)

flask中返回json 数据,都是flask的jsonify方法返回就可以了.

响应其他数据格式

from flask import Flask,make_response,jsonify

app = Flask(__name__)

@app.route("/")
def index():
    """响应处理"""
    # 返回图片等其他自定义格式数据
    # with open("hlw.jpg", "rb") as f:
    #     content = f.read()
    # response = make_response(content)
    # response.headers["Content-Type"] = "image/jpg" # MIME type 类型
    # return response

    with open("myCode.zip","rb") as f:
        content = f.read()

    response = make_response(content)
    response.headers["Content-Type"] = "application/zip"
    return response

if __name__ == '__main__':
    app.run(host="0.0.0.0",port=5000,debug=True)

5.2.3 重定向

重定向到百度页面

from flask import redirect
# 页面跳转响应
@app.route("/user")
def user():
    # 页面跳转 redirect函数就是response对象的页面跳转的封装
    return redirect("http://www.baidu.com")
    # # redirect内部完成的事情如下:
    # from werkzeug.wrappers import Response
    # response = Response()
    # response.headers["Location"] = "http://www.baidu.com"
    # return response
5.2.3.1 重定向到自己写的视图函数

可以直接填写自己 url 路径

也可以使用 url_for 生成指定视图函数所对应的 url,通过redirect来完成跳转

from flask import url_for

from flask import Flask,redirect, url_for

app = Flask(__name__)

@app.route("/")
def index():
    """响应处理"""
    # 根据视图名称进行页面跳转
    # url_for 根据视图函数名获取对应的uri地址
    url = url_for("user")
    print(url) # 仅仅是根据参数从app.url_map中提取对应的url地址
    return redirect(url)

@app.route("/user")
def user():
    return "用户中心"

if __name__ == '__main__':
    app.run(host="0.0.0.0",port=5000,debug=True)
5.2.3.2 重定向到带有参数的视图函数

在 url_for 函数中传入路由参数

from flask import Flask,redirect, url_for

app = Flask(__name__)

@app.route("/")
def index():
    """响应处理"""
    # 根据视图名称进行页面跳转
    url = url_for("user",user_id=3)
    print(url) # 仅仅是根据参数从app.url_map中提取对应的url地址
    return redirect(url)

@app.route("/user/<user_id>")
def user(user_id):
    return f"用户中心,user_id={user_id}"

if __name__ == '__main__':
    app.run(host="0.0.0.0",port=5000,debug=True)

5.2.4 自定义状态码和响应头

在 Flask 中,可以很方便的返回自定义状态码,以实现不符合 http 协议的状态码,例如:status code: 666

@app.route('/demo4')
def demo4():
    return '状态码为 666', 400

"""还可以使用make_response创建Response对象,然后通过response对象返回数据"""
from flask import make_response
@app.route("/rep")
def index7():
    response = make_response("ok")
    print(response)
    response.headers["Company"] = "oldboy" # 自定义响应头
    response.status_code = 201 # 自定义响应状态码
    return response

6. http的会话控制

所谓的会话,就是客户端浏览器和服务端网站之间一次完整的交互过程.

会话的开始是在用户通过浏览器第一次访问服务端网站开始.

会话的结束时在用户通过关闭浏览器以后,与服务端断开.

所谓的会话控制,就是在客户端浏览器和服务端网站之间,进行多次http请求响应之间,记录、跟踪和识别用户的信息而已。

因为 http 是一种无状态协议,浏览器请求服务器是无状态的。

无状态:指一次用户请求时,浏览器、服务器无法知道之前这个用户做过什么,每次请求都是一次新的请求。

无状态原因:浏览器与服务器是使用 socket 套接字进行通信的,服务器将请求结果返回给浏览器之后,会关闭当前的 socket 连接,而且服务器也会在处理页面完毕之后销毁页面对象。

有时需要保持下来用户浏览的状态,比如用户是否登录过,浏览过哪些商品等

实现状态保持主要有两种方式:

  • 在客户端存储信息使用Cookie,token[jwt,oauth]
  • 在服务器端存储信息使用Session
补充:
token是一种用户身份认证信息的技术,一般我们称之为:Token认证。
翻译中文:token一般叫令牌
本质就是一个经过特殊处理的字符串,往往在字符串内部隐藏着识别用户身份信息的关键内容。
一般开发中,token往往都是以识别用户身份为目的来使用的。

一般使用情况下,token会以用户身份信息,当前事件戳,随机数等因子构成的。
当然,更多情况下,token一般分三段:"头部.载荷.签证"
像实际开发中,我们一般说的jwt,csrf等等场景里面的token都是这一类的。

Cookie是由服务器端生成,发送给客户端浏览器,浏览器会自动将Cookie的key/value保存,下次请求同一网站时就发送该Cookie给服务器(前提是浏览器设置为启用cookie)。Cookie的key/value可以由服务器端自己定义。

使用场景: 登录状态, 浏览历史, 网站足迹, 购物车 [不登录也可以使用购物车]

Cookie是存储在浏览器中的一段纯文本信息,建议不要存储敏感信息如密码,因为电脑上的浏览器可能被其它人使用

Cookie基于域名安全,不同域名的Cookie是不能互相访问的

如访问oldboyedu.com时向浏览器中写了Cookie信息,使用同一浏览器访问baidu.com时,无法访问到oldboyedu写的Cookie信息

浏览器的同源策略针对cookie也有限制作用.

当浏览器请求某网站时,会将本网站下所有Cookie信息提交给服务器,所以在request中可以读取Cookie信息

设置cookie需要通过flask的Response响应对象来进行设置,由响应对象会提供了方法set_cookie给我们可以快速设置cookie信息。

from flask import Flask,make_response,request

app = Flask(__name__)

@app.route('/set_cookie')
def set_cookie():
    response = make_response('set cookie')
    response.set_cookie('age', '19') # 过期时间是会话期,关闭浏览器以后,自动删除
    response.set_cookie('username', 'xiaoming', max_age=3600) # 在指定max_age时间以后,才会自动删除
    return response

@app.route('/get_cookie')
def get_cookie():
    # 获取客户端发送过来的cookie要通过request.cookies来完成
    # request.cookies 获取全部cookie
    username = request.cookies.get('username')
    age = request.cookies.get('age')
    return f"username={username}&age={age}"

@app.route("/del_cookie")
def del_cookie():
    # 删除cookie,cookie的删除必须要通过response对当前cookie设置无效的值或者过期的有效时间,让浏览器自动删除
    response = make_response("del cookie")
    response.set_cookie("username","",expires=0)
    return response

if __name__ == '__main__':
    app.run(host="0.0.0.0",port=5000,debug=True)

6.2 Session

对于敏感、重要的信息,建议要存储在服务器端,不能存储在浏览器中,如用户名、余额、等级、验证码等信息

在服务器端进行状态保持的方案就是Session

Session依赖于Cookie,session的ID一般默认通过cookie来保存到客户端。

flask中的session需要加密,所以使用session之前必须配置SECRET_KEY选项,否则报错.

session的有效期默认是会话期,会话结束了,session就废弃了。

如果将来希望session的生命周期延长,可以通过修改cookie中的sessionID来完成配置。

6.2.1 session操作

from flask import Flask,session

app = Flask(__name__)

class Config(object):
    # 使用session之前,必须先设置秘钥
    SECRET_KEY = "123903tklasdlkas@"
app.config.from_object(Config)

@app.route('/set_session')
def set_session():
    """设置session数据"""
    session["uname"] = "xiaoming"
    session["age"] = 13
    session["book_list"] = [{"title":"book_name"},{"title":"book_name"}]
    return "set_session"

@app.route('/get_session')
def get_session():
    """获取session数据"""
    print(session.get("uname"))
    print(session.get("age"))
    print(session.get("book_list"))
    return "get_session"

@app.route('/del_session')
def del_session():
    """删除session数据"""
    if session.get("uname"):
        del session["uname"]
    return "ok"


if __name__ == '__main__':
    app.run(host="0.0.0.0",port=5000,debug=True)

7. Jinja2模板引擎

Flask内置的模板语言,它的设计思想来源于 Django 的模板引擎DTP(Django Template),并扩展了其语法和一系列强大的功能。

渲染模版函数

  • Flask提供的 render_template 函数封装了该模板引擎
  • render_template 函数的第一个参数是模板的文件名,后面的参数都是键值对,表示模板中变量对应的真实值。

7.1 模板基本使用

  1. 在flask应用对象创建的时候,设置或者保留template_folder参数,创建模板目录
app = Flask(__name__,template_folder='templates')
  1. 在项目下创建 templates 文件夹,用于存放所有的模板文件,并在目录下创建一个模板html文件 index.html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <h1>{{title}}</h1>
</body>
</html>
  1. 在视图函数设置渲染模板并设置模板数据
from flask import Flask, render_template, render_template_string
# 初始化
app = Flask(import_name=__name__,template_folder='templates')

# 配置终端脚本运行项目
from flask_script import Manager
manager = Manager(app)

# 声明和加载配置
class Config():
    DEBUG = True
app.config.from_object(Config)

# 编写路由视图
@app.route(rule='/')
def index():
    data={}
    data["title"] = "我的flask项目"
    return render_template("index.html",**data)
    # return render_template_string(open("templates/index.html"), **data)
if __name__ == '__main__':
    # 运行flask
    manager.run()

7.1.1 输出变量

{{  }} 来表示变量名,这种 {{  }} 语法叫做 变量代码块

视图代码:

from flask import Flask,render_template,render_template_string
app = Flask(__name__)

@app.route("/")
def index():
    """基本加载模板"""
    data = {}
    data["msg"] = "hello ,jinja2"
    data["title"] = "我的网页标题"
    # 根据模板路径来生成html ---> render_template("模板路径",**data)
    ret = render_template("index.html",**data)

#     content = """<!DOCTYPE html>
# <html lang="en">
# <head>
#     <meta charset="UTF-8">
#     <title>Title</title>
# </head>
# <body>
#     <h1>{{ msg }}</h1>
# </body>
# </html>
#     """
#     # 根据模板内容来生成html ---> render_template_string("html模板代码",**data)
#     ret = render_template_string(content,**data)
#     print(ret)
#     """打印效果:
#     <!DOCTYPE html>
# <html lang="en">
# <head>
#     <meta charset="UTF-8">
#     <title>Title</title>
# </head>
# <body>
#     <h1>hello ,jinja2</h1>
# </body>
# </html>
#     """
#     print(type(ret))  # <class 'str'>
    return ret

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

模板代码

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>{{ title }}</title>
</head>
<body>
    <h1>{{ msg }}</h1>
</body>
</html>

Jinja2 模版中的变量代码块可以是任意 Python 类型或者对象,只要它能够被 Python 的 __str__ 方法或者str()转换为一个字符串就可以,比如,可以通过下面的方式显示一个字典或者列表中的某个元素:

视图代码:

from flask import Flask,render_template
from settings.dev import Config
from flask_script import Manager
"""创建flask应用"""
app = Flask(__name__,template_folder='templates')
"""使用脚手架[终端脚本]启动项目"""
manage = Manager(app)
"""加载配置"""
app.config.from_object(Config)

@app.route("/")
def index():
    data = {}
    data["title"] = "我的项目"
    data["data_list"] = ["a","b","c"]
    data["data_dict"] = {
        "name":"xiaoming",
        "id":100,
    }
    # return render_template("index.html",
    #                        title="我的flask项目",
    #                        data_list=data_list,
    #                        data_dict=data_dict
    #                        )
    return render_template("index.html",**data)
if __name__ == '__main__':
    manage.run()

模板代码:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>{{title}}</title>
</head>
<body>
    <div>{{title}}</div>
    <div>{{list}}</div>
    <div>{{list[0]}}</div>
    <div>{{list.0}}</div>
    <div>{{list[-1]}}</div>
    <div>{{dict}}</div>
    <div>{{dict['name']}}</div>
    <div>{{dict.name}}</div>
</body>
</html>

使用 {# #} 进行注释,注释的内容不会在html中被渲染出来

{# {{ name }} #}

7.2 模板中特有的变量和函数

你可以在自己的模板中访问一些 Flask 默认内置的函数和对象

7.2.1 config

你可以从模板中直接访问Flask当前的config对象:

{{config.SQLALCHEMY_DATABASE_URI}}
sqlite:///database.db

7.2.2 request

就是flask中代表当前请求的request对象:

{{request.url}}
http://127.0.0.1

7.2.3 session

为Flask的session对象,显示session数据

{{session.new}}
True

7.2.4 g变量

在视图函数中设置g变量的 name 属性的值,然后在模板中直接可以取出

{{ g.name }}

7.2.5 url_for()

urlfor会根据传入的路由器函数名,返回该路由对应的URL,在模板中始终使用urlfor()就可以安全的修改路由绑定的URL,则不比担心模板中渲染出错的链接:

{{url_for('home')}}

如果我们定义的路由URL是带有参数的,则可以把它们作为关键字参数传入url_for(),Flask会把他们填充进最终生成的URL中:

{{ url_for('index', post_id=1)}}
/1

课堂代码:

主程序 run.py:

from flask import Flask,render_template,render_template_string, g
app = Flask(__name__)

@app.route("/")
def index():
    """基本加载模板"""
    data = {}
    data["title"] = "hello ,jinja2"
    data["num_list"] = [1,3,5]
    data["book"] = {"id":1, "title":"代码之髓","price":99.0}
    data["book_list"] = [
        {"id": 1, "title": "代码之髓1", "price": 99.0},
        {"id": 2, "title": "代码之髓2", "price": 99.0},
        {"id": 3, "title": "代码之髓3", "price": 99.0}
    ]
    g.uname = "xikaoming"
    ret = render_template("index.html",**data)
    return ret

@app.route("/user/login")
def login():
    return "hello"

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

模板 templates/index.html:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>{{ title }}</title>
</head>
<body>
    <h1>{{ msg }}</h1>
    <h1>{{ book.title }}</h1>
    <h1>{{ book_list[1].title }}</h1>
{#    {{ num_list[1] + 10 }}#}
    {{ config.JSONIFY_MIMETYPE }}

    <p>{{ request.full_path }}</p>
    <p>{{ request.args }}</p>
    <p>{{ session.new }}</p>
    <p>{{ g.uname }}</p>
    <p>{{ url_for("login") }}</p>
</body>
</html>

pycharm中设置当前项目的模板语言:

files/settings/languages & frameworks/python template languages。

设置下拉框为jinja2,保存

1596532209377

7.3 流程控制

主要包含两个:

- if / elif /else / endif
- for / endfor

7.3.1 if语句

Jinja2 语法中的if语句跟 Python 中的 if 语句相似,后面的布尔值或返回布尔值的表达式将决定代码中的哪个流程会被执行.

用 {%%} 定义的控制代码块,可以实现一些语言层次的功能,比如循环或者if语句

视图代码:

from flask import Flask,render_template,request
from settings.dev import Config
from flask_script import Manager
"""创建flask应用"""
app = Flask(__name__,template_folder='templates')
"""使用脚手架[终端脚本]启动项目"""
manage = Manager(app)
"""加载配置"""
app.config.from_object(Config)

@app.route("/list")
def list_page():
    data = {}
    data["book_list"] = [
        {"id":1,"price":78.50,"title":"javascript入门"},
        {"id":2,"price":78.50,"title":"python入门"},
        {"id":3,"price":78.50,"title":"django项目实战"}
    ]
    data["name"] = int( request.args.get("name") )
    return render_template("list.html",**data)

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

list.html,模板代码:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <table border="1" align="center" width="680">
        <tr>
            <th>id</th>
            <th>标题</th>
            <th>价格</th>
        </tr>
        {# for循环 #}
        {% for book in book_list %}
        <tr>
            <td>{{ book.id }}</td>
            <td>{{ book.title }}</td>
            <td>{{ book.price }}</td>
        </tr>
        {% endfor %}
    </table>

    {# 判断一个参数是否是奇数 #}
    {% if name % 2 == 0 %}
        偶数<br>
    {% else %}
        奇数<br>
    {% endif %}
</body>
</html>

flask中也有过滤器,并且可以使用变量代码块中,也可以被用在 if 语句或者for语句中:

视图代码:

from flask import Flask,render_template,request
from settings.dev import Config
from flask_script import Manager
"""创建flask应用"""
app = Flask(__name__,template_folder='templates')
"""使用脚手架[终端脚本]启动项目"""
manage = Manager(app)
"""加载配置"""
app.config.from_object(Config)

@app.route("/")
def index():
    data = {}
    data["title"] = "我的项目"
    data["data_list"] = ["a","b","c"]
    data["data_dict"] = {
        "name":"xiaoming",
        "id":100,
    }
    # return render_template("index.html",
    #                        title="我的flask项目",
    #                        data_list=data_list,
    #                        data_dict=data_dict
    #                        )
    return render_template("index.html",**data)

@app.route("/list")
def list_page():
    data = {}
    data["book_list"] = [
        {"id":1,"price":78.50,"title":"javascript入门"},
        {"id":2,"price":78.50,"title":"python入门"},
        {"id":3,"price":78.50,"title":"django项目实战"}
    ]
    data["name"] = int( request.args.get("name") )
    return render_template("list.html",**data)

@app.route("/filter")
def filter():
    data = {}
    data["text"] = "hello flask"
    data["img_url"] = '<img width="300px" src="https://github.githubassets.com/images/modules/site/heroes/octocat-paper.svg">'
    return render_template("fitler.html",**data)

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

filter.html,模板代码:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <p>{{ text }}</p>
    <p>{{ text|upper }}</p>
    <p>{{ text|length }}</p>
    <p>{{ img_url }}</p>
    <p>{{ img_url|safe }}</p>
    {% if request.args.get("name")| int % 2 == 0 %}
    <p>偶数</p>
    {% else %}
    <p>奇数</p>
    {% endif %}
</body>
</html>

7.3.2 循环语句

  • 我们可以在 Jinja2 中使用循环来迭代任何列表或者生成器函数
{% for post in posts %}
    <div>
        <h1>{{ post.title }}</h1>
        <p>{{ post.text | safe }}</p>
    </div>
{% endfor %}
  • 循环和if语句可以组合使用,以模拟 Python 循环中的 continue 功能,下面这个循环将只会渲染post.text不为None的那些post:
{% for post in posts if post.text %}
    <div>
        <h1>{{ post.title }}</h1>
        <p>{{ post.text | safe }}</p>
    </div>
{% endfor %}
  • 在一个 for 循环块中你可以访问这些特殊的变量:
变量 描述
loop.index 当前循环迭代的次数(从 1 开始)
loop.index0 当前循环迭代的次数(从 0 开始)
loop.revindex 到循环结束需要迭代的次数(从 1 开始)
loop.revindex0 到循环结束需要迭代的次数(从 0 开始)
loop.first 如果是第一次迭代,为 True 。
loop.last 如果是最后一次迭代,为 True 。
loop.length 序列中的项目数。
loop.cycle 在一串序列间期取值的辅助函数。见下面示例程序。
  • 在循环内部,你可以使用一个叫做loop的特殊变量来获得关于for循环的一些信息
  • 比如:要是我们想知道当前被迭代的元素序号,并模拟Python中的enumerate函数做的事情,则可以使用loop变量的index属性,例如:
{% for post in posts%}
{{loop.index}}, {{post.title}}
{% endfor %}
  • 会输出这样的结果
1, Post title
2, Second Post
  • cycle函数会在每次循环的时候,返回其参数中的下一个元素,可以拿上面的例子来说明:
{% for post in posts%}
    {{loop.cycle('odd','even')}} {{post.title}}
{% endfor %}
  • 会输出这样的结果:
odd Post Title
even Second Post

视图代码:

from flask import Flask, render_template
# 初始化
app = Flask(import_name=__name__,template_folder='templates')

# 配置终端脚本运行项目
from flask_script import Manager
manager = Manager(app)

# 声明和加载配置
class Config():
    DEBUG = True
    SECRET_KEY = "abc"
app.config.from_object(Config)

# 编写路由视图
@app.route(rule='/')
def index():
    data={}
    data["title"] = "我的项目"
    data["book_list"] = [
        {"id":10,"price":78.50,"title":"javascript入门"},
        {"id":21,"price":78.50,"title":"python入门"},
        {"id":33,"price":78.50,"title":"django项目实战"},
        {"id":34,"price":78.50,"title":"django项目实战"},
        {"id":33,"price":78.50,"title":"django项目实战"},
    ]
    return render_template("index.html",**data)

if __name__ == '__main__':
    # 运行flask
    manager.run()

continue.html,模板代码:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>{{title}}</title>
</head>
<body>
<p>判断</p>
<!--{% if request.args.name %}-->
<!--    <p>欢迎回来,{{request.args.name}}</p>-->
<!--{% endif %}-->

<!--{% if request.args.name %}-->
<!--    <p>欢迎回来,{{request.args.name}}</p>-->
<!--{% else %}-->
<!--    <p>对不起,您尚未登录</p>-->
<!--{% endif %}-->

<!--{% if request.args.name=="root" %}-->
<!--    <p>欢迎回来,您是当前网站的超级管理员~</p>-->
<!--{% elif request.args.name %}-->
<!--    <p>尊敬的用户{{request.args.name}},欢迎回来</p>-->
<!--{% else %}-->
<!--    <p>对不起,您尚未登录</p>-->
<!--{% endif %}-->


<p>循环</p>
<table border="1" align="center" width="600">
    <tr>
        <th>序号</th>
        <th>ID</th>
        <th>price</th>
        <th>title</th>
    </tr>
    {% for book in book_list %}
        {% if loop.index %2 == 0 %}
            <tr bgcolor="#add8e6">
        {% else %}
            <tr>
        {% endif %}
            <td>{{ loop.index }}</td>
            <td>{{ book.id }}</td>
            <td>{{ book.price }}</td>
            <td>{{ book.title }}</td>
    </tr>
    {% endfor %}
</table>

</body>
</html>

7.4 过滤器

过滤器的本质就是函数。有时候我们不仅仅只是需要输出变量的值,我们还需要修改变量的显示,甚至格式化、运算等等,而在模板中是不能直接调用 Python 中的某些方法,那么这就用到了过滤器。

使用方式:

  • 过滤器的使用方式为:。
{{ 变量 | 过滤器函数名(参数1,参数2,....)}}
{{ 变量 | 过滤器函数名(参数1,参数2,....) | 过滤器函数名(参数1,参数2,....) | ....}}
  • 如果没有任何参数传给过滤器,则可以把括号省略掉
{{ 变量 | 过滤器函数名 }}
  • 如:upper,这个过滤器的作用:把变量variable 的值的首字母转换为大写,其他字母转换为小写

在 jinja2 中,过滤器是可以支持链式调用的,示例如下:

{{ "hello world" | reverse | upper }}

7.4.1 常见的内建过滤器

7.4.1.1 字符串操作
  • safe:禁用转义
<p>{{ '<em>hello</em>' | safe }}</p>
  • capitalize:把变量值的首字母转成大写,其余字母转小写
<p>{{ 'hello' | capitalize }}</p>
  • lower:把值转成小写
<p>{{ 'HELLO' | lower }}</p>
  • upper:把值转成大写
<p>{{ 'hello' | upper }}</p>
  • title:把值中的每个单词的首字母都转成大写
<p>{{ 'hello' | title }}</p>
  • reverse:字符串反转
<p>{{ 'olleh' | reverse }}</p>
  • format:格式化输出
<p>{{ '%s is %d' | format('name',17) }}</p>
  • striptags:渲染之前把值中所有的HTML标签都删掉

如果内容中,存在大小于号的情况,则不要使用这个过滤器,容易误删内容。

<p>{{ '<em>hello</em>' | striptags }}</p>
<p>{{ "如果x<y,z>x,那么x和z之间是否相等?" | striptags }}</p>
  • truncate: 字符串截断
<p>{{ 'hello every one' | truncate(9)}}</p>
7.4.1.2 列表操作
  • first:取第一个元素
<p>{{ [1,2,3,4,5,6] | first }}</p>
  • last:取最后一个元素
<p>{{ [1,2,3,4,5,6] | last }}</p>
  • length:获取列表长度
<p>{{ [1,2,3,4,5,6] | length }}</p>
  • sum:列表求和
<p>{{ [1,2,3,4,5,6] | sum }}</p>
  • sort:列表排序
<p>{{ [6,2,3,1,5,4] | sort }}</p>
7.4.1.3 语句块过滤
{% filter upper %}
    <p>hello world</p>
    <p>hello world</p>
    <p>hello world</p>
    <p>hello world</p>
{% endfilter %}

7.4.2 自定义过滤器

过滤器的本质是函数。当模板内置的过滤器不能满足需求,可以自定义过滤器。自定义过滤器有两种实现方式:

  • 一种是通过Flask应用对象的 addtemplatefilter 方法
  • 通过装饰器来实现自定义过滤器

重要:自定义的过滤器名称如果和内置的过滤器重名,会覆盖内置的过滤器。

需求:添加列表反转的过滤器

方式一

通过调用应用程序实例的 addtemplatefilter 方法实现自定义过滤器。该方法第一个参数是函数名,第二个参数是自定义的过滤器名称:

# 自定义过滤器
def list_reverse(data):
    # 过滤器必须有返回值,否则模板中没有内容输出!!!
    return data[::-1]

app.add_template_filter(list_reverse, "list_reverse")

方式二

用装饰器来实现自定义过滤器。装饰器传入的参数是自定义的过滤器名称。

@app.add_template_filter
def list_reverse(data):
    return data[::-1]
  • 主程序中创建和注册过滤器
from flask import Flask, render_template
# 初始化
app = Flask(import_name=__name__,template_folder='templates')

# 配置终端脚本运行项目
from flask_script import Manager
manager = Manager(app)

# 声明和加载配置
class Config():
    DEBUG = True
app.config.from_object(Config)

# 自定义过滤器
def do_list_reverse(data):
    return data[::-1]

# 注册过滤器
app.add_template_filter(do_list_reverse, "list_reverse")

@app.route(rule='/')
def index():
    data={}
    data["user_list"] = ["xiaoming","小黑白","小红"]
    return render_template("index.html",**data)


if __name__ == '__main__':
    # 运行flask
    manager.run()
  • html调用过滤器
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>title</title>
</head>
<body>
    <p>{{ user_list }}</p>
    <p>{{ user_list | list_reverse }}</p>
    <p>{{ user_list }}</p>
</body>
</html>
  • 运行结果
['xiaoming', '小黑白', '小红']

['小红', '小黑白', 'xiaoming']

['xiaoming', '小黑白', '小红']

7.4.3 案例:给手机进行部分屏蔽

13812345678 ---> 138****5678

代码:

from flask import Flask,render_template,request
from settings.dev import Config
from flask_script import Manager
"""创建flask应用"""
app = Flask(__name__,template_folder='templates')
"""使用脚手架[终端脚本]启动项目"""
manage = Manager(app)
"""加载配置"""
app.config.from_object(Config)

@app.template_filter("mobile")
def do_mobile(data,string):
    return data[:3]+string+data[7:]

@app.route("/")
def index():
    data = {}
    data["user_list"] = [
        {"id":1,"name":"张三","mobile":"13112345678"},
        {"id":2,"name":"张三","mobile":"13112345678"},
        {"id":3,"name":"张三","mobile":"13112345678"},
        {"id":4,"name":"张三","mobile":"13112345678"},
    ]
    return render_template("index2.html",**data)

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

index2.html,模板代码:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<table border="1" align="center" width="680">
    <tr>
        <th>ID</th>
        <th>姓名</th>
        <th>手机</th>
    </tr>
    {% for user in user_list %}
    <tr>
        <td>{{ user.id }}</td>
        <td>{{ user.name }}</td>
        <td>{{ user.mobile | mobile(string="****") }}</td>
    </tr>
    {% endfor %}

</table>
</body>
</html>

效果:

1563855291209

7.5 模板继承

在模板中,可能会遇到以下情况:

  • 多个模板具有完全相同的顶部和底部内容
  • 多个模板中具有相同的模板代码内容,但是内容中部分值不一样
  • 多个模板中具有完全相同的 html 代码块内容

像遇到这种情况,可以使用 JinJa2 模板中的 继承 来进行实现

模板继承是为了重用模板中的公共内容。一般Web开发中,继承主要使用在网站的顶部菜单、底部。这些内容可以定义在父模板中,子模板直接继承,而不需要重复书写。

  • 标签定义的内容
{% block top %} {% endblock %}
  • 相当于在父模板中挖个坑,当子模板继承父模板时,可以进行填充。
  • 子模板使用 extends 指令声明这个模板继承自哪个模板
  • 父模板中定义的块在子模板中被重新定义,在子模板中调用父模板的内容可以使用super()

父模板代码:

base.html

{% block top %}
  顶部菜单
{% endblock top %}

{% block content %}
{% endblock content %}

{% block bottom %}
  底部
{% endblock bottom %}

子模板代码:

  • extends指令声明这个模板继承自哪
{% extends 'base.html' %}
{% block content %}
 需要填充的内容
{% endblock content %}

模板继承使用时注意点:

  1. 不支持多继承

  2. 为了便于阅读,在子模板中使用extends时,尽量写在模板的第一行,而且extends必须在最上方

  3. 不能在一个模板文件中定义多个相同名字的block标签。否则报错

  4. 当在页面中使用多个block标签时,建议给结束标签起个名字,当多个block嵌套时,阅读性更好。

7.6 在 Flask 项目中解决 CSRF 攻击

pip install flask_wtf

在 Flask 中, Flask-wtf 扩展有一套完善的 csrf 防护体系,对于我们开发者来说,使用起来非常简单

  1. 设置应用程序的 secretkey,用于加密生成的 csrftoken 的值
# 1. session加密的时候已经配置过了.如果没有在配置项中设置,则如下:
app.secret_key = "#此处可以写随机字符串#"

# 2. 也可以写在配置类中。
class Config(object):
    DEBUG = True
    SECRET_KEY = "dsad32DASSLD*13%^32"

"""加载配置"""
app.config.from_object(Config)
  1. 导入 flask_wtf.csrf 中的 CSRFProtect 类,进行初始化,并在初始化的时候关联 app
from flask.ext.wtf import CSRFProtect
CSRFProtect(app)
  1. 在表单中使用 CSRF 令牌:
<form method="post" action="/">
    <input type="hidden" name="csrf_token" value="{{ csrf_token() }}" />
</form>

视图代码;

from flask import Flask,render_template
from settings.dev import Config
from flask_script import Manager
from flask_wtf.csrf import CSRFProtect
# from flask.ext.wtf import CSRFProtect  # 低版本的flask直接可以引入
"""创建flask应用"""
app = Flask(__name__,template_folder='templates')
"""使用脚手架[终端脚本]启动项目"""
manage = Manager(app)
"""加载配置"""
app.config.from_object(Config)

"""初始化csrf防范机制"""
CSRFProtect(app)

@app.route("/login",methods=["get"])
def loginform():
    return render_template("login.html")

@app.route("/dologin",methods=["post"])
def login():
    return "ok"

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

模板代码:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <form action="{{ url_for('login') }}" method="post">
        <input type="hidden" name="csrf_token" value="{{ csrf_token() }}">
        <input type="submit" value="登录">
    </form>
</body>
</html>

csrf怎么识别提交过来的csrf_token是正确的?

原理和jwt认证是一样的
csrf_token也是token令牌的应用方式也是分  "头部.载荷.签证"
在表单提交到服务端时WTForms内部会直接截取提交的csrf_token的头部和载荷并从flask中提取秘钥SECRET_KEY生成一个新的签证新签证与客户端提交的csrf_token签证进行字符串比较相同则表示token没有问题

8. 数据库操作

8.1 ORM

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

优点 :

  • 只需要面向对象编程, 不需要面向数据库编写代码.
  • 对数据库的操作都转化成对类/对象的属性和方法的操作. 字段--->属性, 关键字-> 操作方法
  • 不用编写各种数据库的sql语句.
  • 实现了数据模型与数据库的解耦, 屏蔽了不同数据库操作上的差异.
  • 不再需要关注当前项目使用的是哪种数据库。
  • 通过简单的配置就可以轻松更换数据库, 而不需要修改代码.

缺点:

  • 相比较直接使用SQL语句操作数据库,ORM需要把操作转换成SQL语句,所以有性能损失.
  • 根据对象的操作转换成SQL语句,根据查询的结果转化成对象, 在映射过程中有性能损失.
  • 增加了学习成本,不同的ORM提供的操作不一样

8.2 Flask-SQLAlchemy

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

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

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

安装 flask-sqlalchemy【清华源】

pip install flask-sqlalchemy -i https://pypi.tuna.tsinghua.edu.cn/simple

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

pip install flask-mysqldb -i https://pypi.tuna.tsinghua.edu.cn/simple

安装flask-mysqldb时,注意

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

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

解决方案:

sudo 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 -i https://pypi.tuna.tsinghua.edu.cn/simple

8.2.1 数据库连接设置

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

config.py,配置文件代码:

class Config(object):
    DEBUG = True
    SECRET_KEY = "*(%#4sxcz(^(#$#8423"
    # 数据库链接配置 = 数据库名称://登录账号:登录密码@数据库主机IP:数据库访问端口/数据库名称?charset=编码类型 dsn
    SQLALCHEMY_DATABASE_URI = "mysql://root:123@127.0.0.1:3306/students?charset=utf8mb4"
  • 其他设置:
# 动态追踪修改设置,如未设置只会提示警告
SQLALCHEMY_TRACK_MODIFICATIONS = True
#查询时会显示原始SQL语句
SQLALCHEMY_ECHO = True
  • 配置完成需要去 MySQL 中创建项目所使用的数据库
mysql -uroot -p123
create database students charset=utf8mb4;

8.2.2 常用的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 二进制文件内容

8.2.3 常用的SQLAlchemy列约束选项

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

8.3 数据库基本操作

  • 在Flask-SQLAlchemy中,添加、修改、删除操作,均由数据库会话(sessionSM)管理。
  • 会话用 db.session 表示。在准备把数据写入数据库前,要先将数据添加到会话中然后调用 db.commit() 方法提交会话。
  • 在 Flask-SQLAlchemy 中,查询操作是通过 query 对象操作数据。
  • 最基本的查询是返回表中所有数据,可以通过过滤器进行更精确的数据库查询。

8.3.1 模型类定义

我们后面会把模型创建到单独的文件中,但是现在我们先把模型类写在main.py文件中。

from flask import Flask
app = Flask(__name__)

class Config(object):
    DEBUG = True
    # 数据库连接配置
    # SQLALCHEMY_DATABASE_URI = "数据库类型://数据库账号:密码@数据库地址:端口/数据库名称?charset=utf8mb4"
    SQLALCHEMY_DATABASE_URI = "mysql://root:123@127.0.0.1:3306/students?charset=utf8mb4"
    # 动态追踪修改设置,如未设置只会提示警告
    SQLALCHEMY_TRACK_MODIFICATIONS = True
    # 查询时会显示原始SQL语句
    SQLALCHEMY_ECHO = True

app.config.from_object(Config)


"""模型类定义"""
from flask_sqlalchemy import SQLAlchemy
db = SQLAlchemy(app=app)
# 等同于
# db = SQLAlchemy()
# db.init_app(app)

class Student(db.Model):
    """学生信息模型"""
    # 声明与当前模型绑定的数据表名称
    __tablename__ = "db_students"
    # 字段定义
    """
    create table db_student(
      id int primary key auto_increment comment="主键",
      name varchar(15) comment="姓名",
    )
    """
    id = db.Column(db.Integer, primary_key=True,comment="主键")
    name = db.Column(db.String(15), comment="姓名")
    age = db.Column(db.SmallInteger, comment="年龄")
    sex = db.Column(db.Boolean, default=True, comment="性别")
    email = db.Column(db.String(128), unique=True, comment="邮箱地址")
    money = db.Column(db.Numeric(10,2), default=0.0, comment="钱包")

    def __repr__(self):
        return f"{self.name}<Student>"

# 所有的模型必须直接或间接继承于db.Model
class Course(db.Model):
    """课程数据模型"""
    __tablename__ = "db_course"
    id = db.Column(db.Integer, primary_key=True, comment="主键")
    name = db.Column(db.String(64), unique=True, comment="课程")
    price = db.Column(db.Numeric(7, 2))
    # repr()方法类似于django的__str__,用于打印模型对象时显示的字符串信息
    def __repr__(self):
        return f'{self.name}<Course>'

class Teacher(db.Model):
    """老师数据模型"""
    __tablename__ = "db_teacher"
    id = db.Column(db.Integer, primary_key=True, comment="主键")
    name = db.Column(db.String(64), unique=True, comment="姓名")
    option = db.Column(db.Enum("讲师", "助教", "班主任"), default="讲师")

    def __repr__(self):
        return f"{self.name}< Teacher >"

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

if __name__ == '__main__':
    with app.app_context():
        # 检测数据库中是否存在和模型匹配的数据表。
        # 如果没有,则根据模型转换的建表语句进行建表。
        # 如果找到,则不会进行额外处理
        db.create_all()
    app.run(debug=True)

8.3.2 数据表操作

8.3.2.1 创建和删除表

创建表

    with app.app_context():
        # create_all()方法执行的时候,需要放在模型的后面
        # 检测数据库中是否存在和模型匹配的数据表。
        # 如果没有,则根据模型转换的建表语句进行建表。
        # 如果找到,则不会进行额外处理
        db.create_all()

删除表

db.drop_all()  # 慎用,很给力的!!

代码:

from flask import Flask
app = Flask(__name__)

class Config(object):
    DEBUG = True
    # 数据库连接配置
    # SQLALCHEMY_DATABASE_URI = "数据库类型://数据库账号:密码@数据库地址:端口/数据库名称?charset=utf8mb4"
    SQLALCHEMY_DATABASE_URI = "mysql://root:123@127.0.0.1:3306/students?charset=utf8mb4"
    # 动态追踪修改设置,如未设置只会提示警告
    SQLALCHEMY_TRACK_MODIFICATIONS = True
    # 查询时会显示原始SQL语句
    SQLALCHEMY_ECHO = True

app.config.from_object(Config)


"""模型类定义"""
from flask_sqlalchemy import SQLAlchemy
db = SQLAlchemy(app=app)
# 等同于
# db = SQLAlchemy()
# db.init_app(app)

class Student(db.Model):
    """学生信息模型"""
    # 声明与当前模型绑定的数据表名称
    __tablename__ = "db_students"
    # 字段定义
    """
    create table db_student(
      id int primary key auto_increment comment="主键",
      name varchar(15) comment="姓名",
    )
    """
    id = db.Column(db.Integer, primary_key=True,comment="主键")
    name = db.Column(db.String(15), comment="姓名")
    age = db.Column(db.SmallInteger, comment="年龄")
    sex = db.Column(db.Boolean, default=True, comment="性别")
    email = db.Column(db.String(128), unique=True, comment="邮箱地址")
    money = db.Column(db.Numeric(10,2), default=0.0, comment="钱包")

    def __repr__(self):
        return f"{self.name}<Student>"

# 所有的模型必须直接或间接继承于db.Model
class Course(db.Model):
    """课程数据模型"""
    __tablename__ = "db_course"
    id = db.Column(db.Integer, primary_key=True, comment="主键")
    name = db.Column(db.String(64), unique=True, comment="课程")
    price = db.Column(db.Numeric(7, 2))
    # repr()方法类似于django的__str__,用于打印模型对象时显示的字符串信息
    def __repr__(self):
        return f'{self.name}<Course>'

class Teacher(db.Model):
    """老师数据模型"""
    __tablename__ = "db_teacher"
    id = db.Column(db.Integer, primary_key=True, comment="主键")
    name = db.Column(db.String(64), unique=True, comment="姓名")
    option = db.Column(db.Enum("讲师", "助教", "班主任"), default="讲师")

    def __repr__(self):
        return f"{self.name}< Teacher >"

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

if __name__ == '__main__':
    with app.app_context():
        # db.drop_all()
        # 检测数据库中是否存在和模型匹配的数据表。
        # 如果没有,则根据模型转换的建表语句进行建表。
        # 如果找到,则不会进行额外处理
        db.create_all()
    app.run(debug=True)

8.3.3 数据操作

添加一条数据

student1 = Student(name="小明", sex=True, age=17, email="123456@qq.com", money=100)
db.session.add(student1)
db.session.commit()

#再次插入 一条数据
student2 = Student(name='小红', sex=False, age=13, email="16565666@qq.com", money=600)
db.session.add(student2)
db.session.commit()

一次插入多条数据

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

删除数据

# 方法1[先查询后删除,2条语句]
# 先查询出来
student = Student.query.first()
print(student)
# 再进行删除
db.session.delete(student)
db.session.commit()

# 方法2【一条语句执行,性能更好更高效,在数据改动时添加条件才进行操作,这种用法就是乐观锁】     
# 乐观锁和悲观锁
Student.query.filter(Student.id > 5).delete()
db.session.commit()

更新数据

# 先查询数据,然后进行更新,2条语句
stu = Student.query.first()
stu.name = 'dong'
db.session.commit()

# 直接根据条件更新,一条语句[乐观锁]
Student.query.filter(Student.name == 'chen').update({'money': 1998})
db.session.commit()

# 字段引用[利用当前一条数据的字典值进行辅助操作,实现类似django里面F函数的效果]
Student.query.filter(Student.name == "zhang").update({"money":Student.money+1000 * Student.age})
db.session.commit()

8.3.4 基本查询

8.3.4.1 常用的SQLAlchemy查询过滤器
过滤器 说明
filter() 把过滤器添加到原查询上,返回一个新查询
filter_by() 把等值过滤器添加到原查询上,返回一个新查询
limit() 使用指定的值限定原查询返回的结果数量
offset() 设置结果范围的开始位置,偏移原查询返回的结果,返回一个新查询
order_by() 根据指定条件对原查询结果进行排序,返回一个新查询
group_by() 根据指定条件对原查询结果进行分组,返回一个新查询
8.3.4.2 常用的SQLAlchemy查询结果的方法
方法 说明
all() 以列表形式返回查询的所有结果
first() 返回查询的第一个结果,如果未查到,返回None
firstor404() 返回查询的第一个结果,如果未查到,返回404
get() 返回指定主键对应的行,如不存在,返回None
getor404() 返回指定主键对应的行,如不存在,返回404
count() 返回查询结果的数量
paginate() 返回一个Paginate分页器对象,它包含指定范围内的结果
having 返回结果中符合条件的数据,必须跟在group by后面,其他地方无法使用。

get():参数为数字,表示根据主键查询数据,如果主键不存在返回None

Student.query.get()

# # 根据主键获取一条数据
# student = Student.query.get(4)
# print(student)

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

Student.query.all()

# # 返回所有结果数据数据
# student_list = Student.query.all()
# print(student_list)

count 返回结果的数量

# 返回结果的数量
ret = Student.query.filter(Student.id<5).count()
print(ret)

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

Student.query.first()

# # 返回第一个结果数据
# first_student = Student.query.filter(Student.id<5).first()
# print(first_student)

filter条件查询,支持各种运算符和查询方法或者模糊查询方法。

返回名字结尾字符为g的所有数据。

# 模糊查询
# 使用163邮箱的所有用户
student_list = Student.query.filter(Student.email.endswith("@163.com")).all()
print(student_list)

# 姓名以"zh"开头的
student_list = Student.query.filter(Student.name.startswith("zh")).all()
print(student_list)

# 名字中带有"a"字母的数据
student_list = Student.query.filter(Student.name.contains("a")).all()
print(student_list)

# 也可以使用filter进行精确查找,
# 则需要指定条件格式为: 模型.字段 比较运算符 值。
# 运算符可以是: ==表示相等,!=不相等,> 表示大于  < 表示小于,>=大于等于,<=小于等于

# 单条件比较
student_list = Student.query.filter(Student.age>18).all()
print(student_list)

# 多条件比较
# 要求多个条件都要满足
student_list = Student.query.filter(Student.age>18, Student.sex==True).all()
print(student_list)


# 另一种写法的查询方式
# db.session.query(Student) 相当于 Student.query
# ret = db.session.query(Student).filter(Student.age==22).all()

filter_by精确查询,只支持字段的值是否相等这种条件

例如:返回age等于22的学生

# 单条件
student_list = Student.query.filter_by(age=22).all()
print(student_list)

# 多条件
student_list = Student.query.filter_by(age=22,sex=True).all()
print(student_list)

练习

查询所有男生数据
# ret = Student.query.filter(Student.sex==True).all()
# ret = Student.query.filter_by(sex=True).all()

查询id为4的学生[3种方式]
# ret = Student.query.filter(Student.id==4).first()
# ret = Student.query.get(4)
# ret = Student.query.filter_by(id=4).first()

查询年龄等于22的所有学生数据
# ret = Student.query.filter_by(age=22).all()
# ret = Student.query.filter(Student.age==22).all()

查询name为liu的学生数据
# ret = Student.query.filter(Student.name == "liu").all()
# ret = Student.query.filter_by(name="liu").all()
8.3.4.3 多条件查询

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

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

not_ 相当于取反

from sqlalchemy import not_
Student.query.filter(not_(Student.name=='wang')).all()

# # 查询年龄不等于22
# student_list = Student.query.filter(Student.age != 22).all()
# print(student_list)
# student_list = Student.query.filter(not_(Student.age==22)).all()
# print(student_list)

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

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


# # and_(条件1,条件2,....)  等价于  filter(条件1,条件2,.....)
# # age > 18 and email like "%163.com"
# # student_list = Student.query.filter(Student.age > 18, Student.email.endswith("163.com")).all()
# 
# student_list = Student.query.filter(
#     and_(
#         Student.age > 18,
#         Student.email.endswith("163.com")
#     )
# ).all()

逻辑或,需要导入or_

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

# # 查询性别为True,或者年龄大于18
# sex = 1 or age > 18
# student_list = Student.query.filter(
#     or_(
#         Student.sex==True,
#         Student.age>18
#     )
# ).all()
# print(student_list)


# 复合条件的查询情况
# 查询18岁的女生或者22岁的男生
# (age=18 and sex=0) or (age = 22 and sex=1)
# student_list = Student.query.filter(
#     or_(
#         and_(Student.age==18, Student.sex==False),
#         and_(Student.age==22, Student.sex==True),
#     )
# ).all()

# print( student_list )

in_范围查询

"""查询id为2, 3, 5, 7, 8这几个学生信息"""
# 查询id是 1 3 5 的学生信息
student_list = Student.query.filter(Student.id.in_([1, 3, 5])).all()
print(student_list)

# 查询id不是 1 3 5 的学生信息
student_list = Student.query.filter(not_(Student.id.in_([1, 3, 5]))).all()
print( student_list )

order_by 排序

# 倒序[值从大到小]
student_list = Student.query.order_by(Student.id.desc()).all()
# 升序[值从小到大]
student_list = Student.query.order_by(Student.id.asc()).all()

# 多字段排序[第一个字段值一样时,比较第二个字段,进行排序]
student_list = Student.query.order_by(Student.age.desc(), Student.id.asc() ).all()
print(student_list)

count统计

# 查询age>=19的男生的数量
from sqlalchemy import and_
# ret = Student.query.filter( and_(Student.age>=19,Student.sex==True) ).count()
ret = Student.query.filter( Student.age>=19, Student.sex==True ).count()

对结果进行偏移量和数量的限制

# 查询年龄最大的3个学生
# student_list = Student.query.limit(2).all()
# print(student_list)

# 查询年龄排第4到第7名的学生
student_list = Student.query.offset(0).limit(2).all()
print(student_list)
student_list = Student.query.limit(2).offset(2).all()
print(student_list)

练习

# 查询age是18 或者 使用163邮箱的所有学生
Student.query.filter(or_(Student.age==18,Student.email.endswith("163.com"))).all()
# 查询id为 [1, 3, 5, 7, 9] 的学生列表
student_list = Student.query.filter(Student.id.in_([1, 3, 5, 7, 9])).all()
print(student_list)
8.3.4.4 分页器

run.py,代码:

from flask import Flask,render_template,request
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)

class Config(object):
    DEBUG = True
    # 数据库连接配置
    # SQLALCHEMY_DATABASE_URI = "数据库类型://数据库账号:密码@数据库地址:端口/数据库名称?charset=utf8mb4"
    SQLALCHEMY_DATABASE_URI = "mysql://root:123@127.0.0.1:3306/students?charset=utf8mb4"
    # 动态追踪修改设置,如未设置只会提示警告
    SQLALCHEMY_TRACK_MODIFICATIONS = True
    # 查询时会显示原始SQL语句
    SQLALCHEMY_ECHO = True

app.config.from_object(Config)


"""模型类定义"""
db = SQLAlchemy(app=app)
# 等同于
# db = SQLAlchemy()
# db.init_app(app)

class Student(db.Model):
    """学生信息模型"""
    # 声明与当前模型绑定的数据表名称
    __tablename__ = "db_students"
    # 字段定义
    """
    create table db_student(
      id int primary key auto_increment comment="主键",
      name varchar(15) comment="姓名",
    )
    """
    id = db.Column(db.Integer, primary_key=True,comment="主键")
    name = db.Column(db.String(15), comment="姓名")
    age = db.Column(db.SmallInteger, comment="年龄")
    sex = db.Column(db.Boolean, default=True, comment="性别")
    email = db.Column(db.String(128), unique=True, comment="邮箱地址")
    money = db.Column(db.Numeric(10,2), default=0.0, comment="钱包")

    def __repr__(self):
        return f"{self.name}<Student>"

    @classmethod
    def add(cls):
        student = cls(name="小明", sex=True, age=17, email="123456@qq.com", money=100)
        db.session.add(student)
        db.session.commit()
        return student

    @property
    def to_dict(self):
        """把对象转化成字典"""
        return {
            "id": self.id,
            "name": self.name,
            "age": self.age,
            "sex": self.sex,
            "email": self.email,
            "money": float("%.2f" % self.money),
        }

# 所有的模型必须直接或间接继承于db.Model
class Course(db.Model):
    """课程数据模型"""
    __tablename__ = "db_course"
    id = db.Column(db.Integer, primary_key=True, comment="主键")
    name = db.Column(db.String(64), unique=True, comment="课程")
    price = db.Column(db.Numeric(7, 2))
    # repr()方法类似于django的__str__,用于打印模型对象时显示的字符串信息
    def __repr__(self):
        return f'{self.name}<Course>'

class Teacher(db.Model):
    """老师数据模型"""
    __tablename__ = "db_teacher"
    id = db.Column(db.Integer, primary_key=True, comment="主键")
    name = db.Column(db.String(64), unique=True, comment="姓名")
    option = db.Column(db.Enum("讲师", "助教", "班主任"), default="讲师")

    def __repr__(self):
        return f"{self.name}< Teacher >"

@app.route("/")
def index():
    # 分页器
    page = int(request.args.get("page",1)) # 页码
    size = int(request.args.get("size",5)) # 每一页数据量
    pagination = Student.query.paginate(page=page,per_page=size)
    data = {}
    data["pagination"] = pagination
    return render_template("list.html",**data)


if __name__ == '__main__':
    with app.app_context():
        # 检测数据库中是否存在和模型匹配的数据表。
        # 如果没有,则根据模型转换的建表语句进行建表。
        # 如果找到,则不会进行额外处理

        db.create_all()
    app.run(debug=True)

list.html,代码:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
    <style>
    .page a,.page span{
        padding: 2px 6px;
        color: #fff;
        background: #6666ff;
        text-decoration: none;
    }
    .page span{
        color: #fff;
        background: orange;
    }

    </style>
</head>
<body>
    <table border="1" align="center" width="600">
        <tr>
           <th>ID</th>
           <th>age</th>
           <th>name</th>
           <th>sex</th>
           <th>money</th>
        </tr>
        {% for student in pagination.items %}
        <tr>
           <td>{{ student.id }}</td>
           <td>{{ student.age }}</td>
           <td>{{ student.name }}</td>
           <td>{{ "男" if student.sex else "女" }}</td>
           <td>{{ student.money }}</td>
        </tr>
        {% endfor %}
        <tr align="center">
            <td colspan="5" class="page">
                {% if pagination.has_prev %}
                <a href="?page=1">首  页</a>
                <a href="?page={{ pagination.page-1 }}">上一页</a>
                <a href="?page={{ pagination.page-1 }}">{{ pagination.page-1 }}</a>
                {% endif %}
                <span>{{ pagination.page }}</span>
                {% if pagination.has_next %}
                <a href="?page={{ pagination.page+1 }}">{{ pagination.page+1 }}</a>
                <a href="?page={{ pagination.page+1 }}">下一页</a>
                <a href="?page={{ pagination.pages }}">尾  页</a>
                {% endif %}
            </td>
        </tr>
    </table>
</body>
</html>

8.3.5 分组查询

分组查询和分组查询结果过滤

一般分组都会结合聚合函数来一起使用。SQLAlchemy中所有的聚合函数都在func模块中声明的。

from sqlalchemy import func

函数名 说明
func.count 统计总数
func.avg 平均值
func.min 最小值
func.max 最大值
func.sum

代码:

# 查询当前所有男生女生的数量
# ret = db.session.query(Student.sex,func.count(Student.id)).group_by(Student.sex).all()
# print(ret)

# 查看当前学生中各个年龄段的学生人数
# ret = db.session.query(Student.age, func.count(Student.id)).group_by(Student.age).all()
# print(ret)

# 查看当前男生女生的平均年龄
# ret = db.session.query(Student.sex, func.avg(Student.age)).group_by(Student.sex).all()
# ret = [{"sex":"男" if item[0] else "女","age":float(item[1])} for item in ret]
# print(ret)

# 分组后的过滤操作 having
# 在所有学生中,找出各个年龄中拥有最多钱的同学,并在这些同学里面筛选出money > 2000的数据
subquery = func.max(Student.money)
ret = db.session.query(Student.age, subquery).group_by(Student.age).having(subquery > 2000).all()
print(ret) # [(18, Decimal('1000.00')), (22, Decimal('26000.00')), (23, Decimal('1998.00'))]

SQL方法中的关键字顺序:

模型.query.   // db.session.query.
filter
group by
having
order_by
limit  offset
all / get / first

8.3.6 执行原生SQL语句

# # 查询多条数据
# ret = db.session.execute("select * from db_students").fetchall()
# # 查询一条数据
# ret = db.session.execute("select * from db_students").fetchone()
#
# # 添加/删除/更新
# db.session.execute("UPDATE db_students SET money=(db_students.money + %s) WHERE db_students.age = %s" % (200, 22))
# db.session.commit()

# db.session.execute("insert db_students (name,age,sex,email,money) select name,age,sex,concat(now(),email),money from db_students")
# db.session.commit()
return "ok"

8.4 关联查询

8.4.1 常用的SQLAlchemy关系选项

选项名 说明
backref 在关系的另一模型中添加反向引用,用于设置外键名称,在1查多的
primary join 明确指定两个模型之间使用的连表条件,用于1对1 或者1对多连表中
lazy 指定如何加载关联模型数据的方式。参数值:
select(立即加载,查询所有相关数据显示,相当于lazy=True)
subquery(立即加载,但使用子查询)
dynamic(不立即加载,但提供加载记录的查询对象)
uselist 如果为False,不使用列表,而使用标量值。
一对一关系中,需要设置relationship中的uselist=Flase,其他数据库操作一样。
secondary 指定多对多关系中关系表的名字。
多对多关系中,需建立关系表,设置 secondary=关系表
secondary join 在SQLAlchemy中无法自行决定时,指定多对多关系中的二级连表条件

三范式:逆范式

第三范式:数据不能冗余,把关联性不强的数据可以移除到另一个表中。使用外键进行管理。

1对1把主表的主键放到附加表中作为外键存在
1对多把主表(1) 的主键放到附加表()作为外键存在
多对多把主表()的主键和附加表的()主键放到第三方表(关系表)中作为外键

8.4.2 模型之间的关联

8.4.2.1 一对一
class Student(db.Model):
    """个人信息主表"""
    ....
    # 关联属性,这个不会被视作表字段,只是模型的属性。
    # 因为StudentInfo和Student是一对一的关系,所以uselist=False表示关联一个数据
    info = db.relationship("StudentInfo",uselist=False,backref="own")


class StudentInfo(db.Model):
    """个人信息附加表"""

    # 外键,
    # 如果是一对一,则外键放在附加表对应的模型中
    # 如果是一对多,则外键放在多的表对象的模型中
    uid = db.Column(db.Integer, db.ForeignKey(Student.id),comment="外键")
关联属性声明在主模型中【最常用】
from flask import Flask,render_template,request
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)

class Config(object):
    DEBUG = True
    # 数据库连接配置
    # SQLALCHEMY_DATABASE_URI = "数据库类型://数据库账号:密码@数据库地址:端口/数据库名称?charset=utf8mb4"
    SQLALCHEMY_DATABASE_URI = "mysql://root:123@127.0.0.1:3306/students?charset=utf8mb4"
    # 动态追踪修改设置,如未设置只会提示警告
    SQLALCHEMY_TRACK_MODIFICATIONS = True
    # 查询时会显示原始SQL语句
    SQLALCHEMY_ECHO = True

app.config.from_object(Config)


"""模型类定义"""
db = SQLAlchemy(app=app)
# 等同于
# db = SQLAlchemy()
# db.init_app(app)

class Student(db.Model):
    """学生信息模型"""
    # 声明与当前模型绑定的数据表名称
    __tablename__ = "db_students"
    # 字段定义
    """
    create table db_student(
      id int primary key auto_increment comment="主键",
      name varchar(15) comment="姓名",
    )
    """
    id = db.Column(db.Integer, primary_key=True,comment="主键")
    name = db.Column(db.String(15), comment="姓名")
    age = db.Column(db.SmallInteger, comment="年龄")
    sex = db.Column(db.Boolean, default=True, comment="性别")
    email = db.Column(db.String(128), comment="邮箱地址")
    money = db.Column(db.Numeric(10,2), default=0.0, comment="钱包")
    # 关联属性不是数据库的字段不会在数据表中出现,仅仅是SQLAlchemy为了方便开发者使用关联查询提供的对象属性
    # info 可以代表与当前数据对应的外键模型对象
    # 在主模型中声明关联属性
    info = db.relationship("StudentInfo", uselist=False,backref="student")

    def __repr__(self):
        return f"{self.name}<Student>"

    @classmethod
    def add(cls):
        student = cls(name="小明", sex=True, age=17, email="123456@qq.com", money=100)
        db.session.add(student)
        db.session.commit()
        return student

    @property
    def to_dict(self):
        """把对象转化成字典"""
        return {
            "id": self.id,
            "name": self.name,
            "age": self.age,
            "sex": self.sex,
            "email": self.email,
            "money": float("%.2f" % self.money),
        }

class StudentInfo(db.Model):
    """学生信息附加表"""
    __tablename__ = "db_student_info"
    id = db.Column(db.Integer, primary_key=True, comment="主键")
    address = db.Column(db.String(500), nullable=True, comment="地址")
    qq_num  = db.Column(db.String(15), nullable=True, comment="QQ号")
    # 外键设置[默认创建数据库物理外键]
    user_id = db.Column(db.ForeignKey("db_students.id"), comment="学生id")

@app.route("/")
def index():
    """添加数据"""
    # 添加主表信息的时候通过关联属性db.relationship同步添加附件表信息
    # student = Student(
    #     name="xiaolan02",
    #     age=16,
    #     sex=False,
    #     money=10000,
    #     email="xiaolan02@qq.com",
    #     info = StudentInfo(address="北京市昌平区百沙路204号", qq_num="100861000")
    # )
    # db.session.add(student)
    # db.session.commit()

    # 添加附加表数据,通过关联属性中db.relationshop的backref同步添加主表数据
    # info = StudentInfo(
    #     address="北京市昌平区百沙路204号",
    #     qq_num="100861220",
    #     student = Student(
    #         name="xiaolan02",
    #         age=16,
    #         sex=False,
    #         money=10000,
    #         email="xiaolan02@qq.com",
    #     )
    # )
    #
    # db.session.add(info)
    # db.session.commit()

    """查询数据"""
    # 正向关联----> 从主模型查询外键模型
    # student = Student.query.get(1)
    # print(student.info) # <StudentInfo 1>
    # print(student.info.address) # 北京市昌平区百沙路204号
    #
    # # 反向关联----> 从外键模型查询主模型
    # student_info = StudentInfo.query.filter(StudentInfo.qq_num=="100861220").first()
    # print(student_info.student) #    xiaolan02<Student>
    # print(student_info.student.name) #  xiaolan02
    # print(student_info.user_id) # 2     仅仅获取了外键真实数据

    """修改数据"""
    # 通过主表使用关联属性可以修改附加表的数据
    student = Student.query.get(2)
    student.info.address = "广州市天河区天河东路103号"
    db.session.commit()

    # 也可以通过附加表模型直接修改主表的数据
    student_info = StudentInfo.query.filter(StudentInfo.qq_num == "100861220").first()
    print(student_info.student)
    student_info.student.age = 22
    db.session.commit()

    return "ok"

if __name__ == '__main__':
    with app.app_context():
        # 检测数据库中是否存在和模型匹配的数据表。
        # 如果没有,则根据模型转换的建表语句进行建表。
        # 如果找到,则不会进行额外处理

        db.create_all()
    app.run(debug=True)
在外键模型中声明关联属性
from flask import Flask,render_template,request
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)

class Config(object):
    DEBUG = True
    # 数据库连接配置
    # SQLALCHEMY_DATABASE_URI = "数据库类型://数据库账号:密码@数据库地址:端口/数据库名称?charset=utf8mb4"
    SQLALCHEMY_DATABASE_URI = "mysql://root:123@127.0.0.1:3306/students?charset=utf8mb4"
    # 动态追踪修改设置,如未设置只会提示警告
    SQLALCHEMY_TRACK_MODIFICATIONS = True
    # 查询时会显示原始SQL语句
    SQLALCHEMY_ECHO = True

app.config.from_object(Config)


"""模型类定义"""
db = SQLAlchemy(app=app)
# 等同于
# db = SQLAlchemy()
# db.init_app(app)

class Student(db.Model):
    """学生信息模型"""
    # 声明与当前模型绑定的数据表名称
    __tablename__ = "db_students"
    # 字段定义
    """
    create table db_student(
      id int primary key auto_increment comment="主键",
      name varchar(15) comment="姓名",
    )
    """
    id = db.Column(db.Integer, primary_key=True,comment="主键")
    name = db.Column(db.String(15), comment="姓名")
    age = db.Column(db.SmallInteger, comment="年龄")
    sex = db.Column(db.Boolean, default=True, comment="性别")
    email = db.Column(db.String(128), comment="邮箱地址")
    money = db.Column(db.Numeric(10,2), default=0.0, comment="钱包")

    def __repr__(self):
        return f"{self.name}<Student>"

    @classmethod
    def add(cls):
        student = cls(name="小明", sex=True, age=17, email="123456@qq.com", money=100)
        db.session.add(student)
        db.session.commit()
        return student

    @property
    def to_dict(self):
        """把对象转化成字典"""
        return {
            "id": self.id,
            "name": self.name,
            "age": self.age,
            "sex": self.sex,
            "email": self.email,
            "money": float("%.2f" % self.money),
        }

from sqlalchemy.orm import backref
class StudentInfo(db.Model):
    """学生信息附加表"""
    __tablename__ = "db_student_info"
    id = db.Column(db.Integer, primary_key=True, comment="主键")
    address = db.Column(db.String(500), nullable=True, comment="地址")
    qq_num  = db.Column(db.String(15), nullable=True, comment="QQ号")
    # 外键设置[默认创建数据库物理外键]
    user_id = db.Column(db.ForeignKey("db_students.id"), comment="学生id")
    # 模型属性,不是数据库的字段,不会在数据表中出现,仅仅是SQLAlchemy为了方便开发者使用关联查询所提供的对象属性
    # info 可以代表与当前数据对应的外键模型对象
    student = db.relationship("Student", backref=backref("info",uselist=False))

@app.route("/")
def index():
    """查询数据"""
    # 正向关联----> 从主模型查询外键模型
    student_info = StudentInfo.query.filter(StudentInfo.qq_num=="100861220").first()
    print(student_info.student) #    xiaolan02<Student>
    print(student_info.student.name) #  xiaolan02
    print(student_info.user_id) # 2     仅仅获取了外键真实数据


    # 反向关联----> 从外键模型查询主模型
    student = Student.query.get(1)
    print(student.info) # <StudentInfo 1>
    print(student.info.address) # 北京市昌平区百沙路204号

    """修改数据"""
    # 通过主表使用关联属性可以修改附加表的数据
    # student = Student.query.get(2)
    # student.info.address = "广州市天河区天河东路103号"
    # db.session.commit()

    # 也可以通过附加表模型直接修改主表的数据
    # student_info = StudentInfo.query.filter(StudentInfo.qq_num == "100861220").first()
    # print(student_info.student)
    # student_info.student.age = 22
    # db.session.commit()

    return "ok"

if __name__ == '__main__':
    with app.app_context():
        # 检测数据库中是否存在和模型匹配的数据表。
        # 如果没有,则根据模型转换的建表语句进行建表。
        # 如果找到,则不会进行额外处理

        db.create_all()
    app.run(debug=True)
8.4.2.2 一对多
class Teacher(db.Model):
    ...
    # 关联属性,一的一方添加模型关联属性
    course = db.relationship("Course", uselist=True, backref="teacher",lazy='dynamic')

class Course(db.Model):
    ...
    # 外键,多的一方模型中添加外间
    teacher_id = db.Column(db.Integer, db.ForeignKey(Teacher.id))
  • 其中realtionship描述了Course和Teacher的关系。第一个参数为对应参照的类"Course"
  • 第二个参数backref为类Teacher申明新属性的方法
  • 第三个参数lazy决定了什么时候SQLALchemy从数据库中加载数据
  • lazy='subquery',查询当前数据模型时,采用子查询(subquery),把外键模型的属性也瞬间查询出来了。
  • lazy=True或lazy='select',查询当前数据模型时,不会把外键模型的数据查询出来,只有操作到外键关联属性时,才进行连表查询数据[执行SQL]
  • lazy='dynamic',查询当前数据模型时,不会把外键模型的数据查询出来,只有操作到外键关联属性并操作外键模型具体属性时,才进行连表查询数据[执行SQL]
  • 常用的lazy选项:dynamic和select

课堂代码:

models2.py,代码:

from flask import Flask,render_template,request
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)

class Config(object):
    DEBUG = True
    # 数据库连接配置
    # SQLALCHEMY_DATABASE_URI = "数据库类型://数据库账号:密码@数据库地址:端口/数据库名称?charset=utf8mb4"
    SQLALCHEMY_DATABASE_URI = "mysql://root:123@127.0.0.1:3306/students?charset=utf8mb4"
    # 动态追踪修改设置,如未设置只会提示警告
    SQLALCHEMY_TRACK_MODIFICATIONS = True
    # 查询时会显示原始SQL语句
    SQLALCHEMY_ECHO = True

app.config.from_object(Config)


"""模型类定义"""
db = SQLAlchemy(app=app)
# 等同于
# db = SQLAlchemy()
# db.init_app(app)

class Student(db.Model):
    """学生信息模型"""
    # 声明与当前模型绑定的数据表名称
    __tablename__ = "db_students"
    id = db.Column(db.Integer, primary_key=True,comment="主键")
    name = db.Column(db.String(15), comment="姓名")
    age = db.Column(db.SmallInteger, comment="年龄")
    sex = db.Column(db.Boolean, default=True, comment="性别")
    email = db.Column(db.String(128), comment="邮箱地址")
    money = db.Column(db.Numeric(10,2), default=0.0, comment="钱包")
    # 从Student        查询  StudentAddress:  Student.address_list = []
    # 从StudentAddress 查询  Student:         StudentAddress.student = 学生模型对象
    address_list = db.relationship("StudentAddress", uselist=True, backref="student",lazy="dynamic")

    def __repr__(self):
        return f"{self.name}<Student>"

from sqlalchemy.orm import backref
class StudentInfo(db.Model):
    """学生信息附加表"""
    __tablename__ = "db_student_info"
    id = db.Column(db.Integer, primary_key=True, comment="主键")
    address = db.Column(db.String(500), nullable=True, comment="默认地址")
    qq_num  = db.Column(db.String(15), nullable=True, comment="QQ号")
    # 外键设置[默认创建数据库物理外键]
    user_id = db.Column(db.ForeignKey("db_students.id"), comment="学生id")
    # 模型属性,不是数据库的字段,不会在数据表中出现,仅仅是SQLAlchemy为了方便开发者使用关联查询所提供的对象属性
    # info 可以代表与当前数据对应的外键模型对象
    student = db.relationship("Student", backref=backref("info",uselist=False))

class StudentAddress(db.Model):
    """学生收货地址"""
    __tablename__ = "db_student_address"
    id = db.Column(db.Integer, primary_key=True, comment="主键")
    user_id = db.Column(db.ForeignKey("db_students.id"), comment="学生id")
    province = db.Column(db.String(20), comment="省份")
    city = db.Column(db.String(20), comment="城市")
    area = db.Column(db.String(20), comment="地区")
    address = db.Column(db.String(250), comment="详细接地")
    # 也可以在外键模型中声明关系熟悉
    # student = db.relationship("Student", uselist=False, backref=backref("address_list",uselist=True))

    def __repr__(self):
        return f"{self.province}-{self.city}-{self.area}-{self.address}"

@app.route("/")
def index():
    """查询数据"""
    # 正向关联----> 从主模型查询外键模型
    student = Student.query.filter(Student.name=="xiaobai").first()
    print(student)
    # # 获取地址列表[调用关联属性,直接把外建模型对应数据直接查询查来]
    address_list = student.address_list[0].address
    return "ok"

"""
lazy="subquery"
1. 只查询:student,但是同时使用子查询语句进行链表操作,把外键模型数据也查询出来了

    SELECT db_students.id AS db_students_id, db_students.name AS db_students_name, db_students.age AS db_students_age, db_students.sex AS db_students_sex, db_students.email AS db_students_email, db_students.money AS db_students_money 
    FROM db_students

    SELECT db_student_address.id AS db_student_address_id, db_student_address.user_id AS db_student_address_user_id, db_student_address.province AS db_student_address_province, db_student_address.city AS db_student_address_city, db_student_address.area AS db_student_address_area, db_student_address.address AS db_student_address_address, anon_1.db_students_id AS anon_1_db_students_id 
    FROM (SELECT db_students.id AS db_students_id  FROM db_students  WHERE db_students.name = %s  LIMIT %s) AS anon_1 
    INNER JOIN db_student_address ON anon_1.db_students_id = db_student_address.user_id

lazy="select",
1. 只查询:student
    SELECT db_students.id AS db_students_id, db_students.name AS db_students_name, db_students.age AS db_students_age, db_students.sex AS db_students_sex, db_students.email AS db_students_email, db_students.money AS db_students_money 
    FROM db_students WHERE db_students.name = %s  LIMIT %s

2. 调用关联属性,直接连表查询
    SELECT db_students.id AS db_students_id, db_students.name AS db_students_name, db_students.age AS db_students_age, db_students.sex AS db_students_sex, db_students.email AS db_students_email, db_students.money AS db_students_money 
    FROM db_students WHERE db_students.name = %s  LIMIT %s

    SELECT db_student_address.id AS db_student_address_id, db_student_address.user_id AS db_student_address_user_id, db_student_address.province AS db_student_address_province, db_student_address.city AS db_student_address_city, db_student_address.area AS db_student_address_area, db_student_address.address AS db_student_address_address 
    FROM db_student_address WHERE %s = db_student_address.user_id

lazy="dynamic"
1. 只查询:student
   SELECT db_students.id AS db_students_id, db_students.name AS db_students_name, db_students.age AS db_students_age, db_students.sex AS db_students_sex, db_students.email AS db_students_email, db_students.money AS db_students_money 
    FROM db_students WHERE db_students.name = %s  LIMIT %s

2. 调用关联属性,不连表,直到代码真的调用了外键模型的具体字段才会查询数据库
    SELECT db_students.id AS db_students_id, db_students.name AS db_students_name, db_students.age AS db_students_age, db_students.sex AS db_students_sex, db_students.email AS db_students_email, db_students.money AS db_students_money 
    FROM db_students WHERE db_students.name = %s  LIMIT %s

"""

if __name__ == '__main__':
    with app.app_context():
        # 检测数据库中是否存在和模型匹配的数据表。
        # 如果没有,则根据模型转换的建表语句进行建表。
        # 如果找到,则不会进行额外处理

        db.create_all()
    app.run(debug=True)
8.4.2.3 多对多
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):
    ...
    student_list = db.relationship('Student',secondary=achievement,  
                                    backref='course_list',  
                                    lazy='dynamic')
class Student(db.Model):
    ...

多对多,也可以拆解成3个模型,其中tb_achievement作为单独模型存在。

8.4.2.3.1 基于第三方关系表构建多对多

代码:

from flask import Flask,render_template,request
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)

class Config(object):
    DEBUG = True
    # 数据库连接配置
    # SQLALCHEMY_DATABASE_URI = "数据库类型://数据库账号:密码@数据库地址:端口/数据库名称?charset=utf8mb4"
    SQLALCHEMY_DATABASE_URI = "mysql://root:123@127.0.0.1:3306/students?charset=utf8mb4"
    # 动态追踪修改设置,如未设置只会提示警告
    SQLALCHEMY_TRACK_MODIFICATIONS = True
    # 查询时会显示原始SQL语句
    SQLALCHEMY_ECHO = True

app.config.from_object(Config)


"""模型类定义"""
db = SQLAlchemy(app=app)

# 多对多关系表
achievement = db.Table(
    'db_achievement',
    db.Column('id', db.Integer, primary_key=True),
    db.Column('student_id', db.Integer, db.ForeignKey('db_students.id')),
    db.Column('course_id', db.Integer, db.ForeignKey('db_course.id')),
)

class Student(db.Model):
    """学生信息模型"""
    __tablename__ = "db_students"
    id = db.Column(db.Integer, primary_key=True,comment="主键")
    name = db.Column(db.String(15), comment="姓名")
    age = db.Column(db.SmallInteger, comment="年龄")
    sex = db.Column(db.Boolean, default=True, comment="性别")
    email = db.Column(db.String(128), comment="邮箱地址")
    money = db.Column(db.Numeric(10,2), default=0.0, comment="钱包")
    course_list = db.relationship("Course",secondary=achievement, backref="student_list", lazy="dynamic")

    def __repr__(self):
        return f"{self.name}<Student>"

class Course(db.Model):
    """课程数据模型"""
    __tablename__ = "db_course"
    id = db.Column(db.Integer, primary_key=True, comment="主键")
    name = db.Column(db.String(64), unique=True, comment="课程")
    price = db.Column(db.Numeric(7, 2))

    def __repr__(self):
        return f'{self.name}<Course>'

@app.route("/")
def index():
    """添加数据"""

    # student = Student(
    #     name="xiaozhao",
    #     age=13,
    #     sex=False,
    #     money=30000,
    #     email="100000@qq.com",
    #     course_list=[
    #         Course(name="python入门", price=99.99),
    #         Course(name="python初级", price=199.99),
    #         Course(name="python进阶", price=299.99),
    #     ]
    # )
    # db.session.add(student)
    # db.session.commit()

    # student = Student.query.get(4)
    # # student.course_list = [Course.query.get(2)]  #错误写法!!! 如果数据中已经存在了课程列表了,则不要重新赋值,会变成删除操作的
    # student.course_list.append(Course.query.get(3))
    # db.session.commit()

    """查询操作"""
    # student = Student.query.get(4)
    # course_list = [{"name":item.name,"price":float(item.price)} for item in student.course_list]

    # 查询出2号课程,都有谁在读?
    # course = Course.query.get(2)
    # student_list = [{"name":item.name,"money":float(item.money)} for item in course.student_list]
    # print(student_list)

    """更新数据"""
    # 给报读了3号课程的同学,返现红包200块钱
    course = Course.query.get(3)
    for student in course.student_list:
        student.money+=200

    db.session.commit()
    return "ok"

if __name__ == '__main__':
    with app.app_context():
        db.create_all()
    app.run(debug=True)
8.4.2.3.2 基于关系模型构建多对多

在SQLAlchemy中,基于db.Table创建的关系表,如果需要新增除了外键以外其他字段,无法操作。所以将来实现多对多的时候,除了上面db.Table方案以外,还可以把关系表声明成模型的方法,如果声明成模型,则原来课程和学生之间的多对多的关系,就会变成远程的1对多了。

代码:

from flask import Flask,render_template,request
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)

class Config(object):
    DEBUG = True
    # 数据库连接配置
    # SQLALCHEMY_DATABASE_URI = "数据库类型://数据库账号:密码@数据库地址:端口/数据库名称?charset=utf8mb4"
    SQLALCHEMY_DATABASE_URI = "mysql://root:123@127.0.0.1:3306/students?charset=utf8mb4"
    # 动态追踪修改设置,如未设置只会提示警告
    SQLALCHEMY_TRACK_MODIFICATIONS = True
    # 查询时会显示原始SQL语句
    SQLALCHEMY_ECHO = True

app.config.from_object(Config)


"""模型类定义"""
db = SQLAlchemy(app=app)

class Student(db.Model):
    """学生信息模型"""
    __tablename__ = "db_students"
    id = db.Column(db.Integer, primary_key=True,comment="主键")
    name = db.Column(db.String(15), comment="姓名")
    age = db.Column(db.SmallInteger, comment="年龄")
    sex = db.Column(db.Boolean, default=True, comment="性别")
    email = db.Column(db.String(128), comment="邮箱地址")
    money = db.Column(db.Numeric(10,2), default=0.0, comment="钱包")
    achievement_list = db.relationship("Achievement", uselist=True, backref="student")
    def __repr__(self):
        return f"{self.name}<Student>"

class Course(db.Model):
    """课程数据模型"""
    __tablename__ = "db_course"
    id = db.Column(db.Integer, primary_key=True, comment="主键")
    name = db.Column(db.String(64), unique=True, comment="课程")
    price = db.Column(db.Numeric(7, 2))
    achievement_list = db.relationship("Achievement", uselist=True, backref="course")
    def __repr__(self):
        return f'{self.name}<Course>'

from datetime import datetime
class Achievement(db.Model):
    __tablename__ = "db_achievement"
    id = db.Column(db.Integer, primary_key=True, comment="主键")
    student_id = db.Column(db.Integer, db.ForeignKey(Student.id))
    course_id  = db.Column(db.Integer, db.ForeignKey(Course.id))
    score = db.Column(db.Numeric(4,1), default=0, comment="成绩")
    time  = db.Column(db.DateTime, default=datetime.now, comment="考试时间")

@app.route("/")
def index():
    """添加数据"""
    # 记录xiaobai本次的python入门考试成绩: 88
    # achievement = Achievement(
    #     student= Student.query.filter(Student.name=="xiaobai").first(),
    #     course = Course.query.filter(Course.name=="python初级").first(),
    #     score  = 81
    # )
    # db.session.add(achievement)
    # db.session.commit()

    """查询操作"""
    # 查询xiaobai的成绩
    student = Student.query.filter(Student.name=="xiaobai").first()
    for achievement in student.achievement_list:
        print(f"课程:{achievement.course.name},成绩:{achievement.score}")

    return "ok"

if __name__ == '__main__':
    with app.app_context():
        db.create_all()
    app.run(debug=True)

relationship还有一个设置外键级联的属性:cascade="all, delete, delete-orphan"

8.4.2.4 逻辑外键

也叫虚拟外键。主要就是在开发中为了减少数据库的性能消耗,提升系统运行效率,一般项目不会使用数据库本身维护的物理外键,而是采用由ORM或者我们逻辑代码进行查询关联的逻辑外键。

模型.query.join("模型类","主模型.主键==外键模型.外键").join("模型类","主模型.主键==外键模型.外键").with_entities("字段1","字段2".label("字段别名")).all() 

代码:

from flask import Flask,render_template,request
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)

class Config(object):
    DEBUG = True
    # 数据库连接配置
    # SQLALCHEMY_DATABASE_URI = "数据库类型://数据库账号:密码@数据库地址:端口/数据库名称?charset=utf8mb4"
    SQLALCHEMY_DATABASE_URI = "mysql://root:123@127.0.0.1:3306/students?charset=utf8mb4"
    # 动态追踪修改设置,如未设置只会提示警告
    SQLALCHEMY_TRACK_MODIFICATIONS = True
    # 查询时会显示原始SQL语句
    SQLALCHEMY_ECHO = True

app.config.from_object(Config)


"""模型类定义"""
db = SQLAlchemy(app=app)

class Student(db.Model):
    """学生信息模型"""
    __tablename__ = "db_students"
    id = db.Column(db.Integer, primary_key=True,comment="主键")
    name = db.Column(db.String(15), comment="姓名")
    age = db.Column(db.SmallInteger, comment="年龄")
    sex = db.Column(db.Boolean, default=True, comment="性别")
    email = db.Column(db.String(128), comment="邮箱地址")
    money = db.Column(db.Numeric(10,2), default=0.0, comment="钱包")
    def __repr__(self):
        return f"{self.name}<Student>"

class Course(db.Model):
    """课程数据模型"""
    __tablename__ = "db_course"
    id = db.Column(db.Integer, primary_key=True, comment="主键")
    name = db.Column(db.String(64), unique=True, comment="课程")
    price = db.Column(db.Numeric(7, 2))
    def __repr__(self):
        return f'{self.name}<Course>'

from datetime import datetime
class Achievement(db.Model):
    __tablename__ = "db_achievement"
    id = db.Column(db.Integer, primary_key=True, comment="主键")
    student_id = db.Column(db.Integer, comment="学生ID")
    course_id  = db.Column(db.Integer, comment="课程ID")
    score = db.Column(db.Numeric(4,1), default=0, comment="成绩")
    time  = db.Column(db.DateTime, default=datetime.now, comment="考试时间")

@app.route("/")
def index():
    """添加数据"""
    # 记录xiaobai本次的python入门考试成绩: 88
    # achievement = Achievement(
    #     student_id = Student.query.filter(Student.name=="xiaobai").first().id,
    #     course_id  = Course.query.filter(Course.name=="python入门").first().id,
    #     score = 80,
    #     time = datetime.now(),
    # )
    # db.session.add(achievement)
    # db.session.commit()

    """查询操作"""
    # 查询xiaobai的成绩
    student = Student.query.join(
        Achievement,
        Achievement.student_id == Student.id
    ).join(
        Course,
        Course.id == Achievement.course_id
    ).filter(
        Student.name=="xiaobai",
        Achievement.score==88,
    ).with_entities(
        Student.name,
        Course.name.label("course"),
        Achievement.score.label("number")
    ).first()

    # 当连表查询返回一个结果的时候,可以通过keys查看当前模型提供的字段
    print(student) # 字段列表名
    print(type(student)) # 返回值是一个SQLAlchemy内部封装的模型对象
    print(student.keys()) # 字段列表
    print(f"{student.name}{student.course}成绩是:{student.number}")

    return "ok"

if __name__ == '__main__':
    with app.app_context():
        db.create_all()
    app.run(debug=True)

注意:django中也有虚拟外键的设置方案:在模型中设置db_constraint = False

8.5 数据库迁移

  • 在开发过程中,需要修改数据库模型,而且还要在修改之后更新数据库。最直接的方式就是删除旧表,但这样会丢失数据。
  • 更好的解决办法是使用数据库迁移框架,它可以追踪数据库模式的变化,然后把变动应用到数据库中。
  • 在Flask中可以使用Flask-Migrate扩展,来实现数据迁移。并且集成到Flask-Script中,所有操作通过命令就能完成。
  • 为了导出数据库迁移命令,Flask-Migrate提供了一个MigrateCommand类,可以附加到flask-script的manager对象上。

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

pip install flask-migrate

代码文件内容:

from flask import Flask
from config import Config
from flask_migrate import Migrate

app = Flask(__name__,template_folder='templates')
app.config.from_object(Config)
"""模型的创建"""
from flask_sqlalchemy import SQLAlchemy
db = SQLAlchemy(app)
#第一个参数是Flask的实例,第二个参数是Sqlalchemy数据库实例
migrate = Migrate(app,db)

# 多对多的关系
# 关系表的声明方式
achieve = 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):
    # 定义表名
    __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))
    teacher_id = db.Column(db.Integer, db.ForeignKey('tb_teacher.id'))
    students = db.relationship('Student', secondary=achieve, backref='courses', lazy='subquery')
    # 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,nullable=False)
    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)
    # 课程与老师之间的多对一关联
    courses = db.relationship('Course', backref='teacher', lazy='subquery')

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


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

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

8.5.1 创建迁移版本仓库

# 切换到项目根目录下
cd ~/Desktop/flaskdemo
# 设置flask项目的启动脚本位置
# 新版本的flask1.1,会在系统终端下提供一个类似django-admin的终端命令工具, 可以实现类似 flask_scipt 的功能
export FLASK_APP=manage.py
# flask run 启动flask项目
# 数据库迁移初始化,这个命令会在当前项目根目录下创建migrations文件夹,所有数据表相关的迁移文件都放在里面。
flask db init

8.5.2 创建迁移版本

  • 自动创建迁移版本有两个函数
  • upgrade():函数把迁移中的改动应用到数据库中。
  • downgrade():函数则将改动删除。
  • 自动创建的迁移脚本会根据模型定义和数据库当前状态的差异,生成upgrade()和downgrade()函数的内容。
  • 对比不一定完全正确,有可能会遗漏一些细节,需要进行检查
# 根据flask项目的模型生成迁移文件
flask db migrate -m 'initial migration'
# 这里等同于django里面的 makemigrations,生成迁移版本文件
# 完成2件事情:
# 1. 在migrations/versions生成一个数据库迁移文件
# 2. 如果是首次生成迁移文件的项目,则迁移工具还会在数据库创建一个记录数据库版本的version表

8.5.3 升级版本库的版本

# 从migations目录下的versions中根据迁移文件upgrade方法把数据表的结构同步到数据库中。
flask db upgrade

8.5.4 降级版本库的版本

# 从migations目录下的versions中根据迁移文件downgrade把数据表的结构同步到数据库中。
python main.py db downgrade

8.5.5 版本库的历史管理

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

python manage.py db history

输出格式:<base> ->  版本号 (head), initial migration

8.5.6 回滚到指定版本

flask db downgrade # 默认返回上一个版本
flask db downgrade 版本号   # 回滚到指定版本号对应的版本
flask db upgrade 版本号     # 升级到指定版本号对应的版本

数据迁移的步骤:

1. 初始化数据迁移的目录
export FLASK_APP=manage.py
flask db init

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

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

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

8.5.7 模块推荐

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

批量生成测试数据: https://github.com/joke2k/faker

pip install faker -i https://pypi.douban.com/simple

代码:

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)

class Config(object):
    DEBUG = True
    # 数据库连接配置
    # SQLALCHEMY_DATABASE_URI = "数据库类型://数据库账号:密码@数据库地址:端口/数据库名称?charset=utf8mb4"
    SQLALCHEMY_DATABASE_URI = "mysql://root:123@127.0.0.1:3306/students?charset=utf8mb4"
    # 动态追踪修改设置,如未设置只会提示警告
    SQLALCHEMY_TRACK_MODIFICATIONS = True
    # 查询时会显示原始SQL语句
    SQLALCHEMY_ECHO = True

app.config.from_object(Config)
db = SQLAlchemy(app=app)

class Student(db.Model):
    """学生信息模型"""
    __tablename__ = "db_students"
    id = db.Column(db.Integer, primary_key=True,comment="主键")
    name = db.Column(db.String(15), comment="姓名")
    age = db.Column(db.SmallInteger, comment="年龄")
    sex = db.Column(db.Boolean, default=True, comment="性别")
    email = db.Column(db.String(128), comment="邮箱地址")
    money = db.Column(db.Numeric(10,2), default=0.0, comment="钱包")

    def __repr__(self):
        return f"{self.name}<Student>"

from flask_script import Command,Manager,Option

manage = Manager()
manage.app = app

# 自定义批量生成学生
import random
from faker import Faker
class FakerStudentCommand(Command):
    """生成测试学生信息"""
    Name = "student"
    option_list = (
        Option("-n","--num",dest="num", type=int),
    )

    def run(self,num):
        faker = Faker(locale="ZH_CN")
        for i in range(num):
            sex = bool( random.randint(0,1) )
            student = Student(
                name= faker.name_male() if sex else faker.name_female(),
                age=random.randint(15,60),
                sex=sex,
                email=faker.free_email(),
                money= float( random.randint(100,100000) / 100 ),
            )
            db.session.add(student)
        # 在循环外面统一提交
        db.session.commit()

manage.add_command(FakerStudentCommand.Name, FakerStudentCommand)

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

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

9. flask-session

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

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

pip install flask-session

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

SECRET_KEY = "*(%#4sxcz(^(#$#8423" # session秘钥

9.1 SQLAlchemy存储session的基本配置

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

from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_session import Session
app = Flask(__name__)
db = SQLAlchemy()
session_store = Session(app)

class Config(object):
    DEBUG = True
    SECRET_KEY = "*(%#4sxcz(^(#$#8423"  # session秘钥
    # 数据库连接配置
    # SQLALCHEMY_DATABASE_URI = "数据库类型://数据库账号:密码@数据库地址:端口/数据库名称?charset=utf8mb4"
    SQLALCHEMY_DATABASE_URI = "mysql://root:123@127.0.0.1:3306/students?charset=utf8mb4"
    # 动态追踪修改设置,如未设置只会提示警告
    SQLALCHEMY_TRACK_MODIFICATIONS = True
    # 查询时会显示原始SQL语句
    SQLALCHEMY_ECHO = False
    # 把session通过SQLAlchmey保存到mysql中
    SESSION_TYPE = "sqlalchemy" # session类型为sqlalchemy
    SESSION_SQLALCHEMY = db     # SQLAlchemy对象
    SESSION_SQLALCHEMY_TABLE = 'db_session' # session要保存的表名称
    SESSION_PERMANENT = True    # 如果设置为True,则关闭浏览器session就失效
    SESSION_USE_SIGNER =  False  # 是否对发送到浏览器上session的cookie值进行加密
    SESSION_KEY_PREFIX = "session:" # sessionID的前缀,默认就是 session:

app.config.from_object(Config)
db.init_app(app)
session_store.init_app(app)

from flask import session
@app.route("/set")
def set_session():
    session["uname"] = "xiaoming"
    session["age"]   = 18
    return "ok"

@app.route("/get")
def get_session():
    print(session.get("uname"))
    print(session.get("age"))
    return "ok"

@app.route("/del")
def del_session():

    print(session.pop("uname"))
    print(session.pop("age"))
    return "ok"

if __name__ == '__main__':
    with app.app_context():
        db.create_all()
    app.run()

9.2 redis保存session的基本配置

这个功能必须确保,服务器必须已经安装了redis而且当前项目虚拟环境中已经安装了redis扩展库

pip install flask-redis -i https://pypi.douban.com/simple
# flask-redis是第三方开发者为了方便我们在flask框架中集成redis数据库操作所封装一个redis操作库、
# 在flask中要基于flask-redis进行数据库则可以完成以下3个步骤即可:
# 1. 引入flaskRedis并实例化
from flask.ext.redis import FlaskRedis
redis = FlaskRedis()
redis.init(app)
# 2. 在config配置中使用 REDIS_URL配置redis的url地址
REDIS_URL = "redis://:password@localhost:6379/0"

# 3. 使用实例化后的flaskRedis对象即可操作redis数据库,这个库就是我们之前在django中操作redis时使用库
# 直接通过 redis对象.命令方法(参数1, 参数2...)
redis.setex("sms",5 * 60 , "10010")

在redis中保存session,代码:

from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_session import Session
app = Flask(__name__)
db = SQLAlchemy()
session_store = Session(app)

from flask_redis import FlaskRedis
redis_session = FlaskRedis()
class Config(object):
    DEBUG = True
    SECRET_KEY = "*(%#4sxcz(^(#$#8423"  # session秘钥
    SQLALCHEMY_DATABASE_URI = "mysql://root:123@127.0.0.1:3306/students?charset=utf8mb4"
    SQLALCHEMY_TRACK_MODIFICATIONS = False
    SQLALCHEMY_ECHO = False
    # redis连接地址  redis://用户名:密码@IP地址:端口/数据库名
    REDIS_URL = "redis://:@127.0.0.1:6379/15"
    # 把session保存到redis
    SESSION_TYPE = "redis"     # session存储方式为redis
    SESSION_PERMANENT = False  # 如果设置session的生命周期是否是会话期, 为True,则关闭浏览器session就失效
    SESSION_USE_SIGNER = False # 是否对发送到浏览器上session的cookie值进行加密
    SESSION_KEY_PREFIX = "session:" # 保存到redis的session数的名称前缀
    # session保存数据到redis时启用的链接对象
    SESSION_REDIS = redis_session # 用于连接redis的配置

app.config.from_object(Config)
db.init_app(app)
session_store.init_app(app)
redis_session.init_app(app)


from flask import session
@app.route("/set")
def set_session():
    session["uname"] = "xiaoming"
    session["age"]   = 18
    return "ok"

@app.route("/get")
def get_session():
    print(session.get("uname"))
    print(session.get("age"))
    return "ok"

@app.route("/del")
def del_session():

    print(session.pop("uname"))
    print(session.pop("age"))
    return "ok"

if __name__ == '__main__':
    with app.app_context():
        db.create_all()
    app.run()

10. 蓝图 Blueprint

10.1 模块化

随着flask程序越来越复杂,我们需要对程序进行模块化的处理,之前学习过django的子应用管理,flask程序进行可以进行类似的模块化处理保存代码。

简单来说,Blueprint 是一个存储视图方法/模型代码的容器(目录),这些操作在这个Blueprint 被注册到flask的APP实例对象应用之后就可以被调用,Flask 可以通过Blueprint来组织URL以及处理客户端请求。

Flask使用Blueprint让应用实现模块化,在Flask中,Blueprint具有如下属性:

  • 一个项目可以具有多个Blueprint
  • 可以将一个Blueprint注册到任何一个未使用的URL下比如 “/”、“/sample”或者子域名,就是路由前缀
  • 在一个flask项目中,一个BluePrint模块可以注册多次
  • Blueprint可以单独具有自己的模板、静态文件或者其它的通用操作方法,它并不是必须要实现应用的视图和函数的
  • 在一个flask项目初始化时,就应该要注册需要使用的Blueprint

注意:flask中的Blueprint并不是一个完整的应用,它不能独立于应用运行,而必须要注册到某一个flask项目中。

在flask中,要使用蓝图Blueprint可以分为四个步骤:

  1. 手动创建一个蓝图的包目录,例如users,并在__init__.py文件中创建蓝图对象
users=Blueprint('users',__name__)
  1. 在这个users蓝图目录下, 创建views.py文件,保存当前蓝图使用的视图函数
# 光写视图,不用写路由
def index():
    return "ok, users.views.index"
  1. users/__init__.py中引入views.py中所有的视图函数并绑定路由
from flask import Blueprint
users = Blueprint("users",__name__)

from . import views
users.add_url_rule(rule="/index",view_func=views.index)
  1. 在主应用main.py文件中的app对象上注册这个users蓝图对象
from users import users
app.register_blueprint(users,url_prefix='/users')

当这个应用启动后,通过/users/可以访问到蓝图中定义的视图函数

10.2 蓝图运行机制

  • 蓝图Blueprint是保存了一组将来可以在flask应用对象上执行操作的路由关系.
  • 在视图上方调用 蓝图对象.route 装饰器注册路由时,这个操作本质就是将视图和url地址的映射关系添加到蓝图路由表的临时路由表中。
  • 蓝图对象根本没有路由表,当我们在蓝图中的视图函数上调用route装饰器(或者addurlrole)注册路由时,它只是在蓝图对象的内部的defered_functions(延迟操作记录列表)中添加了一个路由项(路由项实际上就是一个绑定了视图和url地址的匿名函数)
  • 在注册蓝图时,当执行app.registerblueprint() 时,应用对象app会将从蓝图对象的 deferedfunctions 列表中取出每一个路由项,并把app对象自己作为参数执行路由项对应的匿名函数,匿名函数执行以后就调用app.addurlrule() 方法,这将蓝图下之前暂存的路由信息全部添加到了app.url_map路由表中了。

10.3 蓝图的url前缀

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

1559209200346

  • 在应用最终的路由表 url_map中,在蓝图上注册的路由URL自动被加上了这个前缀,这个可以保证在多个蓝图中使用相同的子路由而不会最终引起冲突,只要在注册蓝图时将不同的蓝图挂接到不同的自路径即可
  • url_for在使用时,如果要生成一个蓝图里面的视图对应的路由地址,则需要声明当前蓝图名称+视图名称
url_for('users.home') # /users + /home   /users就是蓝图中的路由前缀  /home就是子路由

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

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

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

users/__init__.py,代码:

from flask import Blueprint
users = Blueprint("users",__name__,static_folder="static_users")
from .views import *
users.add_url_rule(rule="/index",view_func=index)

manage.py,代码:

from flask import Flask
import config
# 应用实例对象
app = Flask(__name__)
# app.config.from_pyfile("config.py")
app.config.from_object(config)

# 导入蓝图并注册到app实例对象中
from users import users
app.register_blueprint(users,url_prefix="/users") # register_blueprint 内部循环调用了users里面注册的路由.

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

现在就可以使用/users/staticusers/ 访问users/staticusers/目录下的静态文件了.

image-20210527220135980

当然,也可以修改访问静态文件的路径 :可以在创建蓝图对象时使用 staticurlpath 来改变静态目录的url地址。

from flask import Blueprint
users = Blueprint("users",__name__,static_folder="static_users",static_url_path="/st")

from .views import *
users.add_url_rule(rule="/index",view_func=index)

image-20210527220039230

10.5 设置蓝图中模版的目录

蓝图对象中因为视图最终随着路由会被app实例对象所加载,所以原来蓝图中设置的模板目录会被默认的app指定模板目录所覆盖。所以,如果使用了蓝图下的模板目录就不要和app指定的模板目录同名,否则同名的模板文件就会被覆盖了。

创建蓝图中的模板目录templates,users.__init__.py,代码:

from flask import Blueprint

users = Blueprint("users",__name__,template_folder="templates")

from . import views

users.add_url_rule("/index", view_func=views.index)

视图users.views,代码:

from flask import render_template
def index():
    data = {}
    data["title"] = "hello! users.index视图的数据"
    return render_template("index.html",**data)

模板代码,users/templates/index.html,代码:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <h1>users.template</h1>
    <p>{{ title }}</p>
</body>
</html>

image-20210528150049919

此时,访问效果:

image-20210528150103207

而此时如果在 项目的根目录下,也有一个templates 存在并也有一个index.html的同名模板文件时, 则系统会优先使用 根目录下的templates 中的模板文件。

templates/index.html,代码:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <h1>app.templates</h1>
</body>
</html>

效果如下:

image-20210528150324960

解决方案:如果使用了在蓝图下保存模板文件,则app应用实例对象初始化时的template_folder=None。

image-20210528150452652