Flask常用基础配置

发表于 更新于 分类于 ， ， Changyan： 本文字数： 3.2k 阅读时长 ≈ 12 分钟

Flask是一个使用 [Python]编写的轻量级 Web 应用框架。其 [WSGI]工具箱采用 Werkzeug ，[模板引擎]则使用 Jinja2 。Flask使用 BSD 授权。

Flask也被称为 “microframework” ，因为它使用简单的核心，用 extension 增加其他功能。Flask没有默认使用的数据库、窗体验证工具.

Response

Flask给我们提供的响应方式有三种：响应字符串、视图、重定向，除此之外还给我们提供了响应json格式、响应文件格式。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# 响应字符串
return 'hello world'

# 响应视图(可携带数据给视图)
from flask import render_template
return render_template{'index.html', name='张学友'}

# 重定向至指定url
from flask import redirect
redirect： return redirect('/index')

# 响应json，响应头里自动包含了Content-type:application/json
from flask import jsonify
return jsonify({"name":"张学友"})

# 响应文件内容，自动识别文件，响应头自动设置Content-type为该文件格式
from flask import send_file
return send_file(文件地址)

Request

Flask给我们提供的请求数据有如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
from flask import request
request.method # 请求方式
request.form # 存放FormData中的数据 to_dict 序列化成字典
request.args # 获取URL中的数据 to_dict 序列化成字典
request.url # 访问的完整路径
request.path # 路由地址
request.host # 主机地址
request.values # 获取 FormData and URL中的数据 不要用to_dict
request.json  # 如果提交时请求头中的Content-Type:application/json 字典操作
request.data  # 如果提交时请求头中的Content-Type 无法被识别 将请求体中的原始数据存放 byte
request.cookies # 获取Cookie中的数据
request.headers # 获取请求头
request.files # 序列化文件存储 save()

路由

endpoint

反向生成url地址标志、不设置该参数则默认为该函数视图名

methods

视图函数允许的请求方式

defaults

视图默认参数。如defaults={"id":99}

strict_slashes

是否严格遵循路由地址。如：strict_slashes=True

redirect_to

永久301重定向至目标链接。如redirect_to='/login'

动态路由参数

默认不填写类型代表字符串

1
2
3
4
5
6
7
8
9
10
11
@app_route("/index/<id>")
def index(id):
	pass
# 等同于
@app_route("/index/<string:id>")
def index(id):
	pass
# 可设置参数类型
@app_route("/index/<int:id>")
def index(id):
	pass

Flask实例化配置

这是针对一个已经实例化的app进行的配置

那么在Flask实例化的时候,传递的参数是什么鬼呢?

其实可以理解为对Flask实例进行的初始配置,这里面的参数是非常好理解,注意关键字是非常非常非常好理解

1
2
3
4
5
6
7
8
9
10
11
12
static_folder = 'static',  # 静态文件目录的路径 默认当前项目中的static目录
static_host = None,  # 指定远程静态文件所用的Host地址,默认为空
static_url_path = None,  # 静态文件目录的url路径 默认不写是与static_folder同名,远程静态文件时复用
# host_matching是否开启host主机位匹配,是要与static_host一起使用,如果配置了static_host, 则必须赋值为True
# 这里要说明一下,@app.route("/",host="localhost:5000") 就必须要这样写
# host="localhost:5000" 如果主机头不是 localhost:5000 则无法通过当前的路由
host_matching = False,  # 如果不是特别需要的话,慎用,否则所有的route 都需要host=""的参数
subdomain_matching = False,  # 理论上来说是用来限制SERVER_NAME子域名的,但是目前还没有感觉出来区别在哪里
template_folder = 'templates'  # template模板目录, 默认当前项目中的 templates 目录
instance_path = None,  # 指向另一个Flask实例的路径
instance_relative_config = False  # 是否加载另一个实例的配置
root_path = None  # 主模块所在的目录的绝对路径,默认项目目录

如：

1
2
# 设置模板目录为temp， 静态文件目录为static
app = Flask(__name__， template_folder=‘temp’, static_folder = 'static')

