一文搞懂 Flask 框架 – wiki基地

作者： /

一文搞懂 Flask 框架：从入门到核心概念

前言：Web 框架的世界与 Flask 的位置

在当今互联网时代，Web 应用无处不在。从简单的博客、电商平台到复杂的企业级应用，Web 开发是软件工程中极其重要的一部分。为了提高开发效率，避免从零开始处理 HTTP 请求、路由、模板渲染、数据库交互等繁琐的基础工作，Web 框架应运而生。

Web 框架为开发者提供了一套标准化的、可复用的工具和结构，让我们可以更专注于业务逻辑的实现。在 Python 的世界里，有许多优秀的 Web 框架，其中最著名的莫过于 Django 和 Flask。Django 是一个“全栈”框架，提供了开箱即用的许多功能（如 ORM、管理后台、模板系统等），适合快速开发功能完善的大型应用。而 Flask 则是一个“微框架”，它只保留了构建 Web 应用最核心的功能，如请求处理、路由和模板渲染。其余的功能，如数据库、表单验证、用户认证等，都以扩展的形式提供，开发者可以根据自己的需求自由选择和组合。

正是因为其简洁、灵活和易于学习的特性，Flask 在许多场景下成为开发者的首选，尤其是对于中小型项目、API 开发、快速原型开发以及希望对底层有更多控制权的项目。本文将带你深入理解 Flask 的核心概念，让你也能“一文搞懂”这个强大的微框架。

什么是 Flask？为什么选择它？

Flask 是一个使用 Python 编写的轻量级 Web 应用框架。它基于 Werkzeug WSGI 工具箱和 Jinja2 模板引擎。

  • Werkzeug: 是一个用于创建 Web 应用、与 HTTP 协议交互的工具库。它处理了底层诸如请求解析、响应生成、Cookies 处理等工作。
  • Jinja2: 是一个功能强大且易于使用的模板引擎，用于将 Python 数据渲染到 HTML 等格式的页面中。

Flask 被称为“微框架”并非因为它功能有限，而是因为它核心简洁，不强制依赖特定组件。它不包含数据库抽象层（ORM）、表单验证工具等，这些都可以通过各种强大的扩展库来集成。这赋予了开发者极高的自由度，可以选择最适合项目需求的工具，而不是被框架绑定。

选择 Flask 的理由通常包括：

  1. 入门简单，学习曲线平缓： 代码量少，概念清晰，即使是 Web 开发新手也能快速上手。
  2. 高度灵活： 开发者可以自由选择数据库、模板引擎（虽然默认推荐 Jinja2）、认证方式等几乎所有组件。
  3. 强大的扩展生态： 社区贡献了大量的 Flask 扩展，涵盖了从数据库到用户认证、RESTful API 等几乎所有常见需求。
  4. 适合构建小型到中型应用和 API 服务： 其轻量级特性使其成为构建微服务或简单 Web API 的理想选择。
  5. 良好的文档和社区支持： Flask 拥有清晰的官方文档和活跃的社区，遇到问题很容易找到解决方案。

快速入门：你的第一个 Flask 应用

千里之行，始于足下。让我们从一个最简单的 Flask 应用开始。

1. 安装 Flask

确保你已经安装了 Python 和 pip。打开终端或命令行，执行以下命令：

bash
pip install Flask

2. 创建一个简单的应用文件

创建一个名为 app.py 的文件，输入以下代码：

“`python
from flask import Flask

创建一个 Flask 应用实例

name 是一个特殊的变量，Python 会根据当前文件是作为模块导入还是直接运行来设置它

Flask 使用这个参数来确定应用根目录，以便找到静态文件和模板文件等

app = Flask(name)

使用装饰器定义一个路由（URL 规则）

当用户访问根 URL (/) 时，将调用下面的 hello_world 函数

@app.route(‘/’)
def hello_world():
# 函数返回的内容将作为 HTTP 响应体发送给浏览器
return ‘Hello, World!’

确保当直接运行此文件时，启动开发服务器

if name == ‘main‘:
# app.run() 启动 Flask 内置的开发服务器
# debug=True 模式会在代码修改后自动重载服务器，并提供详细的调试信息
app.run(debug=True)
“`

