Flask 并不强制要求使用特定的组织方式,程序结构的组织方式完全由开发者自己掌控。在此,我们会简单介绍一下 flask 程序的组织结构。就像生物从单细胞进化到多细胞的历程一样,我们的程序结构也有自己的进化过程,因此我们区分程序的结构为单一文本,小型项目结构,大型项目结构。
3.1 单一脚本
示例3-1 hello.py: 一个完整的 flask 单一脚本程序
# -*- coding:utf-8 -*-
__author__ = u'东方鹗'
from flask import Flask
app = Flask(__name__)
@app.route('/')
def index():
return '<h1>Hello World!</h1>'
if __name__ == '__main__':
app.run(debug=True, host='0.0.0.0', port=8080)
3.1.1 设定字符集
python 是跨平台编程语言,为了方便的实现这个特性,建议你一开始就设置好跨平台的 UTF-8 的字符集,在每一个脚本的开头创建如下代码:
# -*- coding:utf-8 -*-
__author__ = u'东方鹗'
3.1.2 初始化
所有的 Flask 程序都必须创建一个程序实例。WEB 服务器使用一种名为WEB服务器网关接口(Web Server Gateway Interface, WSGI)的协议,把接收自客户端的所有请求都转交给这个对象处理。
from flask import Flask
app = Flask(__name__)
Flask 类的构造函数只有一个必须指定的参数,即程序主模块或包的名字。在大多数程序中,Python 的 __name__ 变量就是所需的值。Flask 用这个参数决定程序的根目录,以便稍后能够找到相对于程序根目录的资源文件位置。
3.1.3 路由和视图函数
客户端( WEB 浏览器)把请求发送给 Web 服务器,Web 服务器再把请求发送给 Flask 程序实例。程序实例需要知道对每个 URL 请求运行那些代码,所以保存了一个 URL 到 Python 函数的映射关系。处理 URL 和函数之间关系的程序称为路由。
在Flask程序中,定义路由最简便的方式,是使用程序实例提供的 app.route 修饰器,把修饰的函数注册为路由。
@app.route('/')
def index():
return '<h1>Hello World!</h1>'
上例把 index() 函数注册为程序根地址的处理程序。这样的函数被称为视图函数(view function)。视图函数返回的响应可以包含 HTML 的简单字符串,也可以是复制的表单。
提示:在 Python 中嵌入响应字符串并不是一个好主意,此处这么做只是为了介绍响应的概念。
3.1.4 启动服务器
程序实例用run方法启动 Flask 集成的开发 web 服务器:
if __name__ == '__main__':
app.run(debug=True, host='0.0.0.0', port=8080)
__name__ == '__main__'
是 python 的惯用用法,在这里确保直接执行这个脚本时才启动开发 web 服务器。
app.run() 函数可以接受一些选项参数用于设置WEB服务器的操作模式。debug=True,开启调试模式;host='0.0.0.0',提供局域网内浏览器访问服务;port=8080,使用 8080 端口号。
3.2 小型项目结构
单一脚本结构过于原始,程序变复杂之后,使用单个脚本文件会导致很多问题。因此,在此推荐一种符合 MVC 结构,适合开发并且不失灵活方便的组织结构。
Ousikeji/
|-- flask/
|-- |-- <python虚拟环境>
|-- app/ <项目的模块名称>
|-- |-- static/ <静态文件夹>
|-- |-- templates/ <HTML模板文件夹>
|-- |-- __init__.py
|-- |-- views.py <路由和视图函数文件>
|-- |-- forms.py <表单类文件, wtforms插件必须项>
|-- tmp/ <临时文件夹,或其他文件归档处>
|-- run.py <运行程序脚本>
实例3-2-1 app/init.py
# -*- coding:utf-8 -*-
__author__ = u'东方鹗'
from flask import Flask
app = Flask(__name__)
from app import views
实例3-2-2 app/views.py
# -*- coding:utf-8 -*-
__author__ = u'东方鹗'
from flask import render_template
from app import app
@app.route('/')
@app.route('/index')
def index():
return render_template("index.html")
实例3-2-3 app/templates/index.html
<!DOCTYPE html>
<html>
<head lang="zh">
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="谦卑并倔强的活着!">
<meta name="author" content="东方鹗">
</head>
<body>
<h1>Hello World!</h1>
</body>
</html>
实例3-2-4 run.py
# -*- coding:utf-8 -*-
__author__ = u'东方鹗'
from app import app
app.run(debug=True, host='0.0.0.0', port=8080)
赋予 run.py 可执行的权限,然后运行该脚本,你会看到结果的。
3.3 大型项目结构
ousikeji/
|-- flask/
|-- |-- <python虚拟环境>
|-- app/ <项目的模块名称>
|-- |-- static/ <静态文件夹>
|-- |-- templates/ <HTML模板文件夹>
|-- |-- |-- main/
|-- |-- |-- |-- __init__.py
|-- |-- |-- |-- views.py <路由和视图函数文件>
|-- |-- |-- |-- forms.py <表单类文件, wtforms插件必须项>
|-- |-- __init__.py
|-- |-- email.py <可选项,根据需要增加>
|-- |-- models.py <数据库模型文件>
|-- migrations/ <数据库表关系文件夹,Flask-Migrate迁移数据库时使用>
|-- tests/
|-- |-- __init__.py
|-- |-- test*.py <测试文件>
|-- requeirements.txt <插件依赖包>
|-- config.py <项目的配置文件>
|-- manage.py <用于启动程序以及其它程序任务>
注意:为了完全理解这个结构,建议大家学习《Flask Web开发——基于Python的Web应用开发实战》这本书。