Flask对象配置

应用会需要某种配置。你可能会需要根据应用环境更改不同的设置，比如切换调试模式、设置密钥、或是别的设定环境的东西。

Flask 被设计为需要配置来启动应用。你可以在代码中硬编码配置，这对于小的应用并不坏，但是有更好的方法。

跟你如何载入配置无关，会有一个可用的配置对象保存着载入的配置值: Flask对象的 config属性。这是 Flask 自己放置特定配置值的地方，也是扩展可以存储配置值的地方。但是，你也可以把自己的配置保存到这个对象里。

flask对象配置项有如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
'DEBUG': False,  # 是否开启Debug模式
    'TESTING': False,  # 是否开启测试模式
    'PROPAGATE_EXCEPTIONS': None,  # 异常传播(是否在控制台打印LOG) 当Debug或者testing开启后,自动为True
    'PRESERVE_CONTEXT_ON_EXCEPTION': None,  # 一两句话说不清楚,一般不用它
    'SECRET_KEY': None,  # 之前遇到过,在启用Session的时候,一定要有它
    'PERMANENT_SESSION_LIFETIME': 31,  # days , Session的生命周期(天)默认31天
    'USE_X_SENDFILE': False,  # 是否弃用 x_sendfile
    'LOGGER_NAME': None,  # 日志记录器的名称
    'LOGGER_HANDLER_POLICY': 'always',
    'SERVER_NAME': None,  # 服务访问域名
    'APPLICATION_ROOT': None,  # 项目的完整路径
    'SESSION_COOKIE_NAME': 'session',  # 在cookies中存放session加密字符串的名字
    'SESSION_COOKIE_DOMAIN': None,  # 在哪个域名下会产生session记录在cookies中
    'SESSION_COOKIE_PATH': None,  # cookies的路径
    'SESSION_COOKIE_HTTPONLY': True,  # 控制 cookie 是否应被设置 httponly 的标志，
    'SESSION_COOKIE_SECURE': False,  # 控制 cookie 是否应被设置安全标志
    'SESSION_REFRESH_EACH_REQUEST': True,  # 这个标志控制永久会话如何刷新
    'MAX_CONTENT_LENGTH': None,  # 如果设置为字节数， Flask 会拒绝内容长度大于此值的请求进入，并返回一个 413 状态码
    'SEND_FILE_MAX_AGE_DEFAULT': 12,  # hours 默认缓存控制的最大期限
    'TRAP_BAD_REQUEST_ERRORS': False,
    # 如果这个值被设置为 True ，Flask不会执行 HTTP 异常的错误处理，而是像对待其它异常一样，
    # 通过异常栈让它冒泡地抛出。这对于需要找出 HTTP 异常源头的可怕调试情形是有用的。
    'TRAP_HTTP_EXCEPTIONS': False,
    # Werkzeug 处理请求中的特定数据的内部数据结构会抛出同样也是“错误的请求”异常的特殊的 key errors 。
    # 同样地，为了保持一致，许多操作可以显式地抛出 BadRequest 异常。
    # 因为在调试中，你希望准确地找出异常的原因，这个设置用于在这些情形下调试。
    # 如果这个值被设置为 True ，你只会得到常规的回溯。
    'EXPLAIN_TEMPLATE_LOADING': False,
    'PREFERRED_URL_SCHEME': 'http',  # 生成URL的时候如果没有可用的 URL 模式话将使用这个值
    'JSON_AS_ASCII': True,
    # 默认情况下 Flask 使用 ascii 编码来序列化对象。如果这个值被设置为 False ，
    # Flask不会将其编码为 ASCII，并且按原样输出，返回它的 unicode 字符串。
    # 比如 jsonfiy 会自动地采用 utf-8 来编码它然后才进行传输。
    'JSON_SORT_KEYS': True,
    #默认情况下 Flask 按照 JSON 对象的键的顺序来序来序列化它。
    # 这样做是为了确保键的顺序不会受到字典的哈希种子的影响，从而返回的值每次都是一致的，不会造成无用的额外 HTTP 缓存。
    # 你可以通过修改这个配置的值来覆盖默认的操作。但这是不被推荐的做法因为这个默认的行为可能会给你在性能的代价上带来改善。
    'JSONIFY_PRETTYPRINT_REGULAR': True,
    'JSONIFY_MIMETYPE': 'application/json',
    'TEMPLATES_AUTO_RELOAD': None,