3. 运行应用

在终端或命令行中，进入到存放 app.py 文件的目录，执行：

bash
python app.py

你会看到类似以下的输出：

* Serving Flask app "app" (lazy loading)
* Environment: development
* Debug mode: on
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
* Restarting with stat
* Debugger is active!
* Debugger PIN: XXX-XXX-XXX

打开你的浏览器，访问 http://127.0.0.1:5000/，你将看到页面上显示 “Hello, World!”。恭喜你，你的第一个 Flask 应用已经成功运行了！

Flask 核心概念详解

接下来，我们将深入探讨 Flask 的几个核心概念，它们是构建任何 Flask 应用的基础。

1. 路由 (Routing)

路由是将特定的 URL 映射到处理该 URL 的函数（称为视图函数）的过程。在 Flask 中，我们使用 @app.route() 装饰器来定义路由。

基本用法：

“`python
@app.route(‘/about’)
def about():
return ‘这是关于页面’

@app.route(‘/contact’)
def contact():
return ‘这是联系页面’
“`

HTTP 方法：

Web 应用不仅处理 GET 请求（获取资源），还需要处理 POST（提交数据）、PUT（更新资源）、DELETE（删除资源）等请求。可以使用 methods 参数指定视图函数支持的 HTTP 方法：

“`python
from flask import request # 需要导入 request 对象

@app.route(‘/login’, methods=[‘GET’, ‘POST’])
def login():
if request.method == ‘POST’:
# 处理 POST 请求，例如从表单中获取用户名和密码
username = request.form.get(‘username’)
password = request.form.get(‘password’)
# 这里通常会进行用户认证逻辑
return f’POST 请求：用户名 {username}，密码 {password}’
else:
# 处理 GET 请求，通常是显示登录表单
return ”’

用户名:
密码:

”’
“`

变量规则：

路由中可以包含变量部分，用于捕获 URL 中的动态信息。变量部分用 <variable_name> 表示。

“`python
@app.route(‘/user/‘)
def show_user_profile(username):
# username 将作为参数传递给函数
return f’用户个人主页: {username}’

@app.route(‘/post/‘)
def show_post(post_id):
# 表示捕获一个整数，并将其命名为 post_id
# Flask 支持多种类型转换器：string, int, float, path (包含斜杠), uuid
return f’文章 ID: {post_id}’
“`

2. 请求对象 (Request Object)

在视图函数内部，你可以通过导入 request 对象来访问客户端发送的请求信息。request 是一个全局对象，但它实际上是线程局部（或协程局部）的，这意味着每个请求处理线程都会有自己的 request 对象，互相隔离。

常用的 request 属性和方法：

  • request.method: 请求的 HTTP 方法（GET, POST 等）。
  • request.args: URL 查询参数（GET 请求中的 ?key=value 部分），是一个 MultiDict 对象。可以通过 request.args.get('key') 获取值。
  • request.form: 表单提交的数据（POST 请求中的表单数据），也是一个 MultiDict 对象。通过 request.form.get('fieldname') 获取值。
  • request.json: 如果请求的 Content-Type 是 application/json，则解析 JSON 数据。
  • request.files: 上传的文件，是一个 MultiDict 对象，每个值是一个 FileStorage 对象。
  • request.cookies: 客户端发送的 Cookies。
  • request.headers: 请求头部信息。
  • request.remote_addr: 客户端 IP 地址。

示例（结合上面的登录例子）：

