Flask Web开发--狗书笔记002--第二章程序的基本结构

第二章程序的基本结构

这一章作者会带着我们了解Flask程序各个部分的作用，编写并且运行第一个Flask Web程序。

2.1初始化

所有的Flask程序都必须创建一个程序实例对象，即一个Flask类的对象，客户端所有的请求都会转交给这个对象处理。
创建代码如下…

from flask import Flask
app = Flask(__name__)

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

自己其实不是很明白传入的这个name 参数，在当前的模块打印,name 就是main ，不理解的童鞋可以自己百度一下python中的name…

作者也解释了这一点：将构造参数的name参数传递给Flask程序，这一点可能会让Flask的开发新手心生迷惑。Flask使用这个参数决定程序的根目录，以便稍后能够找到相对于程序根目录的资源文件的位置。

这个初始化方式对于老手可能过于简单，但是对于简单的程序来说，上面的代码就够了。

2.2 路由和视图函数

客户端（例如一个Web浏览器）把请求发送给Web服务器，Web服务器再把请求发送给Flask程序实例。
这里写图片描述

程序实例这时候就需要知道每个URL请求运行哪些代码，所以保存了一个URL到Python函数的映射关系。

处理URL和函数之间关系的程序叫做路由。

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

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

这里有一个修饰器的概念（书中写的是修饰器，但是一般我们可能写作装饰器）。笔者给了一个简单的解释，修饰器是Python语言的标准特性，可以使用不同的方式来修改函数的行为。惯常用法是使用修饰器把函数注册为事件的处理程序。如果诸位童靴有想进一步了解的，可以自行百度…

像上一个代码示例中index()这样的函数被称为视图函数（view function）。视图函数返回的响应可以是包含HTML的简单字符串，也可以是复杂的表单。后文我们再详细说…
其实上一个示例代码有不合适的地方，就是在python代码中嵌入了响应的字符串，这么做会导致代码难以维护。笔者会在后面介绍生成响应的正确方法哒~

如果我们仔细观察日常所用服务的某些URL格式，就会发现很多地址中都包含可变的部分。笔者举了一个Facebook的例子：某个人他的facebook资料页面的地址是http://www.facebook.com/<your-name> ,用户名（your-name）是地址的一部分。
这是我的微博主页

https://weibo.com/u/3879647398/home?topnav=1&wvr=6

可以看出里面也带着请求参数。

Flask是支持这种形式的URL的，只需要在route修饰器中使用特殊的句法即可。举个栗子…

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

启动后在浏览器中输入我的名字的效果…
这里写图片描述

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

路由中的动态部分默认是使用字符串，不过也可以使用类型定义。例如，路由/user/ 只会匹配动态片段id为整数的URL。Flask支持在路由中使用int、float和path类型。
path类型也是字符串，但是不会把斜线当做是分隔符，而是将其当做动态片段的一部分。 这句话需要举个例子来理解…我好像大致理解，举栗子怕出错，后面会补上实例。

2.3启动服务器

程序实例是用run方法来启动Flask继承的开发Web服务器：

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

name == ‘main’ 是Python的惯常用法，在这里确保直接执行这个脚本时才启动开发Web服务器。如果这个脚本由其他脚本引入，程序会假定父级脚本会启动不同的服务器，app.run()不会被执行。

服务器被启动之后，会进入一种轮询的状态。等待并且处理请求。

debug = True，是激活调试器和重载模式。其实就是我们每次对代码做了修改之后，不用手动去重启。

笔者告诉我们Flask提供的Web服务器不适合在生产环境中使用，后续（17章）会告诉我生产环境服务器。

一个完整的程序

前面几节笔者已经为我们很详细地说了Flask Web各部分的组成，现在就是组合起来开发一个程序。整个hello.py 程序脚本如下，对于老鸟来说，可能太简单了，作为小白，我还是在这里运行显示下好了…

from flask import Flask

app = Flask(__name__)
print(__name__)


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


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

确保前面的虚拟环境被激活，代码没有错误之后，我们在浏览器输入http://127.0.0.1:5000/ 出现了浏览器连接到程序的示意图：
这里写图片描述

如果我们输入了其他地址，程序将不知道我们该如何处理，因此会向浏览器返回错误代码404.

请求-响应循环

我们已经开发出来一个简单的Flask程序，当然也会希望能进一步了解Flask的工作方式。下面几个小节是作者向我们介绍这个框架的一些设计理念。

程序和请求上下文

Flask从客户端收到一个请求的时候，我们希望它同时能够访问一些对象，拿到一些数据（我们本来就是要对请求做处理的嘛，当然需要请求数据啦）这样才能处理请求。
请求对象就是一个很好的例子。它封装了客户端发送的http请求。

要想让视图函数能够访问到请求对象，我们首先能想到的是将其作为参数传递给视图函数，不过这就导致了程序中的每个视图函数都增加了一个参数。

万一，除了访问请求对象，视图函数在处理请求时还需要访问其他的对象，那情况就比较难搞了…

为了避免大量可有可无的参数把视图函数弄得一团糟，Flask使用上下文临时把某些对象变成全局可以访问。

举个栗子…

from flask import Flask,request

app = Flask(__name__)

@app.route('/')
def index():
    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中有两种上下文：程序上下文和请求上下文。笔者给了我们一个表格，列出了这两种上下文提供的变量：（这里我直接剪切图片啦，打表格太麻烦）
这里写图片描述

笔者告诉我们，Flask在分发请求之前激活（或者是推送）程序和请求上下文，请求处理完成后再将其删除。
程序上下文被推送之后，就可以在线程中使用current_app和g变量。类似地，请求上下文被推送后，就可以使用request和session变量。

