Flask Web学习笔记 - 第2章程序的基本结构

2.1 初始化

所有Flask程序都必须创建一个程序实例，该程序实例是Flask类的对象。

Web服务器使用一种名为Web服务器网关接口（Web Server Gateway Interface, WSGI）的协议，把来自客户端的所有请求都转交给这个对象实例处理。该对象实例可以通过以下代码创建：

from flask import Flask
app = Flask(__name__)

Flask类的构造函数只有一个必须指定的参数，即程序的主模块或包的名字。在大多数程序中，Python的__name__变量就是所需的值。

2.2 路由和视图函数

客户端（例如Web浏览器）把请求发送给Web服务器，Web服务器再把请求发送给Flask程序实例。

程序实例保存了一个URL到Python函数的映射关系，处理URL和函数之间关系的程序称为路由。

在Flask程序中定义路由的最简单方式，就是使用程序实例提供的app.route修饰器，把修饰的函数注册为路由。下面的例子可以简单地说明如何使用这个修饰器声明路由：

@app.route(‘/’)
def hello_world():
	return ‘<h1>Hello World!</h1>’

修饰器是Python语言的标准特性，可以使用不同的方式修改函数的行为。惯常用法是使用修饰器把函数注册为事件的处理程序。

像hello_world()这样的函数称为视图函数。视图函数返回的响应可以是包含HTML的简单字符，也可以是复杂的表单。值得注意的是，在Python代码中嵌入响应字符串会导致代码难以维护。

某些URL格式都包含可变部分，Flask支持这种形式的URL，只需在修饰器中使用特殊的句法即可。下例定义的路由中就有一部分是动态名字：

@app.route(‘/user/name’)
def user(name):
	return ‘<h1>Hello, %s!</h1>’ %name

调用视图函数时，Flask会将任何能匹配静态部分的URL映射到这个路由上，而动态部分作为参数传入函数。

路由中的动态部分默认使用字符串，也可以使用类型定义。例如，路由/user/<int: id>只会匹配动态片段id为整数的URL，可以使用以下代码表示：

@app.route(/blog/<int: postID>)
def show_blog(postID):
	return ‘Blog Number %d’ %postID

Flask支持在路由中使用int, float和path类型，path类型也是字符串，但不把斜线视作分隔符，而将其当作动态片段的一部分。

值得注意的是，路由和视图函数一般在一起使用。

2.3 启动服务器

程序实例用run()方法启动FLask集成的开发Web服务器：

If __name__ = ‘__main__’:
	app.run(debug = True)

在这里直接执行这个脚本时才启动开发Web服务器，name = ‘main’是Python的惯常用法。

服务器启动后，会进入轮询，等待并处理请求，轮询会一直运行，直到程序停止，例如按Ctrl+C。

需要注意的是，Flask提供的开发Web服务器不适合在生产环境中使用。

2.4 一个完整的程序

要想运行这个程序，请确保激活了之前创建的虚拟环境，然后使用下述命令启动程序：

$ source venv/bin/activate

(venv) $ python FlaskWeb/app/main/__init__.py

现在打开Web浏览器，在地址栏中输入http://127.0.0.1:5000

完整程序如下图可视：

在这里插入图片描述

2.5 请求-响应循环

2.5.1 程序和请求上下文

Flask中有两种上下文：程序上下文和请求上下文。以下表格列出了这两种上下文全局变量：

在这里插入图片描述 Flask从客户端收到请求时，要想让视图函数能够访问请求对象，一个显而易见的方式是将其作为参数传入视图函数。

但是这会导致程序中的每个视图函数都增加了一个参数。除了访问请求对象，如果视图函数在处理请求时还要访问其他对象，情况会变得更糟糕。
为了避免把视图函数弄得一团遭，Flask使用请求上下文临时把请求对象变为全局可访问，例如以下代码例子：

from flask import request

@app.route(‘/’)
def index():
	user_agent = request.header.get(‘User-Agent’)
	return ‘<p>Your browser is %s</p>’ %user_agent

这个视图函数把request当作全局变量使用。事实上，request不可能是全局变量，Flask使用上下文让特定的变量在一个线程中全局可访问，与此同时却不会干扰其它线程。

注意，在多线程服务器中，多个线程处理不同客户端发送的不同请求时，每个线程看到的request对象必然不同。

Flask在分发请求之前激活/推送程序和请求上下文，请求处理完成后再将其删除。

程序上下文被推送后，就可以使用current_app和g变量；请求上下文被推送后，就可以使用request和session变量。

2.5.2 请求调度

程序收到客户端发来的请求时，Flask会在程序的URL映射中查找请求的URL。URL映射是URL和视图函数之间的对应关系。Flask使用app.route修饰器生成映射。

查看Flask程序中的URL映射是什么样子，可以在程序中使用以下代码实现：

If __name__ = ‘__main__’:
	print (app.url_map)
	app.run()

Map([<Rule '/static/<filename>' (OPTIONS, GET, HEAD) -> static>,
 <Rule '/hello' (OPTIONS, GET, HEAD) -> hello_world>,
 <Rule '/hello/<name>' (OPTIONS, GET, HEAD) -> hello_name>,
 <Rule '/blog/<postID>' (OPTIONS, GET, HEAD) -> show_blog>,
 <Rule '/' (OPTIONS, GET, HEAD) -> index>])

/，/hello，/hello/，/blog/int:postID路由是在程序中使用app.route修饰器定义。/static/路由是Flask添加的特殊路由，用于访问静态文件。

URL映射中的HEAD, OPTIONS, GET是请求方法，由路由进行处理。Flask为每个路由都指定了请求方法，这样不同的请求方法发送到相同的URL上时，会使用不同的视图函数进行处理。HEAD和OPTIONS方法由Flask自动处理。

2.5.3 请求钩子

有时候，在请求开始时，我们可能需要创建数据库连接或者认证发起请求的用户。在处理请求之前或者之后的执行代码的过程中，为了避免在每个视图函数中都使用重复的代码，Flask提供了注册通用函数的功能，注册的函数可在请求被分发到视图函数之前或者之后调用。

请求钩子使用修饰器实现，Flask支持以下4种钩子：
· before_first_request: 注册一个函数，在处理第一个请求之前运行。
· before_request: 注册一个函数，在每次请求之前运行。
· after_request: 注册一个函数，如果没有未处理的异常抛出，在每次请求之后运行。
· teardown_request: 注册一个函数，即使没有未处理的异常抛出，也在每次请求之后运行。

在处理钩子函数和视图函数之间共享数据一般使用程序上下文全局变量current_app或者g。

值得注意的是，视图函数不仅可以与路由一起使用，而且也可以与请求钩子一起使用。

2.5.4 响应

Flask调用视图函数后，会将其返回值作为响应的内容。

· 大多数情况下，响应就是一个简单的字符串。但HTTP协议不仅需要请求响应的字符串，其中一个很重要的部分是状态码，Flask默认为200，它代表请求已被成功处理。

· 如果视图函数返回的响应需要使用不同的状态码，那么可以把状态码作为第二个返回值，添加到响应文本之后。

例如，下面的例子代码可以表示为：

@app.route(‘/page_not_found’)
def page_not_found():
	return ‘Page Not Found’, 400

Flask视图函数还可以返回Response对象，make_response()函数可以接受1、2或3个参数，并返回一个Response对象。