使用 Flask 构建 Web 应用程序:完整实战教程
wptr33 2025-04-24 09:21 19 浏览
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 应用程序,并使用一些流行的扩展来扩展应用程序的功能。如果您有任何疑问或建议,请随时在评论中留言,我会尽力回答您的问题。
每天坚持学习一点点,不求有回报,只愿可以丰富自己!!!
相关推荐
- redis的八种使用场景
-
前言:redis是我们工作开发中,经常要打交道的,下面对redis的使用场景做总结介绍也是对redis举报的功能做梳理。缓存Redis最常见的用途是作为缓存,用于加速应用程序的响应速度。...
- 基于Redis的3种分布式ID生成策略
-
在分布式系统设计中,全局唯一ID是一个基础而关键的组件。随着业务规模扩大和系统架构向微服务演进,传统的单机自增ID已无法满足需求。高并发、高可用的分布式ID生成方案成为构建可靠分布式系统的必要条件。R...
- 基于OpenWrt系统路由器的模式切换与网页设计
-
摘要:目前商用WiFi路由器已应用到多个领域,商家通过给用户提供一个稳定免费WiFi热点达到吸引客户、提升服务的目标。传统路由器自带的Luci界面提供了工厂模式的Web界面,用户可通过该界面配置路...
- 这篇文章教你看明白 nginx-ingress 控制器
-
主机nginx一般nginx做主机反向代理(网关)有以下配置...
- 如何用redis实现注册中心
-
一句话总结使用Redis实现注册中心:服务注册...
- 爱可可老师24小时热门分享(2020.5.10)
-
No1.看自己以前写的代码是种什么体验?No2.DooM-chip!国外网友SylvainLefebvre自制的无CPU、无操作码、无指令计数器...No3.我认为CS学位可以更好,如...
- Apportable:拯救程序员,IOS一秒变安卓
-
摘要:还在为了跨平台使用cocos2d-x吗,拯救objc程序员的奇葩来了,ApportableSDK:FreeAndroidsupportforcocos2d-iPhone。App...
- JAVA实现超买超卖方案汇总,那个最适合你,一篇文章彻底讲透
-
以下是几种Java实现超买超卖问题的核心解决方案及代码示例,针对高并发场景下的库存扣减问题:方案一:Redis原子操作+Lua脚本(推荐)//使用Redis+Lua保证原子性publicbo...
- 3月26日更新 快速施法自动施法可独立设置
-
2016年3月26日DOTA2有一个79.6MB的更新主要是针对自动施法和快速施法的调整本来内容不多不少朋友都有自动施法和快速施法的困扰英文更新日志一些视觉BUG修复就不翻译了主要翻译自动施...
- Redis 是如何提供服务的
-
在刚刚接触Redis的时候,最想要知道的是一个’setnameJhon’命令到达Redis服务器的时候,它是如何返回’OK’的?里面命令处理的流程如何,具体细节怎么样?你一定有问过自己...
- lua _G、_VERSION使用
-
到这里我们已经把lua基础库中的函数介绍完了,除了函数外基础库中还有两个常量,一个是_G,另一个是_VERSION。_G是基础库本身,指向自己,这个变量很有意思,可以无限引用自己,最后得到的还是自己,...
- China's top diplomat to chair third China-Pacific Island countries foreign ministers' meeting
-
BEIJING,May21(Xinhua)--ChineseForeignMinisterWangYi,alsoamemberofthePoliticalBureau...
- 移动工作交流工具Lua推出Insights数据分析产品
-
Lua是一个适用于各种职业人士的移动交流平台,它在今天推出了一项叫做Insights的全新功能。Insights是一个数据平台,客户可以在上面实时看到员工之间的交流情况,并分析这些情况对公司发展的影响...
- Redis 7新武器:用Redis Stack实现向量搜索的极限压测
-
当传统关系型数据库还在为向量相似度搜索的性能挣扎时,Redis7的RedisStack...
- Nginx/OpenResty详解,Nginx Lua编程,重定向与内部子请求
-
重定向与内部子请求Nginx的rewrite指令不仅可以在Nginx内部的server、location之间进行跳转,还可以进行外部链接的重定向。通过ngx_lua模块的Lua函数除了能实现Nginx...
- 一周热门
-
-
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)
- 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)
- c语言 switch (34)
- git commit (34)