在学习 Flask 的过程中，正确理解项目结构非常关键。一个合理的项目结构能够使代码更易于理解和维护。在本节中，我们将通过一个简单的案例来解析 Flask 项目的基本结构。
项目目录结构
假设我们要创建一个基本的 Flask 应用，我们的目录结构可能如下所示：
1
2
3
4
5
6
7
8
9
10
11
12
| my_flask_app/
│
├── app/
│ ├── __init__.py
│ ├── routes.py
│ ├── models.py
│ └── templates/
│ └── index.html
│
├── config.py
├── run.py
└── requirements.txt
|
目录及文件解析
app/ 目录
- 这个目录是应用程序的核心部分，包含了所有与应用相关的文件和代码。
__init__.py: 这个文件会初始化 Flask 应用。在这里，我们通常会创建应用实例，并注册蓝图和配置。routes.py: 在此文件中定义应用的路由。路由是 URL 与其对应的处理函数之间的映射。models.py: 此文件用于定义数据模型，通常与 ORM（如 SQLAlchemy）结合使用。templates/: 此目录存放所有的 HTML 模板文件。 Flask 使用 Jinja2 模板引擎渲染 HTML。
config.py
- 配置文件用于存放应用的配置信息，如数据库连接字符串、调试模式等。合理的配置管理可以使项目更加灵活。
run.py
- 入口文件，运行应用的主要脚本。通常在这里会初始化应用并调用
app.run() 方法。
requirements.txt
- 该文件用于列出项目依赖的 Python 包。
Flask 支持使用 pip 来安装依赖，简单执行 pip install -r requirements.txt 即可。
示例代码
下面是各个重要文件的简要示例。
app/__init__.py
1
2
3
4
5
6
7
8
9
10
| from flask import Flask
def create_app():
app = Flask(__name__)
app.config.from_object('config')
with app.app_context():
from . import routes
return app
|
app/routes.py
1
2
3
4
5
6
7
| from flask import render_template, Blueprint
bp = Blueprint('main', __name__)
@bp.route('/')
def index():
return render_template('index.html')
|
app/templates/index.html
1
2
3
4
5
6
7
8
9
10
11
| <!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Hello, Flask!</title>
</head>
<body>
<h1>Hello, Flask!</h1>
</body>
</html>
|
run.py
1
2
3
4
5
6
| from app import create_app
app = create_app()
if __name__ == '__main__':
app.run(debug=True)
|
config.py
1
2
3
| class Config:
SECRET_KEY = 'your_secret_key'
|
requirements.txt
总结
通过对 Flask 项目结构的解析，我们可以看到一个标准的 Flask 应用应该如何组织。合理的代码分层和模块化能够帮助我们更好地管理和扩展应用。随着项目的复杂度增加，我们可以逐渐引入更多的功能模块，而保持结构的清晰性与可维护性。
