《Flask_Web开发》读书笔记-第二章

第二章 程序的基本结构

2.1程序的初始化

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

from flask import Flask
app = Flask(__name__)

这个Flask对象app的作用是，接收用户的请求并且对用户请求进行处理。当用户发送请求到web服务器时，web服务器通过使用一种协议把客户发来的请求转交给这个app处理。这个依附于web服务器的协议名为web服务器网关接口（Web Server Gateway Interface）=WSGI。

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

2.2 路由和视图函数

        当客户端（可理解为web浏览器）发送请求给web服务器时，web服务器会将请求发送给Flask程序实例，这个程序实例需要知道对哪个URL请求运行哪些代码，在这里需要保存一支从URL到函数的映射关系，因此，路由在此发挥作用。路由是处理函数与URL之间对应关系的中间人程序。

        Flask定义路由的最简方式就是使用程序实例提供的app.route()修饰器，把修饰的函数注册为路由：

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

⭐修饰器的惯常用法是把函数注册为事件的处理程序。

        在路由中设定的'/'意为根路由，windows下在浏览器中访问‘127.0.0.1/’时，便能返回函数index()中的具体内容。

        在这里，函数index()被称为视图函数(view function)。视图函数返回的响应可以是包含HTML的简单字符串，也可以是复杂的表单。出于维护代码的目的，一般视图函数响应中不会直接写入字符串。

        在路由中还可以写入动态参数。例如：

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

        在定义路由中尖括号中写入的就是动态部分。在动态部分默认使用的是字符串，不过也可以用类型定义。例如，

@app.route('/user/<int:id>')

↑此路由只会匹配动态片段id为整数的URL。Flask支持在路由中使用int，float，path类型。

2.3 启动服务器

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

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

        ⭐在这里保证了直接执行这个脚本时才启动开发web服务器。debug=True是调试模式，当其参数设定为True时，就是开启调试模式。

2.4 完整的程序

        1.静态路由部分：

        将上述分支合并在一起，就是一个完整的程序：

from flask import Flask
app = Flask(__name__)

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

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

        打开web浏览器，在地址栏输入http://127.0.0.1:5000/,便能看见运行结果了：

        2.动态路由部分：

from flask import Flask

app = Flask(__name__)

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

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

2.5 请求循环响应

?以下涉及Flask的工作方式，可以选读。

2.5.1 程序与请求上下文

        当客户端发送请求给Flask时，要让视图函数可以访问到一些对象，这样才能处理请求。这时要用到请求对象。请求对象封装了客户端发送的HTTP请求。

        想要让视图函数能够访问请求对象，一个显而易见的方式是将其作为参数传入视图函数，但这样会造成程序中的每个视图函数都增加一个参数。这会造成混乱的运行。

        Flask使用上下文把某些对象变成临时的全局变量。例如：

from flask import request

@app.route('/ex')
def indexx():
    user_agent = request.headers.get('User-Agent')
    return '<p>Your browser is %s</p>' % user_agent

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

        在这个视图函数中我们如何把request当作全局变量使用的。实际上request不可能是全局变量，因为对于多线程服务器来说，多个线程同时处理不同客户端发来的不同的请求时，每个线程看到的request必定是不同的。Flask使用上下文让特定的变量在一个线程中全局可访问，与此同时不会影响其他的线程。

        运行结果：

 

Flask在分发请求之前激活（或者推送）上下文，请求完成之后再将其删除。

上下文分为请求上下文和程序上下文。

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

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

如下，再python shell中演示上下文的使用方法：

后，python发出错误报告：

在此例中，没激活程序上下文之前调用current_app.name会导致错误Working outside of application context。但推送完上下文之后就可以调用了。⭐在程序实例上调用app.app_context()可以获得一个程序上下文。⭐

2.5.2 请求调度

程序在收到客户端发来的请求时，要找到处理该请求的视图函数。为了完成这个任务，Flask会在程序的URL映射中查找请求的URL。

URL映射是URL与视图函数之间的对应关系。Flask使用app.route修饰器（或者非修饰器形式的app.add_url_rule()）生成映射。

若想要查看Flask程序中的URL映射是什么样子，我们在python shell中使用app.url_map检查为这个程序创建的映射：

从结果可以看到，“/”，“/ex”，“/user/<name>”路由在程序中使用app.route修饰器定义。/static/<filename>路由是Flask添加的特殊路由，用于访问静态文件。

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

2.5.3 请求钩子

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

        ?请求钩子的种类：

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

2.5.4 响应

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

        但HTTP需要的不仅是作为请求响应的字符串。在HTTP响应中一个很重要的部分就是状态码，Flask默认设置200，这个状态码表明请求已经被成功处理。如果视图函数的响应需要不同的状态码，那么可以把数字代码作为第二个返回值添加在响应文本之后，例如：

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

运行结果： 

同时在shell中：

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

        ⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐

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

        下例创建了一个响应response对象，然后设置了cookies：

from flask import make_response
@app.route('/res')
def resp_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('/redi')
def redi_index():
    return redirect('http://www.baidu.com')

于是在重定向后，网页会跳转至‘http://baidu.com’这个页面。

⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐⭐

        还有一种特殊的响应由abort函数生成，用于错误处理。在下面这个例子中，如果URL中动态参数id对应的用户不存在，就返回状态码404：(abort不会把控制权交给调用它的函数，而是抛出异常把控制权交给web服务器)

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

 

?番外篇：路由定义的基本方式

一.请求方式的限定

                 使用methods参数指定可接受的请求方式，可以是多种，一般默认为GET方法，要增加方法可以使用列表形式增加：

@app.route('/',methods=['GET','POST'])

可以使用postman查看其请求方式：

二.路由传参实例

使用同一个函数，表现出不同的用户页面：

@app.route('/orders/<order_id>')
def get_order_id(order_id):
    return 'order_id %s' %order_id

或者：

@app.route('/orders/<int:order_id>')
#其中的int可以限定动态参数的类型，float也可以

在这里的int会调用系统的路由转换器进行匹配和转换，原理为：

1. 将参数强制转换为int，成功则进行路由匹配
2. 若参数无法转换成功，就无法匹配该路由