“`python
from flask import Flask, request

app = Flask(name)

@app.route(‘/login’, methods=[‘GET’, ‘POST’])
def login():
if request.method == ‘POST’:
username = request.form.get(‘username’)
password = request.form.get(‘password’)
# 检查用户名和密码…
return f’收到的用户名: {username}, 密码: {password}’
return ‘请通过 POST 方法提交登录信息’ # 简单的 GET 提示

if name == ‘main‘:
app.run(debug=True)
“`

3. 响应 (Response)

视图函数需要返回一个响应。最简单的响应是一个字符串，Flask 会将其作为响应体，并设置 Content-Type 为 text/html。

返回不同类型的内容：

  • HTML: 直接返回包含 HTML 标签的字符串。
  • JSON: 需要导入 jsonify 函数。

“`python
from flask import jsonify

@app.route(‘/data’)
def get_data():
data = {‘name’: ‘Flask’, ‘type’: ‘microframework’}
return jsonify(data) # 将 Python 字典或列表转换为 JSON 响应
“`

  • 重定向 (Redirect): 使用 redirect 函数将用户发送到另一个 URL。

“`python
from flask import redirect, url_for # url_for 用于动态生成 URL

@app.route(‘/old-url’)
def old_url():
# 将用户重定向到新的 URL
return redirect(url_for(‘new_url’)) # url_for(‘new_url’) 会查找名为 new_url 的视图函数对应的 URL

@app.route(‘/new-url’)
def new_url():
return ‘你被重定向到了新页面’
``url_for是一个非常有用的函数，它可以根据视图函数的名称动态生成 URL。这样做的好处是，如果将来修改了 URL 规则，只需要修改@app.route()` 装饰器，而不需要在代码中查找所有硬编码的 URL 链接。

  • 错误响应 (Error Responses): 使用 abort 函数可以立即停止请求处理，并返回一个特定的 HTTP 错误码。

“`python
from flask import abort

@app.route(‘/require-auth’)
def require_auth():
# 假设这里检查用户是否已认证
is_authenticated = False # 示例：用户未认证
if not is_authenticated:
abort(401) # 返回 401 Unauthorized 错误
return ‘需要认证才能访问的内容’

你也可以定义错误处理函数来定制错误页面的内容

@app.errorhandler(401)
def unauthorized_handler(error):
return ‘

自定义 401 错误页面：你没有访问权限！

‘, 401 # 返回响应体和状态码
“`

4. 模板 (Templates)

在 Web 应用中，通常需要生成包含动态数据的 HTML 页面。直接在 Python 代码中拼接大量 HTML 字符串非常不便且难以维护。模板引擎就是用来解决这个问题的。Flask 默认使用 Jinja2 模板引擎。

基本用法：

  1. 在你的 Flask 应用根目录（与 app.py 同级）创建一个名为 templates 的文件夹。
  2. 在 templates 文件夹中创建 HTML 文件（例如 index.html）。
  3. 在视图函数中使用 render_template 函数渲染模板。

templates/index.html:

“`html




{{ title }} {# 双大括号用于显示变量的值 #}

你好，{{ name }}！

{# 这里的 name 将由 Flask 视图函数传递 #}

用户列表：

    {% for user in users %} {# 大括号百分号用于控制结构，如循环 #}

  • {{ user }}

    • {% endfor %} {# 结束循环 #}

{% if show_message %} {# 条件判断 #}

这是一条根据条件显示的消息。

{% endif %} {# 结束条件判断 #}

{# 单大括号百分号井号用于注释 #}

“`

app.py:

“`python
from flask import Flask, render_template # 导入 render_template

app = Flask(name)

@app.route(‘/’)
def index():
# 定义要传递给模板的数据
page_title = ‘主页’
user_name = ‘访客’
user_list = [‘Alice’, ‘Bob’, ‘Charlie’]
show = True

# 渲染 index.html 模板，并将数据传递进去
# 模板中的 {{ title }} 将被 page_title 的值替换
# {{ name }} 被 user_name 替换
# {{ users }} 被 user_list 替换 (在模板中迭代显示)
# {{ show_message }} 被 show 替换 (用于条件判断)
return render_template(
    'index.html',
    title=page_title,
    name=user_name,
    users=user_list,
    show_message=show
)

if name == ‘main‘:
app.run(debug=True)
“`