如果使用这些变量的时候我们没有激活程序上下文和请求上下文，就会导致错误。

笔者用python shell 会话为我们演示了程序上下文的使用方法：
这里写图片描述

书中是从输入current_app开始报错，我的实验室在导入current_app的时候就报错……
然后我继续按照书中的来，可以打印出hello，但是还是有报错。这个问题暂时标记一下后续解决。
这里写图片描述

书中的程序源码是这样的…
这里写图片描述

笔者给我们的解释是，在没有激活程序上下文之前就调用current_app.name 会报错，但是推送完成上下文之后就可以调用了。注意：在程序实例上调用app.app_context()可获得一程序上下文。

请求调度

程序收到客户端发来的请求时，要找到处理该请求的视图函数。

为了完成这个任务，Flask会在程序的URL映射中查找请求的URL。
这个URL映射很容易理解，就是一个URL和视图函数之间的对应关系。

有两种方法可以生成，一个是之前的app.route修饰器
另一个是非修饰器形式的app.add_url_rule() 生成映射。

在python shell里面检查一下我们为hello.py生成的映射：
测试之前，确保已经激活虚拟环境
这里写图片描述

在其中，我们比较惊奇地看到一个/static/ 路由是由flask添加的特殊路由，用于访问静态文件。（笔者告诉我们他会在第三章向我们详细介绍）

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

请求钩子

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

为了演示功能，我引用了这篇博文中的科普：请求钩子科普文

演示一个demo，使用钩子函数的时候，我们需要借助flask中的全局变量g，g会作为在钩子函数和视图函数之间传递数据。
首先引入一个全局变量g

from flask import g

然后注册一个视图函数，用来显示g中的数据

@app.route('/test')
def test():
    return g.string

（1）before_first_request：注册一个函数，在处理第一个请求之前执行。

@app.before_first_request
def bf_first_request():
    g.string = 'before_first_request'

运行程序，
这里写图片描述

（2）before_request 注册一个函数，在每次请求之前都运行

@app.before_request
def bf_request():
    g.string = 'before_request'

运行程序：
这里写图片描述

（3）after_request 注册一个函数，如果没有未处理的异常抛出，在每次请求之后运行。注意：注册的函数至少需要含有一个参数，这个参数实际上是为服务器的响应，且函数中需要返回这个响应参数。

@app.after_request
def af_request(param):
    return param

（4）teardown_request 注册一个函数，即使有未处理的异常抛出，也在每次请求之后运行。同样，注意：注册的函数至少需要含有一个参数，这个参数实际上是为服务器的响应，且函数中需要返回这个响应参数。

@app.teardown_request
def td_request(param):
    return param

笔者向我们提供了一个常见的用途：例如，before_request处理程序可以从数据库中加载已经登录的用户，并且将其保存到g.user中。

响应

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

http中有一个很重要的部分是状态码，Flask设置为200，这个代码说明请求已经被处理成功。

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

# -*- coding:utf-8 -*-

from flask import Flask,render_template


app = Flask(__name__)


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


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

视图函数还可以接收第三个参数，这是一个由首部（header）组成的字典，可以添加到http的响应中。我们会在后续（14章）看到栗子的。

make_response()函数

如果我们不想这样，返回由1个、2个或者3个值组成的元组，Flask视图函数还可以返回Response对象。

make_response()函数可以接受1个、2个或者3个参数（和视图函数的返回值一样一样的），并且返回一个response对象。

有时候我们是需要在视图函数中进行这种转化的，并且在响应对象上调用各种方法。下面举个栗子…

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

redirect

有一种名为重定向的特殊响应类型。这种相应没有页面文档，只是告诉浏览器一个新的地址用以加载页面。
重定向比较常用在表单页面（就比如我们去登陆某个网站填写信息之后的跳转）

重定向经常使用的状态码是302，指向的地址由location首部提供。
栗子…

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

运行结果是一个这样的页面…
这里写图片描述

abort

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

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

def load_user(id):
    if id == '1':
        return 'furuiyang'
    else:
        return ''

运行结果：
这里写图片描述

这里写图片描述

Flask扩展

例如数据库和用户认证……

使用Falsk-Script支持命令行选项

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

一种传递设置选项的理想方式是使用命令行参数。

Flask-Script

Flask-Script是一个Flask扩展，就是给Flask程序添加了一个命令行解析器。

它不仅自带一组常用选项，还支持自定义命令。

安装：

pip install flask-script

栗子：使用命令解析功能的hello.py

# -*- coding:utf-8 -*-

from flask import Flask
from flask_script import Manager


app = Flask(__name__)
manager = Manager(app)


@app.route('/')
def index():
    return 'hello!'


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

这个扩展的初始方法也适用于其他很多扩展：把程序实例作为参数传递给函数，初始化主类的实例。创建的对象可以在各个扩展中使用。

在这里，服务器由manager.run()启动，启动之后就能够解析命令了。
shell命令用于在程序的上下文中启动Python shell会话。我们可以使用这个会话进行维护任务或者是测试，还可以调试异常。

runserver 命令用来启动服务器。

这里写图片描述

–host 参数 告诉Web服务器在哪个端口上监听来自客户端的连接。
默认情况下，Flask开发Web服务器监听localhost上的连接，所以只允许来自服务器所在计算机发起的连接。

使用以下命令让Web服务器监听公共网络端口上的连接，允许同网中的其他计算机连接服务器。
这里写图片描述

第二章终于完结了，貌似笔记写得太细了，心好累…