第二章 程序的基本结构

2.1 Flask简介

Flask框架由三部分组成，Flask、Werkzeug、Jinja2。

Flask，为了提高自由度和可扩展性。只提供网络框架的最小核心，其他功能则通过扩展实现。它依赖于下面两个同样由Flask作者开发的python模块。
Werkzeug，一个WSGI框架，它是HTTP可以理解的信息和python程序可以理解的信息之间的翻译官。通过它Flask程序可以顺畅的阅读HTTP信息。
Jinja2，一个html模板系统，它的目的是简化html语句的录入工作量。

2.2初始化

2.2.1 Flask类必须指定根目录参数

from flask import Flask
app = Flask(__name__)

这是为了能够找到资源文件。
参数提供了程序根目录位置。资源文件一般在根目录的相对位置。
在大多数情况下，name这个参数就是所需值。这个参数此处的功能是：指向用它做参数的flask类的目录，而不管这个类是直接执行或被导出调用。

2.3 路由

2.3.1 Flask需要知道/index这样的路径实现什么功能

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

路由使用app.route装饰器，它为路径/index找到对应的函数，也就是这里的index。

2.3.2 动态路径：有时候路径只有一部分相同，另一部分可变

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

尖括号中的内容就是动态部分，任何能匹配静态部分的URL都会映射到这个路由上。
调用视图函数时，Flask会将动态部分作为参数传入函数。

2.3.3 动态类型定义：

分为int、float、path三种。
例如：/user/<int:id>，只会匹配id为整数的URL。
path类型也是字符串，但不把斜线视作分隔符，而将其当作动态片段的一部分。

2.3.4 启动服务器：使用程序实例的run方法

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

如果这个脚本由其他脚本导入，程序会假定父脚本会启动不同的服务器。

2.4 完整的例子

2.4.1 一个完整的程序

# 示例 2-1 hello.py： 一个完整的Flask程序
from flask import Flask
app = Flask(__name__)  
 
@app.route('/')
def index():
    return '<h1>Hello World!</h1>'
 
if __name__ == '__main__':
    app.run(debug=True)

使用命令$ python hello.py启动程序，访问地址http://localhost:5000/。

2.4.2 动态路由版

# 示例 2-2 hello.py： 包含动态路由的 Flask 程序  
from flask import Flask
app = Flask(__name__)  
 
@app.route('/')
def index():
return '<h1>Hello World!</h1>'  
  
@app.route('/user/<name>')
def user(name):
return '<h1>Hello, %s!</h1>' % name  
if __name__ == '__main__':
app.run(debug=True)

访问 http://localhost:5000/user/Dave，
Dave就是动态参数<name>，尝试使用不同的名字试试。

2.5 请求-响应循环

2.5.1 上下文：防止程序参数冗余

为什么需要上下文:

Flask需要根据网址返回相应值，这需要视图函数访问一些对象。
例如request对象，它封装了客户端发送的HTTP请求。
要想让视图函数能够访问请求对象，
一个显而易见的方式是将其作为参数传入视图函数，
不过这会导致程序中的每个视图函数都增加一个参数，大大增加复杂度。
Flask使用上下文临时把某些对象变为全局变量，这使得视图函数不需要显式声明这个参数，
但却能够使用它，大大降低了复杂度。

一个request使用示例：

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

=服务器中可能有多个客户端请求，把request作为全局变量会出错，
而上下文管理使得request可以全局访问，但又不干扰其他线程。

上下文全局变量：

current_app  # 当前激活程序的程序实例,例如运行的是hello.py，则current_app为<Flask hello>
g  # 处理请求时用作临时存储的对象。每次请求都会重设这个变量
request  # 请求对象，封装了客户端发出的HTTP请求中的内容
session  # 用户对话，用于存储请求之间需要“记住”的值的词典  

上下文调用流程：

from hello import app  
from flask import current_app  # 导入需要使用的上下文    
 
app_ctx = app.app_context()  # 激活上下文，取得app_context类的一个实例  
app_ctx.push()  # 推送上下文  
print(current_app.name)  # 在线程中使用导入的上下文。  
app_ctx.pop()  # 手动删除上下文

flask以app._context类的方法push和pop进出栈的方式，管理多线程。
为防止push栈后，不能pop栈，尽量使用try和finnally.

2.5.2 查看映射：

Flask使用app.route装饰器或app.add_url_rule()生成映射。
在python shell中使用app.url_map查看映射关系

>>>from hello import app
>>>app.url_map
Map([<Rule '/' (HEAD, OPTIONS, GET) -> index>,
<Rule '/static/<filename>' (HEAD, OPTIONS, GET) -> static>,
<Rule '/user/<name>' (HEAD, OPTIONS, GET) -> user>])  