运行应用并访问根目录，你将看到根据 index.html 模板和传递的数据生成的页面。

模板继承 (Template Inheritance):

对于大型网站，许多页面有共同的结构（如导航栏、页脚）。模板继承允许你定义一个基础模板（父模板），然后其他模板（子模板）可以继承它，只覆盖或添加特定的部分。

templates/base.html (父模板):

“`html




{% block title %}{% endblock %} – 我的网站 {# 链接到静态文件 #}

我的网站头部


{% block content %}{% endblock %} {# 定义一个内容块，子模板可以填充 #}

© 2023 我的网站


“`

templates/about.html (子模板):

“`html
{% extends ‘base.html’ %} {# 继承 base.html #}

{% block title %}关于我们{% endblock %} {# 填充 title 块 #}

{% block content %} {# 填充 content 块 #}

关于我们页面

这里是关于网站的介绍。

{% endblock %}
“`

在 app.py 中，你需要一个处理 /about 路由的视图函数来渲染 about.html：

“`python

… 其他代码 …

@app.route(‘/about’)
def about():
return render_template(‘about.html’)

… main 部分 …

“`

这样，about.html 将会继承 base.html 的结构，并在 block title 和 block content 的位置显示自己的内容。

5. 静态文件 (Static Files)

Web 应用通常需要提供静态文件，如 CSS 样式表、JavaScript 脚本、图片等。Flask 约定在应用根目录（与 app.py 同级）创建一个名为 static 的文件夹来存放这些文件。

在模板中，使用 url_for('static', filename='path/to/file') 来生成静态文件的 URL。

例如，如果你有一个 static/css/style.css 文件，在模板中可以这样引用：

html
<link rel="stylesheet" href="{{ url_for('static', filename='css/style.css') }}">

扩展 Flask 的功能

Flask 的强大之处在于其丰富的扩展生态。当你的应用需要数据库、用户认证、表单处理、RESTful API 等功能时，通常会使用相应的 Flask 扩展。

常见的 Flask 扩展：

  • Flask-SQLAlchemy: 集成 SQLAlchemy ORM，简化数据库操作。
  • Flask-WTF: 集成 WTForms，方便创建和验证 Web 表单。
  • Flask-Login: 提供用户会话管理、登录、注销和记住我功能。
  • Flask-Migrate: 基于 Alembic 的数据库迁移工具。
  • Flask-Mail: 发送电子邮件。
  • Flask-RESTful / Flask-RESTPlus (or Flask-Smorest): 简化构建 RESTful API。
  • Flask-Marshmallow: 与 Marshmallow 集成，用于对象的序列化和反序列化。

使用扩展的一般步骤：

  1. 使用 pip 安装扩展（例如 pip install Flask-SQLAlchemy）。
  2. 在代码中导入并初始化扩展，通常需要将 Flask 应用实例传递给扩展。
  3. 按照扩展的文档使用其提供的功能。

例如，使用 Flask-SQLAlchemy 连接数据库：

