Flask Web开发 2.0 程序的基本结构

2.1 初始化

所有Flask程序都必须创建一个程序实例。Web服务器使用一种名为Web服务器网关结构(WSGI)的协议，把接收自客户端的所有请求都转发给这个对象处理。程序实例是Flask类的对象，经常使用下述代码创建：

from flask import Flask
app = Flask(__name__)

Flask类的构造函数只有一个必须指定的参数，即程序主模块或包的名字。在大多数程序中Python中的__name__变量值就是所需的值。Flask用这个参数决定程序的根目录，以便稍后能够找到相对于程序根目录的资源文件位置。 

后面会介绍更复杂的程序初始化方式，对于简单的程序来说，上面的代码就够了。

2.2 路由和视图函数

客户端（例如Web浏览器）把请求发送给Web服务器，Web服务器再把请求发给Flask程序实例。程序实例需要知道对每个URL请求运行哪些代码，所以保存了一个URL到Python函数的映射关系。处理URL和函数映射关系的程序成为路由。

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

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

修饰器是Python语言的标准特性，可以使用不同的方式修改函数的行为。惯常用法是使用修饰器把函数注册为事件的处理程序。
上面的例子把index()函数注册为程序根地址的处理程序。如果部署的服务器域名为www.example.com，在浏览器中访问http://www.example.com后，会触发服务器执行index()函数。 这个函数的返回值称为响应，是客户端接收到的内容。如果客户端是Web浏览器，那么响应就是显示给用户查看的文档。

像index()这样的函数称为视图函数。视图函数返回的响应可以是包含HTML的简单字符串，也可以是复杂的表单，后文会介绍。

注意：在Python代码中嵌入这样的响应字符串会导致代码难以维护，此处这么做只是为了介绍响应的概念，正确的生成方法会在第三章介绍。

我们知道很多地址都包含可变部分，例如facebook的资料页面的地址是http://www.facebook.com/<name>，用户名name是地址的一部分。Flask支持这种形式的URL，只需在route修饰器中使用特殊的句法即可，如

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

尖括号中的内容就是动态部分，任何能匹配静态部分的URL都会映射到这个路由上。调用视图函数时，Flask会将动态部分作为参数（此处就是name）传入函数。路由中的动态部分默认使用字符串，不过也可以使用类型定义。例如路由/user/<int:id>只会匹配动态片段id为整数的URL。Flask支持在路由中使用int、float和path类型。path类型也是字符串，但不把斜线视作分隔符，而将其作为动态片段的一部分。

2.3 启动服务器

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

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

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

有一些参数可以被app.run()函数接收用于设置Web服务器的操作模式。在开发过程中启用调试模式会带来一些便利，比如激活调试器和重载程序。要想激活调试模式，可以把debug参数设置为True .Flask提供的Web服务器不适合在生产环境中使用，后面会介绍生产环境服务器。

2.4 一个完整的程序

from flask import Flask

app = Flask(__name__)


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


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

  一个最简单的hello world程序。使用IDE运行时会显示实时状态，这是PyCharm运行时的状态。

其中最下面一行状态是我们点击访问网站的时候的状态更新，我们看到信息包括我们输入的网址、访问时间、访问的方法（GET）、使用的协议（HTTP/1.1）和响应码200，表示正常响应。而在我们的浏览器网页中会显示Hello World字样。

我们也可以使用上面的方法添加动态路由。把这个部分改写一下

@app.route('/user/<user>')
def hello_world(user):
    return ('Hello!',user)

  如此，运行后输入网址http://localhost:5000/user/abc，会显示Hello!abc。这就是动态路由的设置方法。

2.5 请求-响应循环

下面几个小节会介绍这个框架的一些设计理念。

2.5.1 程序和请求上下文

Flask从客户端收到请求时，要让视图函数能够访问一些对象，这样才能处理请求。请求对象就是一个很好的例子，它封装了客户端的HTTP请求。

要想让视图函数能够访问请求对象，一个显而易见的方式是将其作为参数传入视图函数，不过这会导致程序中的每个视图函数都增加一个参数。除了访问请求对象，如果视图函数在处理请求时还要访问其他对象，情况就会更糟。因此，Flask使用了上下文临时把某些对象变为全局可访问。有了上下文，就可以写出下面的视图函数