以上配置项使用方式有三种：

对象->属性

1
2
3
app = Flask(__name__)
app.secret_key = '123456'
app.debug = True

对象->config[属性]

1
2
3
app = Flask(__name__)
app.config['SECRET_KEY'] = '123456'
app.config['DEBUG'] = True

使用类的方式导入

环境准备

根目录创建一个flask_setting.py文件

写入代码

1
2
3
4
5
6
7
8
9
class FlaskDebug:
    DEBUG = True
    SECRET_KEY = "Debug_secret_key"
    SESSION_COOKIE_NAME = 'Debug_session'

class FlaskTesting:
    DEBUG = True
    SECRET_KEY = "Testing_secret_key"
    SESSION_COOKIE_NAME = 'Testing_session'

主页面使用改配置

1
2
3
4
5
import flask_setting
app = Flask(__name__)
# 使用debug模式配置文件
app.config.from_object(flask_setting.FlaskDebug)
# app.config.from_object(flask_setting.FlaskTesting)

消息闪现flash

Flask 提供了消息闪现系统，可以简单地给用户反馈。 消息闪现系统通常会在请求结束时记录信息，并在下一个（且仅在下一个）请求中访问记录的信息。展现这些消息通常结合要模板布局。

flash基于session、cookie，所以必须开启SECRET_KEY，读取一次(部分或全部)，全部删除

示例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
from flask import Flask, request, flash, get_flashed_messages
app = Flask(__name__)
app.debug = True
app.secret_key = '123456'
@app.route('/flash1')
# 写入flash
def flash1():
    flash('刘德华', 'hk')
    flash('张学友', 'hk')
    flash('周杰伦', 'tw')
    flash('车易迅', 'tw')
    flash('天安门', 'bj')
    flash('店门', 'bj')
    return '我是flash1'
    
# 读取flash，过滤读取category为hk和bj的数据
@app.route('/flash2')
def flash2():
    print(get_flashed_messages(category_filter=['hk', 'bj']))
    return '我是flash2'

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

蓝图

Flask 用 蓝图（blueprints） 的概念来在一个应用中或跨应用制作应用组件和支持通用的模式。蓝图很好地简化了大型应用工作的方式，并提供给 Flask 扩展在应用上注册操作的核心方法。一个 Blueprint 对象与 Flask 应用对象的工作方式很像，但它确实不是一个应用，而是一个描述如何构建或扩展应用的 蓝图 。

应用场景

  • 把一个应用分解为一个蓝图的集合。这对大型应用是理想的。一个项目可以实例化一个应用对象，初始化几个扩展，并注册一集合的蓝图。
  • 以 URL 前缀和/或子域名，在应用上注册一个蓝图。 URL 前缀/子域名中的参数即成为这个蓝图下的所有视图函数的共同的视图参数（默认情况下）。
  • 在一个应用中用不同的 URL 规则多次注册一个蓝图。
  • 通过蓝图提供模板过滤器、静态文件、模板和其它功能。一个蓝图不一定要实现应用或者视图函数。
  • 初始化一个 Flask 扩展时，在这些情况中注册一个蓝图。

示例

环境准备

1
2
3
4
5
6
目录结构
app.py
users
	|- view.py
	|- temp
		|- index.html

文件代码

users/view.py
1
2
3
4
5
6
7
8
from flask import Blueprint, render_template
# 注册一个蓝图，默认html模板目录为temp
user = Blueprint('user', __name__, template_folder='temp')

# index视图函数
@user.route('/index')
def index():
    return render_template('index.html')
