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是将代码打包成一个项目，以后其他项目需要用它的接口（功能）就可以直接安装使用。