from flask import request
@app.route('/')
def index():
    user_agent = request.headers.get('User-Agent')
    return '<p>your browser is %s</p>' % user_agent

 在这个视图函数中，我们把request当做全局变量使用。事实上，request不可能是全局变量。试想，在多线程服务器中，多个线程同时处理不同客户端发送的不同请求时，每个线程看到的request对象必定不同。Flask使用上下文让特定的变量在一个线程中全局可访问，与此同时却不会干扰其他线程。

Flask中有两种上下文：程序上下文和请求上下文。

程序上下文：current_app —— 是当前激活程序的程序实例

g —— 处理请求时用作临时存储的对象，每次请求都会重设这个变量

请求上下文：request —— 请求对象，封装了客户端发出的HTTP请求的内容

session —— 用户会话，用于存储请求之间需要“记住”的值的字典

Flask在分发请求之前激活（或推送）程序和请求上下文，请求处理完成后再将其删除。程序上下文被推送后，就可以在线程中使用current_app和g变量。请求上下文亦然。如果使用这些变量时我们没有激活程序上下文或请求上下文，就会导致错误。

2.5.2 请求调度

程序收到客户端发送的请求时，要找到处理该请求的视图函数。为了完成这个任务，Flask会在程序的URL映射中查找请求的URL。URL映射是URL和视图函数之间的对应关系。Flask使用app.route修饰器或者非修饰器形式的app.add_url_rule()生成映射 。

要想查看Flask程序中的URL映射是什么样子，我们可以在另一个程序或Python Shell中检查之前写的程序生成的映射。

上面的路由是我们自己在程序中设置的，下面static路由是Flask添加的特殊路由，用于访问静态文件。

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

2.5.3 请求钩子(Hook)

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

请求钩子使用修饰器实现，Flask支持以下四种钩子：

• before_first_request :注册一个函数，在处理第一个请求前运行
• before_request 注册一个函数，在每次请求前运行
• after_request  注册一个函数，如果没有未处理的异常抛出，在每次请求之后运行。
• teardown_request：注册一个函数，及时有未处理的异常抛出，也在每次请求之后运行。

 在请求钩子函数和视图函数之间共享数据一般使用上下文全局变量g。例如，before_request处理程序可以从数据库加载已登录用户，并将其保存到g.user中。随后调用视图函数时，视图函数再以g.user获取用户。

2.5.4 响应

Flask调用视图函数后，会将其返回值作为响应的内容。在大多数情况下，响应就是一个简单的字符串，作为HTML页面回送给客户端。

但HTTP协议需要的不仅是作为请求响应的字符串。HTTP响应中重要的一个部分是状态码，如200表示请求被成功处理，404表示没有找到URL指向的资源。

如果视图函数返回的响应需要使用不同的状态码，那么可以把数字代码作为第二个返回值，添加到响应文本之后。例如，下面的视图函数返回一个400状态码，表示请求无效

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

视图函数返回的响应还可接受第三个参数，这是一个由首部（header）组成的字典，可以添加到HTTP响应中。一般情况下不需要这么做。如果我们不想返回由1个、2 个或3个值组成的元组，Flask视图函数还可返回Response对象。make_response()函数可以接受1个、2个或三个参数，并返回一个Response对象。有时我们需要在视图函数中进行这种转换，然后在响应对象上调用各种方法，进一步设置响应。比如，下面的例子设置了cookie

from flask import make_response

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

还有一种叫做重定向的特殊响应类型。这种响应没有页面文档，只告诉浏览器一个新地址用以加载新页面。重定向经常在Web表单中使用，其经常使用302码表示，指向的地址由Location首部提供。重定向响应可以使用3个值形式的返回值生成，也可在Response对象中设定。不过由于使用频繁，Flask提供了redirect()函数，用于生成这种响应：

from flask import redirect

@app.route('/')
def index():
    return redirect('http://www.baidu.com')

还有一种特殊的响应类型由abort函数生成，用于处理错误。在下面这个例子中，如果URL中动态参数id对应的用户不存在，就返回状态码404：

from flask import abort

@app.route('/userid/<id>')
def get_user(id):
    user = load_user(id)
    if not user:
        abort(404)
    return '<h1>Hello,%s</h1>' %user

注意，abort不会把控制权交还给调用它的函数，而是抛出异常把控制权交给Web服务器。

2.6 Flask扩展

Flask被设计为可扩展形式，故而没有提供一些重要的功能，例如数据库和用户认证，所以开发者可以自由选择最适合程序的包，或者按需求自行开发。