user/temp/index.html
1
2
3
4
5
6
7
8
9
10
11
12
<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Title</title>
</head>
<body>
<h1>我是user蓝图中的index视图函数</h1>
</body>
</html>
app.py
1
2
3
4
5
6
7
8
from flask import Flask
from users.view import user
app = Flask(__name__)
app.debug = True
# 注册蓝图，且蓝图url前缀为'/user'
app.register_blueprint(user, url_prefix='/user')
if __name__ == '__main__':
    app.run()

预览

访问127.0.0.1:5000/user/index

特殊装饰器

类似于Django的中间件

@app.before_request

请求进入视图之前，返回None或不用return继续向下执行

@app.after_request

响应返回给客户端之前，含参，该参数即Response对象，响应前可修改响应体或响应头

如：b1/b2/b3三个请求前方法， a1/a2/a3三个请求后方法，正常请求流程为：b1->b2->b3->a3->a2->a1，

异常情况，如b1执行被返回了：b1->a3->a2->a1

@app.errorhandler()

装饰器含参，参数为请求代码：404,201等等，视图也包含参数，参数为默认的str消息

AssertionError

日常开发中很多路由需要验证用户是否登录，python让我们很方便的利用装饰器实现这种场景。

例子：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
from flask import Flask, redirect, render_template, jsonify, send_file, request, session
app = Flask(__name__)
app.secret_key = '123456'

# 装饰器，验证用户是否已登录
def checkLogin(func):
    def res(*args, **kwargs):
        if not session.get('uname'):
            print('您当前未登录')
            return redirect('/login')
        return func(*args, **kwargs)
    return res

# 首页
@app.route('/')
@checkLogin
def index():
    return '这里是首页'

# 用户页面
@app.route('/users')
@checkLogin
def users():
    return '这里是用户页面'
    
# 登录页面
@app.route('/login', methods=['GET', 'POST'])
def login():
    if request.method == 'GET':
        return render_template('login.html')
    if request.form.get('uname')=='admin' and request.form.get('pwd') == 'admin888':
        session['uname'] = request.form.get('uname')
        return redirect('/')

我们运行该段代码直接报错：

1
AssertionError: View function mapping is overwriting an existing endpoint function: res

原因是我们写的验证器最后返回的函数是res，首页路由返回的函数为res，用户路由返回的也是res，重名导致出现该错误，这就如同我们写了两个同名的index路由，解决该问题有两种方法。

导入functools包

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
from flask import Flask, redirect, render_template, jsonify, send_file, request, session
import functools
app = Flask(__name__)
app.secret_key = '123456'

# 装饰器，验证用户是否已登录
def checkLogin(func):
    @functools.wraps(func)
    def res(*args, **kwargs):
        if not session.get('uname'):
            print('您当前未登录')
            return redirect('/login')
        return func(*args, **kwargs)
    return res

# 首页
@app.route('/')
@checkLogin
def index():
    return '这里是首页'

# 用户页面
@app.route('/users')
@checkLogin
def users():
    return 'z这里是用户页面'
# 登录页面
@app.route('/login', methods=['GET', 'POST'])
def login():
    if request.method == 'GET':
        return render_template('login.html')
    if request.form.get('uname')=='admin' and request.form.get('pwd') == 'admin888':
        session['uname'] = request.form.get('uname')
        return redirect('/')

此时就会返回原始函数名，不会出现该问题。

flask自带的endport

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
from flask import Flask, redirect, render_template, jsonify, send_file, request, session
app = Flask(__name__)
app.secret_key = '123456'

# 装饰器，验证用户是否已登录
def checkLogin(func):
    def res(*args, **kwargs):
        if not session.get('uname'):
            print('您当前未登录')
            return redirect('/login')
        return func(*args, **kwargs)
    return res

# 首页
@app.route('/', endpoint='index')
@checkLogin
def index():
    return '这里是首页'

# 用户页面
@app.route('/users', endpoint='users')
@checkLogin
def users():
    return 'z这里是用户页面'
# 登录页面
@app.route('/login', methods=['GET', 'POST'])
def login():
    if request.method == 'GET':
        return render_template('login.html')
    if request.form.get('uname')=='admin' and request.form.get('pwd') == 'admin888':
        session['uname'] = request.form.get('uname')
        return redirect('/')