FlaskWeb开发读书笔记-章二-程序的基本结构

第二章  程序的基本结构

2.1 初始化

        所有的flask程序都必须创建一个程序实例，即实例化一个类，也是这个类的实例化的对象：

from flask import Flask
app = Flask(__name__)

        web服务器使用一种名为Web服务器网关接口（web server gateway interface——WSGI）的协议，把接受自客户端的所有的请求都转交给这个对象处理。

2.2 路由和视图函数

        客户端（例如web浏览器）把请求发送给web服务器，web服务器再把请求发送给flask程序实例，程序实例需要知道对每个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()这样的函数称为视图函数（view function）。试图函数返回的响应可以是简单的字符串，也可以是复杂的表单。

        flask支持另一种动态URL，使用特殊语句就可以：

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

路由中尖括号中的内容就是动态部分，任何能匹配静态部分的URL都会映射到这个路由上。这个视图函数中，参数用于生成针对个人的欢迎消息。

⭐路由中动态部分默认使用字符串，也支持使用int，float，path类型。（例如，路由

/user/<int:id>

只会匹配动态片段id为整数的URL。）

2.3 启动服务器

        创建好程序实例后，我们使用run()方法启动flask集成开发的web服务器：

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

2.4 一个完整的程序

将上述程序都结合起来，能得到一个完整的Flask程序：

from flask import Flask
app = Flask(__name__)

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

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

 接着访问 http://127.0.0.1:5000/ ，访问我们创建出来的Flask页面：

运行结果：

        flask也支持动态路由，动态路由是指访问这个页面时，你会看到一则针对个人的欢迎消息，这个页面的URL也和默认地址有不同之处：

from flask import Flask
app = Flask(__name__)

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

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

接着访问：http://127.0.0.1:5000/user/Neo 便有以下界面：

页面的欢迎信息随着url改变而改变，例如换一个名字：http://127.0.0.1:5000/user/Neife 时，页面将变成：

这也是动态路由的名称而来。

2.5 请求-响应循环

2.5.1 程序和请求上下文

         当一个浏览器客户端发送了一些HTTP请求时，请求传递到Flask时，要让试图函数能够访问到一些对象，这样才能处理请求。这时，请求对象就是一个很好的例子，它封装了客户端发送的HTTP请求。

        想要让视图函数能够访问请求对象，可以将对象作为参数传入视图函数，但这样会导致程序中每一个视图函数都会增加一个参数，这样会产生大量资源浪费。

        若是使用上下文（Context）的方式把某些对象临时变为全局可访问，情况会好转许多：

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

        在这个视图函数中我们能看到如何把request当作全局变量使用，实际上request不可能是全局变量，Flask使用上下文的方式让特定的变量在一个线程中全局可访问，同时也不会干扰其他线程。

        Flask有两种上下文：线程上下文和请求上下文

变量名	上下文	说明
current_app	程序上下文	当前激活程序的程序实例
g	程序上下文	处理请求时用作临时存储的对象。每次请求都会重设这个变量
request	请求上下文	请求对象，封装了客户端发出的HTTP请求中的内容
session	请求上下文	用户会话，用于存储请求之间需要“记住”的值的字典

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

程序上下文被推送后，就可以在线程中使用current_app和g变量。同样请求上下文被推送后就可以使用request和session变量。如果使用这些变量时我们没有激活程序上下文或请求上下文，就会导致错误：

from hello import app
from flask import current_app
current_app.name        #程序运行出错

但推送完上下文之后，就可以调用了，具体方法：

from flask import current_app
from hello import app

app_ctx = app.app_context()
app_ctx.push()
print(current_app.name)        #打印hello
app_ctx.pop()

⭐在程序实例上调用app.app_context()可以获得一个程序上下文。

2.5.2 请求调度

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

        想要查看Flask程序中URL映射是什么样子，我们可以在python shell中检查为hello.py生成的映射：

from hello import app
print(app.url_map)

打印：

/与/user/<name>路由在程序中使用app.route修饰器定义。/static/<filename>路由是Flask添加的特殊路由，用于访问静态文件。URL映射中的HEAD,Options，GET是请求方法，由路由进行处理。Flask为每个路由都指定了请求方法，这样不同的请求方法发送到相同的URL上时，会使用不同的视图函数进行处理。

2.5.3 请求钩子

        有时在处理请求之前或之后执行代码会很有用，例如，在请求开始时，我们可能需要创建数据库连接或者认证发起请求的用户。为了避免在每个视图函数中都使用重复的代码，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响应中很重要的部分就是状态码，Flask默认设置为200，这个200表明请求已经被成功处理。

        若视图函数返回的响应需要使用不同的状态码，那么可以把数字代码作为第二个返回值，添加在响应文本之后：

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

ps:视图函数还能接收第三个参数，这是一个由首部（header）组成的字典，可以添加到HTTP响应中。

        若不想返回由1个，2个或3个值组成的元组，Flask视图函数还可以返回Response对象。make_response()函数可接受1个，2个或3个参数（与视图函数返回值一样），并返回一个response对象，有时我们需要在视图函数中进行这种转换，然后在响应对象上调用各种方法，进一步设置响应。下例创建了一个响应对象，然后设置了cookie：

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

        有一种名为重定向的特殊响应类型，这种响应没有页面文档，只告诉浏览器一个新地址用以加载新页面，重定向经常在Web表单中使用。重定向经常使用302状态码表示，指向的地址由location首部提供。重定向可以使用3个值形式的返回值生成，也可以在Response对象中设定。

⭐不过，由于使用频率高，flask提供了一个辅助函数：redirect()，用来帮助程序生成响应：

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

        还有一种特殊的响应由abort()函数组成，用于错误处理：

        ?在这个例子中，如果URL中动态参数id对应的用户不存在，就返回状态码404：

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

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

2.6 Flask拓展

        Flask呗设计成可拓展形式，故没有提供一些重要功能，例如数据库或用户认证，这些需要用户自行去开发。具体参考开发社区。