《Flask Web开发》学习笔记

第2章 程序的基础结构

2.1 初始化

所有Flask程序都必须创建一个程序实例。程序实例是Flask类的对象,经常使用下述代码创建:

from flask import Flask
app = Flask(__name__)

Web服务器使用一种名为Web服务器网关接口(Web Server Gateway Interface, WSGI)的协议中,把接收自客户端的所有请求都转交给这个对象处理。 这里有一个疑问: WSGI、uWSGI、Nginx、Flask在整个web程序访问中的作用和位置

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

2.2 路由和视图函数

处理URL和函数之间的关系的程序称为路由。在Flask程序中定义路由的最简便方式,是使用程序实例提供的app.route修饰器,把修饰的函数注册为路由。下面的例子说明了如何使用这个修饰器声明路由:

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

像index()这样的函数称为视图函数(view function)。视图函数返回的响应可以是包含HTML的简单字符串,也可以是复杂的表单。

支持变量的路由,尖括号中的部分是动态部分,任何能匹配静态部分的URL都会映射到这个路由上。

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

路由中的动态部分默认使用字符串,不过也可以使用类型定义。例如,路由/user/<int:id>只会匹配动态片段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()。

服务器启动后,会进入论询,等待并处理请求。论询会一直运行,直到程序停止,比如按Ctr-C键。

Flask提供的Web服务器不适合在生产环境中使用。

2.4 一个完整的程序

示例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

输出结果:

Running on http://127.0.0.1:5000/
Restarting with reloader

2.5 请求-响应循环

2.5.1 程序和请求上下文

在Flask中有两种上下文: 程序上下文 和请求上下文。 上下文 : context Flask上下文全局变量

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

Flask从客户端收到请求时,要让视图函数能访问一些对象,这样才能处理请求。请求对象(request)就是一个很好的例子,它封装了客户端发送的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使用上下文让特定的变量在一个线程中全局可访问,与此同时却不会干扰其他线程。

线程是可单独管理的最小指令集。进程经常使用多个活动线程,有时还会共享内存或文件句柄等资源。多线程Web服务器会创建一个线程池,再从线程池选择一个线程用于处理接收到的请求。

2.5.2 请求调度

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

在Python shell中导入Flask app,执行app.url_map可以检查Flask程序生成的映射。

$ python
>>> from hello import app
>>> app.url_map

/和/user/<name> 路由在程序中使用app.route修饰器定义。/static/<filename>路由是Flask添加的特殊路由,用于访问静态文件。

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

2.5.3 请求钩子

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

请求钩子使用修饰器实现。Flask支持以下是4种钩子。

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

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

2.5.4 响应

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

但HTTP协议需要的不仅是作为请求响应的字符串。HTTP响应中一个很重要的部分是状态码,Flask默认设为200,这个代码表明请求已被成功处理。

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

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

视图函数返回的响应还可接受第三个参数,这是一个由首部(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

结果如下图,在firefox浏览器中测试:

有一种名为重定向的特殊响应类型。这种响应没有页面文档,只告诉浏览器一个新地址用以加载新页面。重定向经常在Web表单中使用。

重定向经常使用302状态码表示,指向的地址用Location首部提供。重定向响应可以使用3个值形式的返回值生成,也可在Response对象中设定。不过,由于使用频繁,Flask提供了redirect()辅助函数,用于生成这种响应:

from flask import redirect

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

可以在后台及浏览器中看到返回码是302

还有一种特殊的响应由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扩展

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

Ubuntu 18.04LTS + Python 3.7 执行pip install flask-script安装的版本是flask-script-2.0.6

正确的导入方法如下,而不是下面注释的导入方法,2.0.6版本的导入方法变了:

from flask import Flask
from flask_script import Manager
#from flask.ext.script import Manager

app = Flask(__main__)
manager = Manager(app)

# ...

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

运行结果如下:

python hello.py 
usage: hello.py [-?] {shell,runserver} ...

positional arguments:
  {shell,runserver}
    shell            Runs a Python shell inside Flask application context.
    runserver        Runs the Flask development server i.e. app.run()

optional arguments:
  -?, --help         show this help message and exit

shell命令用于在程序的上下文中启动Python shell会话。你可以使用这个会话中运行维护任务或测试,还可调试异常。

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

python hello.py runserver --help
usage: hello.py runserver [-?] [-h HOST] [-p PORT] [--threaded]
                          [--processes PROCESSES] [--passthrough-errors] [-d]
                          [-D] [-r] [-R] [--ssl-crt SSL_CRT]
                          [--ssl-key SSL_KEY]

Runs the Flask development server i.e. app.run()

optional arguments:
  -?, --help            show this help message and exit
  -h HOST, --host HOST
  -p PORT, --port PORT
  --threaded
  --processes PROCESSES
  --passthrough-errors
  -d, --debug           enable the Werkzeug debugger (DO NOT use in production
                        code)
  -D, --no-debug        disable the Werkzeug debugger
  -r, --reload          monitor Python files for changes (not 100% safe for
                        production use)
  -R, --no-reload       do not monitor Python files for changes
  --ssl-crt SSL_CRT     Path to ssl certificate
  --ssl-key SSL_KEY     Path to ssl key

–host参数是个很有用的选项,它告诉Web服务器在哪个网络接口上监听来自客户端的连接。默认情况下,Flask开发Web服务器监听localhost上的连接,所以只接受来自服务器所在计算机发起的连接。下述命令让Web服务器监听公共网络接口上的连接,允许同网络中的其他计算机连接服务器:

python hello.py runserver --host 0.0.0.0

现在,Web服务器可使用http://a.b.c.d:5000/网络中的任一台电脑进行访问,其中a.b.c.d是服务器所在计算机的外网ip地址。

打印/导出
QR Code
QR Code flask_web开发_学习笔记 (generated for current page)