“`python
from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(name)

配置数据库连接字符串 (这里使用 SQLite)

app.config[‘SQLALCHEMY_DATABASE_URI’] = ‘sqlite:///site.db’
app.config[‘SQLALCHEMY_TRACK_MODIFICATIONS’] = False # 禁用修改追踪，节省资源
db = SQLAlchemy(app) # 初始化扩展

定义一个简单的模型 (数据库表)

class User(db.Model):
id = db.Column(db.Integer, primary_key=True)
username = db.Column(db.String(80), unique=True, nullable=False)
email = db.Column(db.String(120), unique=True, nullable=False)

def __repr__(self):
    return f'<User {self.username}>'

在应用上下文中使用数据库 (例如创建表)

with app.app_context():
db.create_all() # 创建数据库表 (如果不存在)

@app.route(‘/add_user//‘)
def add_user(username, email):
new_user = User(username=username, email=email)
db.session.add(new_user)
db.session.commit()
return f’用户 {username} 添加成功！’

@app.route(‘/users’)
def list_users():
users = User.query.all() # 查询所有用户
user_list = [user.username for user in users]
return ‘所有用户: ‘ + ‘, ‘.join(user_list)

if name == ‘main‘:
app.run(debug=True)
``
运行此应用，访问/add_user/testuser/[email protected]添加一个用户，然后访问/users` 查看用户列表。这个例子展示了如何通过扩展轻松集成数据库功能。

Flask 项目结构（简单示例）

对于更复杂的项目，将所有代码放在一个文件里会变得难以管理。一个简单的项目结构通常会按功能或模块划分：

your_project/
├── venv/ # Python 虚拟环境
├── app.py # 主应用入口文件 (或 __init__.py)
├── config.py # 配置文件 (数据库连接, 秘钥等)
├── requirements.txt # 项目依赖列表
├── static/ # 静态文件 (css, js, images)
│ ├── css/
│ ├── js/
│ └── images/
└── templates/ # HTML 模板文件
├── base.html
├── index.html
└── ...

对于更大型的项目，可以使用 Flask 的 Blueprint 功能来组织不同的功能模块（如用户模块、文章模块等），每个模块有自己的路由和视图函数，然后将这些蓝图注册到主应用上。

Flask vs. Django：如何选择？

这是一个常见的问题。简单来说：

  • 选择 Flask 当：
    • 项目规模较小，需求简单。
    • 开发 API 服务或微服务。
    • 你希望对框架有更多控制权，喜欢自由选择工具。
    • 你正在学习 Web 开发基础，Flask 的概念更直接。
    • 需要极高的灵活性，可能需要集成一些非标准的库。
  • 选择 Django 当：
    • 项目规模较大，功能复杂（如需要用户认证、管理后台、国际化等）。
    • 希望快速构建一个功能“全”的应用（尤其是有数据库交互的）。
    • 偏好“约定优于配置”的开发模式。
    • 需要一个成熟、稳定的框架，拥有强大的社区和完整的生态系统。

Flask 更像是一把瑞士军刀，提供了锋利的刀刃（核心功能），你可以根据需要添加其他工具（扩展）。Django 更像是一个工具箱，里面已经包含了大部分你可能用到的工具，你只需要学习如何使用它们。

总结

通过本文，我们详细介绍了 Flask 框架的核心概念：

  • 它是一个微框架，核心简洁，高度灵活。
  • 通过 pip install Flask 轻松安装。
  • 使用 @app.route 定义路由，将 URL 映射到视图函数。
  • 通过 request 对象访问客户端请求数据。
  • 视图函数返回响应（字符串、JSON、重定向、错误）。
  • 使用 Jinja2 模板 (render_template) 渲染动态 HTML 页面。
  • 在 static 文件夹中组织和提供静态文件。
  • 通过丰富的扩展来增强功能（数据库、表单、认证等）。
  • 项目可以通过结构化和 Blueprint 来组织代码。

Flask 因其简洁优雅的设计，成为了许多 Python 开发者构建 Web 应用和 API 的首选。掌握了这些核心概念，你就已经迈入了 Flask 开发的大门。接下来，最重要的是动手实践，尝试构建自己的应用，并在需要时查阅 Flask 官方文档和各种扩展的文档。

希望这篇“一文搞懂 Flask 框架”的文章为你提供了一个清晰、全面的指南。祝你在 Flask 的世界里开发愉快！

发表评论

您的邮箱地址不会被公开。 必填项已用 * 标注

滚动至顶部