第三章 程序的结构

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应用开发实战》这本书。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,542评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,596评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,021评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,682评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,792评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,985评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,107评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,845评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,299评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,612评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,747评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,441评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,072评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,828评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,069评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,545评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,658评论 2 350

推荐阅读更多精彩内容