Flask官方文档中的留言板项目解说之项目结构说明(1)

前言

此留言板项目虽然比较简单,但是对于初学者,照着敲一遍代码还是会有点不知所然。因此,理清此项目是如何通过Flask建立起来的,它的前端如何与后端逻辑的关系,以及如何处理数据库,包括新建用户、用户登录、新建留言板、修改留言板等,是至关重要的一环。

先看留言板的展示效果,如下。

  • 未登陆状态,看不到新建留言板按钮


  • 注册页面,输入栏太长,这个可以通过CSS去修改,跟username处于同一行会更美观。若要加入地址、电话、QQ等,则需要修改schema.sql文件,重新初始化数据库。


  • 登陆页面,登陆后跳转到index页面,但是可以看到新建、编辑按钮


  • 登录后的页面


  • 编辑、删除页面


项目文件结构

于个人而言,看此项目,第一步是摸清项目文件结构,可以自己先猜测每个文件的作用是什么,它们是如何衔接、组成一个整体的项目。如,需要数据库,哪数据库是怎么连接的,如何初始化数据库的,何时需要增删改查。Flask需要初始化实例,那么,每次启动项目,我希望它自动初始化,并加载固定的配置文件,这些是如何实现的。

除自动化测试外(暂不讨论说明),此项目文件结构如下:

E:\python_project\PycharmProjects\Flask_tutorial
├── flaskr/
│   ├── __init__.py
│   ├── db.py
│   ├── schema.sql
│   ├── auth.py
│   ├── blog.py
│   ├── templates/
│   │   ├── base.html
│   │   ├── auth/
│   │   │   ├── login.html
│   │   │   └── register.html
│   │   └── blog/
│   │       ├── create.html
│   │       ├── index.html
│   │       └── update.html
│   └── static/
│       └── style.css
├── venv/
├── setup.py
└── MANIFEST.in
  • flaskr是一个包,因为有init.py文件,运行flask run后,会自动执行这个文件下的函数。这对应自动初始化Flask实例。
  • db.py,是关于数据库的基本操作,如通过命令行初始化DB、连接DB、操作完数据后关闭DB等
  • schema.sql是数据库建表语句,在init.py文件中应该会有引用它的地方,按照这个SQL在数据库中建表。
  • auth.py,包含用户注册、用户登录与登出,想要新建、修改和删除留言板需要确保是登录状态。
  • blog.py, 显示留言板已有的内容、登录状态情况下的新建、修改和删除处理。
  • template是前端页面模板,在auth.py和blog.py中每个函数是一个view(视图),即用户会看到的、需要进行的操作,但只有逻辑处理,因此每个视图都需要对应一个前端模板。如create.html文件是用于建立留言板的视图。
  • style.css是样式文件。
  • setup.py是将代码打包成一个项目,以后其他项目需要用它的接口(功能)就可以直接安装使用。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,793评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,567评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,342评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,825评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,814评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,680评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,033评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,687评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,175评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,668评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,775评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,419评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,020评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,206评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,092评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,510评论 2 343