Flask 框架基础

Flask 搭建

Flask 1.0 文档

依赖
当安装 Flask 时，以下配套软件会被自动安装。

• Werkzeug 用于实现 WSGI ，应用和服务之间的标准 Python 接口。
• Jinja 用于渲染页面的模板语言。
• MarkupSafe 与 Jinja 共用，在渲染页面时用于避免不可信的输入，防止注入攻击。
• ItsDangerous 保证数据完整性的安全标志数据，用于保护 Flask 的 session cookie.
• Click 是一个命令行应用的框架。用于提供 flask 命令，并允许添加自定义 管理命令。

可选依赖
以下配套软件不会被自动安装。如果安装了，那么 Flask 会检测到这些软件。

• Blinker 为 信号 提供支持。
• SimpleJSON 是一个快速的 JSON 实现，兼容 Python’s json 模块。如果安装 了这个软件，那么会优先使用这个软件来进行 JSON 操作。
• python-dotenv 当运行 flask 命令时为 通过 dotenv 设置环境变量 提供支持。
• Watchdog 为开发服务器提供快速高效的重载。

创建虚拟环境

创建一个项目文件夹，然后创建一个虚拟环境。

mkdir myproject
cd myproject
python -m venv venv

在开始工作前，先要激活相应的虚拟环境。

# Linux 下
. venv/bin/activate

# Windows下
venv\Scripts\activate

安装 Flask

python -m pip install Flask

在Windows平台命令行输入以上命令安装，可能会存在MarkupSafe依赖安装失败的问题，这主要是因为Windows命令行编码与Python中的不一致导致的问题。Windows命令行的默认编码是GBK，而Python3中默认编码是UTF-8，因此可以临时将Windows命令行切换为UTF-8编码

# 切换编码为utf-8
chcp 65001

#手动安装 markupsafe
python -m pip install markupsafe

# 安装完成后，请再次切回GBK。否则将导致以后使用cmd时出现各种奇怪的问题
# Windows系统的默认编码即GBK，请与系统保持一致。
chcp 936

如安装时缓慢或卡住，很可能是网络问题导致的，则建议使用国内源安装

# 使用清华大学的源
python -m pip install Flask -i https://pypi.tuna.tsinghua.edu.cn/simple

测试

1. 创建hello.py文件，输入如下内容

   from flask import Flask
   app = Flask(__name__)
   
   @app.route('/')
   def hello_world():
       return 'Hello, World!'
   

2. 导出 FLASK_APP 环境变量

   # Linux 下
   export FLASK_APP=hello.py
   flask run
   
   # Windows下
   set FLASK_APP=hello.py
   python -m flask run
   

3. 在浏览器输入以下地址，正常显示Hello, World!

   http://localhost:5000/
   

Flask 的基本使用

路由

应用实例需要知道对每个URL的请求要运行哪些对应的函数，所以保存了一个URL到Python函数之间的映射关系。用于处理URL和函数之间关系的程序称为路由

在 Flask 应用中定义路由的最简便方式是使用Flask实例提供的 app.route 装饰器。

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

使用装饰器并不是唯一的把index()函数注册为应用根URL的处理程序的方式。实际上不使用装饰器语法也是可以做到的，我们可以通过调用app.add_url_ rule() 方法实现。该方法最简单的形式是接受3个参数：URL、端点名、视图函数

def index():
    return 'Hello World!'

app.add_url_rule('/', 'index', index)

视图函数

像上面代码中的hello_world()、index() 这样处理客户端请求的函数被称为视图函数。在浏览器中访问相应的URL后，会触发服务器执行对应的视图函数。这个函数的返回值称为响应，也就是客户端浏览器接收到的内容。视图函数返回的响应可以是包含 HTML 的字符串，也可以是复杂表单。

当请求的URL中带有动态参数时，我们可以将视图函数与动态路由结合使用

@app.route('/greet/<name>')
def sayHello(name):
    return 'Hello, ' + name

增加以上代码后重新运行服务器，在浏览器输入：

http://localhost:5000/greet/Bob

则浏览器显示Hello, Bob

请求与响应

请求

Flask 从客户端收到请求时，将客户端发送的HTTP请求封装成了请求对象。想让视图函数能够访问请求对象，一种直截了当的方式是将其作为参数传入视图函数，不过这会导致应用中的每个视图函数都多出一个参数。为了避免大量可有可无的参数把视图函数弄得一团糟，Flask 使用上下文临时把某些对象变为全局可访问。

事实上它并不是真正的全局变量，在多线程服务器中，多个线程同时处理不同客户端发送的不同请求时，每个线程看到的请求对象必然不同。Flask 使用上下文让特定的变量在一个线程中全局可访问，与此同时却不会干扰其他线程。

示例代码

# 引入请求对象
from flask import request

@app.route('/')
def index():
    user_agent = request.headers.get('User-Agent')
    return 'Your browser is' + user_agent

请求对象包含客户端发送的 HTTP请求的全部信息

属性或方法	简述
form	一个字典，存储请求提交的所有表单字段
args	一个字典，存储通过 URL查询字符串传递的所有参数
values	一个字典，form 和args 的合集
cookies	一个字典，存储请求的所有 cookie
headers	一个字典，存储请求的所有 HTTP首部
files	一个字典，存储请求上传的所有文件
get_data()	返回请求主体缓冲的数据
get_json()	返回一个Python字典，包含解析请求主体后得到的 JSON
blueprint	处理请求的Flask 蓝本的名称
endpoint	处理请求的Flask端点的名称；Flask把视图函数的名称用作路由端点的名称
method	HTTP请求方法，例如 GET 或POST
scheme	URL方案（http 或https）
is_secure()	通过安全的连接（HTTPS）发送请求时返回 True
host	请求定义的主机名，如果客户端定义了端口号，还包括端口号
path	URL的路径部分
query_string	URL的查询字符串部分，返回原始二进制值
full_path	URL的路径和查询字符串部分
url	客户端请求的完整URL
base_url	同url，但没有查询字符串部分
remote_addr	客户端的IP地址
environ	请求的原始WSGI环境字典

响应

Flask 调用视图函数后，会将其返回值作为响应的内容。大多情况下，响应就是一个简单的字符串，作为HTML页面返回给客户端。但 HTTP 协议需要的不仅是作为请求响应的字符串。HTTP 响应中一个很重要的部分是状态码，Flask默认设为 200，表明请求已被成功处理。

Flask有两种方式返回响应，一种是简单的利用多返回值，如下例，第二个参数为状态码

@app.route('/')
def index():
    return '<h1>Bad Request</h1>', 400

视图函数还可以返回三个参数，第三个参数是一个由 HTTP 响应头组成的字典。

如果不想使用视图函数的多返回值的方式返回响应，还可以使用另一种方式返回响应，那就是创建一个响应对象，然后让视图函数返回这个响应对象。

from flask import make_response

@app.route('/')
def index():
    response = make_response('<h1>This document carries a cookie!</h1>')
    response.set_cookie('thiscookie', '666')
    return response

响应对象常用属性和方法

属性或方法	简述
status_code	HTTP数字状态码
headers	一个类似字典的对象，包含随响应发送的所有首部
set_cookie()	为响应添加一个cookie
delete_cookie()	删除一个cookie
content_length	响应主体的长度
content_type	响应主体的媒体类型
set_data()	使用字符串或字节值设定响应
get_data()	获取响应主体