Flask入门(路由和http请求)
Flask入门(路由和http请求)
Flask诞生于2010年,是Armin ronacher(人名)用 Python 语言基于 Werkzeug 工具箱编写的轻量级Web开发框架。
Flask 本身相当于一个内核,其他几乎所有的功能都要用到扩展(邮件扩展Flask-Mail,用户认证Flask-Login,数据库Flask-SQLAlchemy),都需要用第三方的扩展来实现。比如可以用 Flask 扩展加入ORM、窗体验证工具,文件上传、身份验证等。Flask 没有默认使用的数据库,你可以选择 MySQL,也可以用 NoSQL。
其 WSGI 工具箱采用 Werkzeug(路由模块),模板引擎则使用 Jinja2。这两个也是 Flask 框架的核心。
官网: https://palletsprojects.com/p/flask/
官方文档: http://docs.jinkan.org/docs/flask/
https://flask.palletsprojects.com/en/1.1.x/
Flask常用扩展包:
- Flask-SQLalchemy:操作数据库,ORM;
- Flask-script:终端脚本工具,脚手架;
- Flask-migrate:管理迁移数据库;
- Flask-Session:Session存储方式指定;
- Flask-WTF:表单;
- Flask-Mail:邮件;
- Flask-Bable:提供国际化和本地化支持,翻译;
- Flask-Login:认证用户状态;
- Flask-OpenID:认证, OAuth;
- Flask-RESTful:开发REST API的工具;
- Flask JSON-RPC: 开发rpc远程服务[过程]调用
- Flask-Bootstrap:集成前端Twitter Bootstrap框架
- Flask-Moment:本地化日期和时间
- Flask-Admin:简单而可扩展的管理接口的框架
可以通过 http://flask.pocoo.org/extensions/ 查看更多flask官方推荐的扩展
安装
pip install flask -i https://pypi.douban.com/simple/
创建flask项目
与django不同,flask不会提供任何的自动操作,所以需要手动创建项目目录, 需要手动创建启动项目的管理文件
快速入门
from flask import Flask
app = Flask(__name__)
@app.route("/")
def index():
return "hello world"
if __name__ == '__main__':
# debug = True
# 1.终端出现调试提示
# 2.修改了源代码以后会自动更新
app.run(host="0.0.0.0", port=8888, debug=True)
配置信息加载
# 导入Flask类
from flask import Flask
"""
import_name Flask程序所在的包(模块),传 __name__ 就可以
其可以决定 Flask 在访问静态文件时查找的路径
static_path 静态文件访问路径(不推荐使用,使用 static_url_path 代替)
static_url_path 静态文件访问路径,可以不传,默认为:/ + static_folder
static_folder 静态文件存储的文件夹,可以不传,默认为 static
template_folder 模板文件存储的文件夹,可以不传,默认为 templates
"""
app = Flask(__name__)
# 加载项目配置
# 配置类
class Config(object):
DEBUG = True
app.config.from_object( Config )
# 指定服务器IP和端口
app.run(host="0.0.0.0", port=5000)
路由的基本定义
from flask import Flask
app = Flask(__name__)
# 配置类
class Config():
DEBUG = True
# 加载配置类
app.config.from_object(Config)
# methods 可以设置当前视图只能通过指定的http请求来访问视图,可以设置多个,默认值为“get”
# @app.route("/ok", methods=["get", "post"])
@app.route("/ok", methods=["get"])
def index():
return "ok"
if __name__ == '__main__':
app.run()
路由设置传递参数
from flask import Flask
app = Flask(__name__)
# 默认路由可以接收参数,参数必须在路由中通过<参数名>进行设置
# 一旦在路由中设置了参数,则视图的形参括号中必须填写同名的变量来接收参数值
# 在视图函数中接收参数,按名字接收,不是按顺序
# 默认情况下,参数的值是不限定类型的,可以任意传参,参数之间默认使用"/"隔开
@app.route("/<user_id>/<name>", methods=["get"])
def index(user_id, name):
return f"user_id={user_id}, name={name}"
if __name__ == '__main__':
app.run(debug=True)
路由限定数据类型
from flask import Flask
app = Flask(__name__)
# 可以在路由中,通过在参数名左边设置":"隔开,设置参数的类型或者规则
# <int:user_id> 表示设置一个参数名为user_id,数据类型规则是只能传递整型数据
# <float:user_id> 设置浮点参数
@app.route("/<int:user_id>/<name>", methods=["get"])
def index(user_id, name):
return f"user_id={user_id}, name={name}"
if __name__ == '__main__':
app.run(debug=True)
系统自带转换器
上面我们在路由中使用":"限定参数的变量名,int或者float 这些,在flask中被称之为";路由转换器",默认情况,flask提供了以下几种转换器.
werkzeug/routing.py
DEFAULT_CONVERTERS = {
"default": UnicodeConverter,
"string": UnicodeConverter,
"any": AnyConverter,
"path": PathConverter, # string类型,不支持"/",而path允许参数的值里面有"/"
"int": IntegerConverter,
"float": FloatConverter,
"uuid": UUIDConverter, # 通用唯一识别码,居于微秒
}
系统自带的转换器具体使用方式在每种转换器的注释代码中有写,请留意每种转换器初始化的参数
系统自带的路由转换器,终归提供的帮助优先,针对手机号码,身份证,邮箱地址这一些数据,如果想在路由中进行限定,则flask是无法满足的.所以flask这边提供了允许我们自定义路由转换器来实现正则匹配路由.
自定义路由转换器-实现手机号码的限定
from flask import Flask
app = Flask(__name__)
# 基本转换器基类
from werkzeug.routing import BaseConverter
# 继承基类,声明对应的规则
class MobileConverter(BaseConverter):
regex = "1[3-9]\d{9}"
# 把自定义的转换器加载到flask中注册
app.url_map.converters["mobile"] = MobileConverter
@app.route("/<mobile:mo>")
def index(mo):
return f"mo={mo}"
if __name__ == '__main__':
app.run(debug=True)
正则匹配路由
在 web 开发中,可能会出现限制用户访问规则的场景,那么这个时候就需要用到正则匹配,根据自己的规则去限定请求参数再进行访问
具体实现步骤为:
- 导入转换器基类:在 Flask 中,所有的路由的匹配规则都是使用转换器对象进行记录
- 自定义转换器:自定义类继承于转换器基类
- 添加转换器到默认的转换器字典中
- 使用自定义转换器实现自定义匹配规则
代码实现
from flask import Flask
app = Flask(__name__)
# 引入基类
from werkzeug.routing import BaseConverter
# 自定义正则路由转换器
class RegexConVerter(BaseConverter):
def __init__(self, map, *args):
BaseConverter.__init__(self, map)
self.regex = args[0]
# 注册到flask的路由转换器列表中
app.url_map.converters["re"] = RegexConVerter
# 在路由中调用转换器
@app.route("/<re('1[3-9]\d{9}'):mobile>")
def index(mobile):
return f"mobile={mobile}"
if __name__ == '__main__':
app.run(debug=True)
运行测试:http://127.0.0.1:5000/1311111111 ,如果访问的url不符合规则,会提示找不到页面
路由,本质就是一种映射关系。主要的作用就是把客户端的请求和服务端的视图/处理程序进行一对一的映射。
我们经常在框架或者项目中所说的路由,其实是一个程序,这个程序实现了路由分发的功能。flask中的路由就是一个类。
http的请求与响应
请求
文档: http://docs.jinkan.org/docs/flask/api.html#flask.request
- request:flask中代表当前请求的
request 对象
- 作用:在视图函数中取出本次请求数据
- 导入:
from flask import request
常用的属性如下:
属性 | 说明 | 类型 |
---|---|---|
data | 记录请求体的数据,并转换为字符串 | * |
form | 记录请求中的表单数据 | MultiDict |
args | 记录请求中的查询字符串 | MultiDict |
cookies | 记录请求中的cookie信息 | Dict |
headers | 记录请求中的请求头 | EnvironHeaders |
method | 记录请求使用的HTTP方法 | GET/POST |
url | 记录请求的URL地址 | string |
files | 记录请求上传的文件 | * |
json | 记录请求的json数据 | json |
关于上面的请求对象,声明为位置: from flask import Request以及父类 BaseRequest【werkzeug/wrappers/request.py】
接收客户端的请求体和表单数据或文件
from flask import Flask, request
app = Flask(__name__)
@app.route("/data", methods=["post", "put", "patch"])
def index():
# 接收客户端提交的数据[接收到的值是bytes类型数据]
# print(request.data) # b'{"username": "alex"}'
# 接收客户端提交的表单数据[只能接收文本数据]
print(request.form) # ImmutableMultiDict([('name', 'alex'), ('age', '22')])
# ImmutableMultiDict 是有序字典,本质上来说就是继承了OrderedDict from collections import OrderedDict
# 所以参数支持使用 get方式或者中括号来提取
print(request.form.get("age")) # 22
print(request.form["age"]) # 22
# 接收客户端上传的文件
print(request.files) # ImmutableMultiDict([('avatar', <FileStorage: 'lALPF8laHnXLkO7NAoDNBH0_1149_640.png' ('image/png')>)])
# 提取文件 FileStorage 是flask中的文件存储对象,里面提供了一系列用于保存/操作上传文件的方法和属性
print(request.files.get("avatar")) # <FileStorage: 'lALPF8laHnXLkO7NAoDNBH0_1149_640.png' ('image/png')>
return "ok"
if __name__ == '__main__':
app.run(debug=True)
获取请求中查询字符串
from flask import Flask, request
app = Flask(__name__)
@app.route("/data", methods=["get", "put", "post"])
def index():
# 获取查询字符串[不管是任何一种http请求方式,都可以在地址的后面加上查询字符串]
# print(request.args) # ImmutableMultiDict([('name', 'alex')])
# 获取查询字符串中的指定参数值
# print(request.args["name"]) # alex
# print(request.args.get("name")) # alex
# 获取请求头的信息
# print(request.headers.get("Company")) # hhh
# print(request.headers.get("company")) # flask中获取请求体不区分大小写
# 获取本次客户端的http请求方式
print(request.method) # POST
# 获取本次客户端请求的url地址
print(request.url) # http://127.0.0.1:5000/data?name=alex
print(request) # <Request 'http://127.0.0.1:5000/data?name=alex' [POST]>
# 获取一个参数的多个值 get只返回一个
# http://127.0.0.1:5000/data?username=xiaoming&user_id=1&love=吹牛&love=睡觉
print(request.args.getlist("love")) # ['吹牛', '睡觉']
print(request.args.get("love")) # 吹牛
# 把传递过来的数据转换成原生的字典
data = request.form.to_dict()
print(data) # {'name': 'alex', 'age': '22'}
return "ok"
if __name__ == '__main__':
app.run(debug=True)
响应
flask默认支持2种响应方式:
数据响应: 默认响应html文本,也可以返回 JSON格式
页面响应: 重定向
url_for
响应的时候,flask也支持自定义http响应状态码
响应html文本
@app.route("/")
def index():
# [默认支持]响应html文本
return "<img src='http://flask.pocoo.org/static/logo.png'>"
返回JSON数据
在 Flask 中可以直接使用 jsonify 生成一个 JSON 的响应
from flask import Flask, request, jsonify
@app.route("/")
def index():
# 也可以响应json格式代码
data = [
{"id":1,"username":"liulaoshi","age":18},
{"id":2,"username":"liulaoshi","age":17},
{"id":3,"username":"liulaoshi","age":16},
{"id":4,"username":"liulaoshi","age":15},
]
return jsonify(data)
flask中返回json 数据,都是flask的jsonify方法返回就可以了.
重定向
重定向到百度页面
# 页面跳转响应
@app.route("/user")
def user():
# 页面跳转 redirect函数就是response对象的页面跳转的封装
# Location: http://www.baidu.com
return redirect("http://www.baidu.com")
重定向到自己写的视图函数
可以直接填写自己 url 路径
也可以使用 url_for 生成指定视图函数所对应的 url
# 内容响应
@app.route("/")
def index():
# [默认支持]响应html文本
# return "<img src='http://flask.pocoo.org/static/logo.png'>"
# 也可以响应json格式代码
data = [
{"id":1,"username":"liulaoshi","age":18},
{"id":2,"username":"liulaoshi","age":17},
{"id":3,"username":"liulaoshi","age":16},
{"id":4,"username":"liulaoshi","age":15},
]
return jsonify(data)
#使用url_for可以实现视图方法之间的内部跳转
# url_for("视图方法名")
@app.route("/login")
def login():
return redirect( url_for("index") )
重定向到带有参数的视图函数
跳转到站内指定视图函数中[可以在url_for的第二个参数开始,补充查询字符串参数]
# 路由传递参数
@app.route('/user/<user_id>')
def user_info(user_id):
return 'hello %d' % user_id
# 重定向
@app.route('/demo4')
def demo4():
# 使用 url_for 生成指定视图函数所对应的 url
return redirect(url_for('user_info', user_id=100))
自定义状态码或自定义响应头
在 Flask 中,可以很方便的返回自定义状态码,以实现不符合 http 协议的状态码,例如:status code: 666
@app.route('/demo4')
def demo4():
return '状态码为 666', 400
"""还可以使用make_response创建Response对象,然后通过response对象返回数据"""
from flask import make_response
@app.route("/rep")
def index7():
response = make_response("ok")
print(response)
response.headers["Company"] = "oldboy" # 自定义响应头
return response
会话控制
所谓的会话,就是用户和浏览器中网站之间一次交互过程.
会话的开始是在用户打开浏览器以后第一次访问网站.
会话的结束时在用户关闭浏览器以后.
因为 http 是一种无状态协议,浏览器请求服务器是无状态的。
无状态:指一次用户请求时,浏览器、服务器无法知道之前这个用户做过什么,每次请求都是一次新的请求。
无状态原因:浏览器与服务器是使用 socket 套接字进行通信的,服务器将请求结果返回给浏览器之后,会关闭当前的 socket 连接,而且服务器也会在处理页面完毕之后销毁页面对象。
有时需要保持下来用户浏览的状态,比如用户是否登录过,浏览过哪些商品等
实现状态保持主要有两种方式:
- 在客户端存储信息使用
Cookie,本地存储,token[jwt,oauth]
- 在服务器端存储信息使用
Session
,redis
Cookie
Cookie是由服务器端生成,发送给客户端浏览器,浏览器会将Cookie的key/value保存,下次请求同一网站时就发送该Cookie给服务器(前提是浏览器设置为启用cookie)。Cookie的key/value可以由服务器端自己定义。
使用场景: 登录状态, 浏览历史, 网站足迹,购物车 [不登录也可以使用购物车]
Cookie是存储在浏览器中的一段纯文本信息,建议不要存储敏感信息如密码,因为电脑上的浏览器可能被其它人使用
Cookie基于域名安全,不同域名的Cookie是不能互相访问的
如访问luffy.com时向浏览器中写了Cookie信息,使用同一浏览器访问baidu.com时,无法访问到luffy.com写的Cookie信息
浏览器的同源策略针对cookie也有限制作用.
当浏览器请求某网站时,会将本网站下所有Cookie信息提交给服务器,所以在request中可以读取Cookie信息
设置cookie和获取cookie
设置cookie需要通过flask的Response响应对象来进行设置,由flask内部提供了一个make_response函数给我们可以快速创建响应对象
from flask import Flask, make_response, request
app = Flask(__name__)
@app.route("/set_cookie")
def set_cookie():
"""设置cookie"""
# cookie生成服务端,随着http响应,返回并保存与客户端[浏览器]
response = make_response("ok")
# 设置cookie[生命周期为会话期]
# response.set_cookie("username", "xiaoming") # 设置cookie数据: 变量名:username, 变量值:xiaoming 有效期为默认值,默认为会话期(浏览器关闭)
# 删除cookie[生命周期为0]
# response.set_cookie("username", "xiaoming", max_age=0)
# 设置cookie[生命周期为十分钟,max_age的单位是秒]
response.set_cookie("username", "xiaohong", max_age=600)
return response
@app.route("/get_cookie")
def get_cookie():
"""获取cookie"""
print(request.cookies.get("username")) # xiaohong
return "ok"
if __name__ == '__main__':
app.run(debug=True)
Session
对于敏感、重要的信息,建议要存储在服务器端,不能存储在浏览器中,如用户名、余额、等级、验证码等信息
在服务器端进行状态保持的方案就是Session
注意: Session依赖于Cookie,而且flask中使用session,需要配置SECRET_KEY选项,否则报错.
设置session和获取session
from flask import Flask, session
app = Flask(__name__)
class Config():
# session密钥[使用session必须使用密钥]
SECRET_KEY = "QWLRJOGFMNWE"
app.config.from_object(Config)
@app.route("/set_session")
def set_session():
"""设置session"""
session["user"] = "xiaohong"
return "ok"
@app.route("/get_session")
def get_session():
"""获取session"""
print(session.get("user")) # xiaohong
return "ok"
if __name__ == '__main__':
app.run(debug=True)
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· TypeScript + Deepseek 打造卜卦网站:技术与玄学的结合
· Manus的开源复刻OpenManus初探
· AI 智能体引爆开源社区「GitHub 热点速览」
· 三行代码完成国际化适配,妙~啊~
· .NET Core 中如何实现缓存的预热?