使用 Flask 构建 Web 应用程序:完整实战教程
wptr33 2025-04-24 09:21 7 浏览
Flask 是一个用 Python 编写的 Web 应用程序框架。它被设计成灵活和易于扩展,让开发人员能够快速构建出高性能的 Web 应用程序。在这里,我们将介绍如何使用 Flask 构建一个完整的 Web 应用程序,包括使用 Flask-RESTful 构建 RESTful API、使用 Flask-SQLAlchemy 进行数据库操作、使用 Flask-wtf 进行表单验证和使用 Flask-JWT 进行身份认证和授权。
1. 使用 Flask 构建 Web 应用程序
首先,我们需要安装 Flask。可以使用 pip 命令进行安装:
pip install flask
在我们开始构建应用程序之前,我们需要导入 Flask:
from flask import Flask
接下来,我们需要创建一个 Flask 应用程序实例:
app = Flask(__name__)
现在我们可以开始定义路由了。路由是 Web 应用程序中用于处理 HTTP 请求的函数。我们可以使用 @app.route() 装饰器来定义路由:
@app.route('/')
def hello_world():
return 'Hello, World!'
在这个例子中,我们定义了一个路由 /,当用户访问这个路由时,hello_world 函数会被调用,然后它会返回一个字符串 Hello, World!。我们可以通过运行以下命令来启动这个应用程序:
if __name__ == '__main__':
app.run()
这个命令会启动一个本地服务器,并且会监听 http://127.0.0.1:5000/ 这个地址。现在,如果我们在浏览器中访问这个地址,我们就可以看到 Hello, World! 这个字符串了。
2. 使用 Flask-RESTful 构建 RESTful API
Flask-RESTful 是一个为 Flask 提供 RESTful API 支持的扩展。它可以让我们更轻松地构建出符合 RESTful API 规范的 API。
我们可以使用 pip 命令进行安装:
pip install flask-restful
在使用 Flask-RESTful 之前,我们需要先导入它:
from flask_restful import Resource, Api
然后,我们需要创建一个 API 实例:
api = Api(app)
现在我们可以开始定义 RESTful API 了。我们可以通过继承 Resource 类来定义一个资源,然后将这个资源注册到 API 实例中。
class HelloWorld(Resource):
def get(self):
return {'hello': 'world'}
api.add_resource(HelloWorld, '/hello')
在这个例子中,我们定义了一个名为 HelloWorld 的资源,它支持 GET 请求,并且返回一个 JSON 格式的数据 {'hello': 'world'}。我们可以通过访问 /hello 这个路由来获取这个数据。
3. 使用 Flask-SQLAlchemy 进行数据库操作
Flask-SQLAlchemy 是一个为 Flask 提供 SQL 数据库支持的扩展。它可以让我们更轻松地使用 SQL 数据库进行数据存储和查询。
我们可以使用 pip 命令进行安装:
pip install flask-sqlalchemy
在使用 Flask-SQLAlchemy 之前,我们需要先导入它:
from flask_sqlalchemy import SQLAlchemy
然后,我们需要创建一个 SQLAlchemy 实例:
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///example.db'
db = SQLAlchemy(app)
在这个例子中,我们配置了一个 SQLite 数据库,文件名为 example.db。
现在我们可以开始定义模型了。模型是指数据库中的表结构,它用于存储数据和进行查询。我们可以通过继承 db.Model 类来定义一个模型。
class User(db.Model):
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String(80), nullable=False)
email = db.Column(db.String(120), nullable=False, unique=True)
在这个例子中,我们定义了一个名为 User 的模型,它有一个 id 字段、一个 name 字段和一个 email 字段。id 字段是主键,并且它是一个自增的整数。name 字段和 email 字段分别是一个字符串类型,长度分别为 80 和 120,它们都不能为空,并且 email 字段必须是唯一的。
现在我们可以通过这个模型来进行数据操作了。例如,我们可以通过以下代码来添加一个新的用户:
user = User(name='John', email='john@example.com')
db.session.add(user)
db.session.commit()
这个代码会创建一个名为 John 的用户,并将它保存到数据库中。
4. 使用 Flask-WTF 进行表单验证
Flask-wtf 是一个为 Flask 提供表单验证支持的扩展。它可以让我们更轻松地进行表单验证和错误处理。
我们可以使用 pip 命令进行安装:
pip install flask-wtf
在使用 Flask-wtf 之前,我们需要先导入它:
from flask_wtf import FlaskForm
from wtforms import StringField, SubmitField
from wtforms.validators import DataRequired
然后,我们需要创建一个表单类:
class LoginForm(FlaskForm):
username = StringField('Username', validators=[DataRequired()])
password = StringField('Password', validators=[DataRequired()])
submit = SubmitField('Login')
在这个例子中,我们定义了一个名为 LoginForm 的表单类,它有一个 username 字段、一个 password 字段和一个 submit 字段。username 字段和 password 字段都是字符串类型,并且不能为空。submit 字段是一个提交按钮。
现在我们可以在路由函数中使用这个表单了:
@app.route('/login', methods=['GET', 'POST'])
def login():
form = LoginForm()
if form.validate_on_submit():
# 处理表单提交的数据
username = form.username.data
password = form.password.data
# 进行身份认证
if authenticate(username, password):
# 如果认证成功,将用户保存到 session 中
session['username'] = username
# 跳转到首页
return redirect(url_for('index'))
else:
# 如果认证失败,显示错误信息
flash('Invalid username or password')
# 渲染表单页面
return render_template('login.html', form=form)
在这个例子中,我们定义了一个名为 login 的路由函数,它处理 GET 和 POST 请求。在 GET 请求中,它渲染一个名为 login.html 的模板,并将 LoginForm 类传递给模板。在 POST 请求中,它首先验证表单数据是否合法,如果合法,则进行身份认证,如果认证成功,则将用户保存到 session 中,并跳转到首页;如果认证失败,则显示错误信息。
5. 使用 Flask-JWT 进行身份认证和授权
Flask-JWT 是一个为 Flask 提供身份认证和授权支持的扩展。它可以让我们更轻松地进行用户认证和权限控制。
我们可以使用 pip 命令进行安装:
pip install flask-jwt
在使用 Flask-JWT 之前,我们需要先导入它:
from flask_jwt import JWT, jwt_required, current_identity
from werkzeug.security import safe_str_cmp
然后,我们需要定义一个认证函数和一个回调函数:
def authenticate(username, password):
user = User.query.filter_by(username=username).first()
if user and safe_str_cmp(user.password.encode('utf-8'), password.encode('utf-8')):
return user
def identity(payload):
user_id = payload['identity']
return User.query.get(user_id)
在这个例子中,我们定义了一个名为 authenticate 的认证函数和一个名为 identity 的回调函数。认证函数接收一个用户名和密码,然后在数据库中查找用户,如果用户存在并且密码正确,则返回该用户;否则返回 None。回调函数接收一个 JWT 载荷,然后根据载荷中的用户 ID 查找用户,并返回该用户。
现在我们可以使用这些函数来配置 JWT:
app.config['JWT_SECRET_KEY'] = 'secret'
jwt = JWT(app, authenticate, identity)
在这个例子中,我们配置了一个 JWT 密钥,然后创建了一个 JWT 实例。
现在我们可以在路由函数中使用 jwt_required 装饰器来限制访问权限:
@app.route('/protected')
@jwt_required()
def protected():
return f'Hello, {current_identity.username}!'
在这个例子中,我们定义了一个名为 protected 的路由函数,并使用 jwt_required 装饰器限制了访问权限。如果用户未登录或者 JWT 验证失败,则会返回一个错误响应;如果验证成功,则可以在函数中访问 current_identity 对象来获取当前用户的信息。
完整的代码示例:
from flask import Flask, jsonify, request
from flask_sqlalchemy import SQLAlchemy
from flask_wtf import FlaskForm
from wtforms import StringField, PasswordField, SubmitField
from wtforms.validators import DataRequired
from werkzeug.security import generate_password_hash, check_password_hash
from flask_jwt import JWT, jwt_required, current_identity
from datetime import timedelta
app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///example.db'
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
app.config['SECRET_KEY'] = 'secret'
app.config['JWT_AUTH_URL_RULE'] = '/login'
app.config['JWT_EXPIRATION_DELTA'] = timedelta(hours=1)
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)
password = db.Column(db.String(120), nullable=False)
class LoginForm(FlaskForm):
username = StringField('Username', validators=[DataRequired()])
password = PasswordField('Password', validators=[DataRequired()])
submit = SubmitField('Log In')
def authenticate(username, password):
user = User.query.filter_by(username=username).first()
if user and check_password_hash(user.password, password):
return user
def identity(payload):
user_id = payload['identity']
return User.query.get(user_id)
app.config['JWT_SECRET_KEY'] = 'secret'
jwt = JWT(app, authenticate, identity)
@app.route('/')
def index():
return 'Hello, World!'
@app.route('/protected')
@jwt_required()
def protected():
return f'Hello, {current_identity.username}!'
@app.route('/users', methods=['GET'])
@jwt_required()
def get_users():
users = User.query.all()
return jsonify([{'id': user.id, 'username': user.username} for user in users])
@app.route('/users', methods=['POST'])
def create_user():
data = request.get_json()
username = data.get('username')
password = data.get('password')
if not username or not password:
return jsonify({'error': 'username and password are required'}), 400
user = User.query.filter_by(username=username).first()
if user:
return jsonify({'error': 'username already exists'}), 400
user = User(username=username, password=generate_password_hash(password))
db.session.add(user)
db.session.commit()
return jsonify({'id': user.id, 'username': user.username}), 201
if __name__ == '__main__':
app.run(debug=True)
在这个例子中,我们定义了一个名为 User 的模型类,并在数据库中创建了一个名为 example.db 的 SQLite 数据库。我们还定义了一个名为 LoginForm 的表单类,用于验证用户登录表单的数据。
我们使用 Flask-JWT 实现了身份认证和授权功能,使用了 jwt_required 装饰器来限制访问权限。我们还实现了两个 API:/users 和 /protected。/users API 支持 GET 和 POST 方法,用于获取所有用户信息和创建新用户。/protected API 仅支持 GET 方法,用于演示如何使用 JWT 认证和授权功能保护 API。
在我们的应用程序中,我们使用 Flask-SQLAlchemy 进行数据库操作,使用 Flask-wtf 进行表单验证。这些扩展都是 Flask 生态系统中非常流行的扩展,可以让我们轻松地创建和操作 Web 应用程序。
值得注意的是,我们在应用程序中使用了 Flask-JWT 进行身份认证和授权,JWT 是一种轻量级的身份验证和授权方案,可以很容易地实现基于 token 的身份验证和授权。在我们的应用程序中,我们使用 JWT 生成 token,并使用 jwt_required 装饰器限制了访问权限。在实际的应用程序中,您可以根据需要调整 JWT 的配置,并根据实际需求来限制访问权限。
在编写 Flask 应用程序时,您还可以使用其他的 Flask 扩展来扩展应用程序的功能。例如,您可以使用 Flask-Mail 扩展来发送电子邮件,使用 Flask-Admin 扩展来创建管理员界面等等。在选择扩展时,建议选择流行度较高、维护活跃的扩展,并根据实际需求进行选择。
希望这个示例可以帮助您更好地理解如何使用 Flask 构建 Web 应用程序,并使用一些流行的扩展来扩展应用程序的功能。如果您有任何疑问或建议,请随时在评论中留言,我会尽力回答您的问题。
每天坚持学习一点点,不求有回报,只愿可以丰富自己!!!
相关推荐
- Linux高性能服务器设计
-
C10K和C10M计算机领域的很多技术都是需求推动的,上世纪90年代,由于互联网的飞速发展,网络服务器无法支撑快速增长的用户规模。1999年,DanKegel提出了著名的C10问题:一台服务器上同时...
- 独立游戏开发者常犯的十大错误
-
...
- 学C了一头雾水该咋办?
-
学C了一头雾水该怎么办?最简单的方法就是你再学一遍呗。俗话说熟能生巧,铁杵也能磨成针。但是一味的为学而学,这个好像没什么卵用。为什么学了还是一头雾水,重点就在这,找出为什么会这个样子?1、概念理解不深...
- C++基础语法梳理:inline 内联函数!虚函数可以是内联函数吗?
-
上节我们分析了C++基础语法的const,static以及this指针,那么这节内容我们来看一下inline内联函数吧!inline内联函数...
- C语言实战小游戏:井字棋(三子棋)大战!文内含有源码
-
井字棋是黑白棋的一种。井字棋是一种民间传统游戏,又叫九宫棋、圈圈叉叉、一条龙、三子旗等。将正方形对角线连起来,相对两边依次摆上三个双方棋子,只要将自己的三个棋子走成一条线,对方就算输了。但是,有很多时...
- C++语言到底是不是C语言的超集之一
-
C与C++两个关系亲密的编程语言,它们本质上是两中语言,只是C++语言设计时要求尽可能的兼容C语言特性,因此C语言中99%以上的功能都可以使用C++完成。本文探讨那些存在于C语言中的特性,但是在C++...
- 在C++中,如何避免出现Bug?
-
C++中的主要问题之一是存在大量行为未定义或对程序员来说意外的构造。我们在使用静态分析器检查各种项目时经常会遇到这些问题。但正如我们所知,最佳做法是在编译阶段尽早检测错误。让我们来看看现代C++中的一...
- ESL-通过事件控制FreeSWITCH
-
通过事件提供的最底层控制机制,允许我们有效地利用工具箱,适时选择使用其中的单个工具。FreeSWITCH是一个核心交换与混合矩阵,它周围有几十个模块提供各种功能特性。我们完全控制了所有的即时信息,这些...
- 物理老师教你学C++语言(中篇)
-
一、条件语句与实验判断...
- C语言入门指南
-
当然!以下是关于C语言入门编程的基础介绍和入门建议,希望能帮你顺利起步:C语言入门指南...
- C++选择结构,让程序自动进行决策
-
什么是选择结构?正常的程序都是从上至下顺序执行,这就是顺序结构...
- C++特性使用建议
-
1.引用参数使用引用替代指针且所有不变的引用参数必须加上const。在C语言中,如果函数需要修改变量的值,参数必须为指针,如...
- C++程序员学习Zig指南(中篇)
-
1.复合数据类型结构体与方法的对比C++类:...
- 研一自学C++啃得动吗?
-
研一自学C++啃得动吗?在开始前我有一些资料,是我根据网友给的问题精心整理了一份「C++的资料从专业入门到高级教程」,点个关注在评论区回复“888”之后私信回复“888”,全部无偿共享给大家!!!个人...
- C++关键字介绍
-
下表列出了C++中的常用关键字,这些关键字不能作为变量名或其他标识符名称。1、autoC++11的auto用于表示变量的自动类型推断。即在声明变量的时候,根据变量初始值的类型自动为此变量选择匹配的...
- 一周热门
-
-
C# 13 和 .NET 9 全知道 :13 使用 ASP.NET Core 构建网站 (1)
-
因果推断Matching方式实现代码 因果推断模型
-
git pull命令使用实例 git pull--rebase
-
git pull 和git fetch 命令分别有什么作用?二者有什么区别?
-
面试官:git pull是哪两个指令的组合?
-
git 执行pull错误如何撤销 git pull fail
-
git fetch 和git pull 的异同 git中fetch和pull的区别
-
git pull 之后本地代码被覆盖 解决方案
-
还可以这样玩?Git基本原理及各种骚操作,涨知识了
-
git命令之pull git.pull
-
- 最近发表
- 标签列表
-
- git pull (33)
- git fetch (35)
- mysql insert (35)
- mysql distinct (37)
- concat_ws (36)
- java continue (36)
- jenkins官网 (37)
- mysql 子查询 (37)
- python元组 (33)
- mysql max (33)
- vba instr (33)
- mybatis 分页 (35)
- vba split (37)
- redis watch (34)
- python list sort (37)
- nvarchar2 (34)
- mysql not null (36)
- hmset (35)
- python telnet (35)
- python readlines() 方法 (36)
- munmap (35)
- docker network create (35)
- redis 集合 (37)
- python sftp (37)
- setpriority (34)