除了我们自己定义的/和/user/<name>路由，
还有一个/static/<filename>是Flask添加的静态文件路由。显然<filename>是我们讲过的动态路由中的path类型。

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

2.5.3 请求钩子：避免请求前后的重复操作

请求钩子是装饰器，Flask支持4种钩子：

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

在请求函数和视图函数之间共享数据一般使用上下文全局变量g。

2.5.4 响应：几种返回类型和状态码

响应是什么？

Flask调用视图函数后，会将其返回值作为响应的内容。
返回值由三部分组成：字符串、状态码和header字典。
大多数情况下，响应只需要字符串，作为HTML页面回送客户端。
但如果不是请求成功处理的正常状态，就需要增加状态码。
header字典有时也会用到。

请求成功和请求无效的状态码

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

数字代码作为第二个返回值，代表处理状态。
400代表请求无效，而200代表请求已被成功处理。
Flask把状态码默认设置为200，所以成功处理可以不指定状态码。

重定向的状态码和简化处理：

有时返回值不是一个页面字符串，而是一个新地址，这叫做重定向。
重定向经常使用302表示，指向的地址由header Location提供。
由于使用频繁，Flask提供了简化处理的形式：redirect函数

from flask import redirect
  
@app.route('/')
def index():
    return redirect('http://www.example.com')

处理错误状态码的abort函数：

HTTP有很多种错误，Flask用一个通用 的方法abort来处理。
这是所有错误代码：HTTP错误代码

一个abort的例子：

from flask import abort
 
@app.route('/user/<id>')
def get_user(id):
    user = load_user(id)  # 读取动态参数id对应的用户
    if not user:  # 如果用户不存在，则返回状态码404
        abort(404)
    return '<h1>Hello, %s</h1> % user.name

2.6 Flask 扩展

2.6.1 为什么需要扩展

Flask被设计为更自由的方式，故没有提供一些重要的功能，例如数据库和用户认证。
这就需要用扩展的形式来补充Flask源码没有的功能，
开发者可以自由选择最适合程序的包，或者按需求自行开发（可以使用所有python标准包或代码库。

2.6.2 使用Flask-Script支持命令行选项

为什么需要命令行选项

Flask的开发web服务器支持很多启动设置选项，
但只能在脚本中作为参数传给app.run()函数。
这中方式并不十分方便，传递设置选项的理想方式是使用命令行参数。

Flask-Script介绍和安装

Flask-Script是一个Flask扩展，为Flask程序添加了一个命令行解析器。
Flask-Script自带了一组常用选项，而且还支持自定义命令。
Flask-Script扩展使用pip安装：

pip install flask-script

Flask-Script的使用前置步骤

这个实例显示了把命令行解析功能添加到app程序中需要修改的地方。

from flask_script import Manager  # 注意原书中是flask.ext.script，这种方式现在已经不推荐了
manager = Manager(app)
 
# ...
 
if __name__ == '__main__':
    manager.run()

这个扩展的初始化方法也使用于其他很多扩展：
把程序实例作为参数传给构造函数，初始化主类的实例。
创建的对象可以在各个扩展中使用。
在这里，服务器由manager.run()启动，启动后就能解析命令行了。

使用Flask-Script命令行

现在我们像以往那样，在命令行执行
$ python hello.py
这次有点不一样，并没有直接运行服务器，而是出现了类似下面的消息：

usage: app.py [-?] {runserver,shell} ...
   
positional arguments:
    {runserver,shell}
        runserver         运行Flask开发服务器，例如 app.run()
        shell            在Flask app的上下文中运行python shell
optional arguments:
    -?, --help         显示帮助信息并退出

也就是说，在python hello.py 后面必须跟着shell或者runserver两者之一。
shell 命令用于在程序的上下文中启动 Python shell 会话。
你可以使用这个会话中运行维护任务或测试，还可调试异常。

runserver 命令用来启动 Web 服务器。
运行 python hello.py runserver 将以调试模式启动 Web服务器，但是我们还有很多选项可用

runserver的几个参数

• -h HOST 设定为0.0.0.0表示为公网，127.0.0.1表示为本局域网
• -p 设定端口 Flask默认为5000，HTTP协议默认为80
• -d 开启调试模式
• -D 不开启调试模式
• -r 自动重载文件
• -R 不自动重载文件
• 还有--threaded, --processes, --passthrough等选项。

例如要在服务器上运行Flask程序，应该这样：

$ python hello.py runserver -h 0.0.0.0 -p 80