在 Flask 中,request
对象是处理 HTTP 请求的重要工具之一。它提供了许多属性和方法,可以帮助我们获取请求的相关信息和数据。本文将向你介绍 request
对象的常用方法以及如何在 Flask 应用程序中使用它。
1. 获取请求方法
首先,让我们看一下如何获取当前请求的方法。在 Flask 中,可以通过 request.method
属性来获取请求方法。
from flask import Flask, request app = Flask(__name__) @app.route('/api/hello', methods=['GET']) def hello(): method = request.method # 获取请求方法 return f"Request method: {method}"
在上面的示例中,我们创建了一个名为 /api/hello
的路由,限定请求方法为 GET。在视图函数 hello
中,我们通过 request.method
属性获取当前请求的方法,并将其返回给客户端。当我们向 /api/hello
发送 GET 请求时,我们将得到响应 Request method: GET
。
2. 获取请求参数
除了请求方法,request
对象还允许我们获取 URL 查询参数或表单数据。我们可以使用 request.args
属性来获取这些参数。
@app.route('/api/greet', methods=['GET']) def greet(): name = request.args.get('name') # 获取名为 'name' 的查询参数 return f"Hello, {name}!"
在上面的示例中,我们创建了一个名为 /api/greet
的路由,限定请求方法为 GET。在视图函数 greet
中,我们使用 request.args.get('name')
来获取名为 name
的查询参数的值,并在响应中返回 Hello, {name}!
。当我们向 /api/greet?name=John
发送 GET 请求时,我们将得到响应 Hello, John!
。
3. 获取请求头信息
request.headers
属性可以帮助我们获取请求头信息。它返回一个字典对象,其中包含了请求头的键值对。
@app.route('/api/info', methods=['GET']) def info(): user_agent = request.headers.get('User-Agent') # 获取 User-Agent 头信息 return f"User-Agent: {user_agent}"
在上面的示例中,我们创建了一个名为 /api/info
的路由,限定请求方法为 GET。在视图函数 info
中,我们使用 request.headers.get('User-Agent')
来获取 User-Agent 头信息,并将其返回给客户端。当我们向 /api/info
发送 GET 请求时,我们将得到包含 User-Agent 头信息的响应。
4. 获取请求体数据
当请求是 POST 或 PUT 方法,并且包含请求体数据时,我们可以使用 request.data
属性来获取原始数据。
@app.route('/api/data', methods=['POST']) def data(): data = request.data # 获取请求体数据 return f"Request data: {data}"
在上面的示例中,我们创建了一个名为 /api/data
的路由,限定请求方法为 POST。在视图函数 data
中,我们使用 request.data
来获取请求体数据,并将其返回给客户端。当我们向 /api/data
发送包含请求体数据的 POST 请求时,我们将得到响应 Request data: {data}
。
5. 获取 JSON 数据
如果请求体中的数据是 JSON 格式,我们可以使用 request.json
属性来获取解析后的 JSON 数据。
@app.route('/api/json', methods=['POST']) def json_data(): data = request.json # 获取解析后的 JSON 数据 return jsonify(data) # 返回 JSON 数据
在上面的示例中,我们创建了一个名为 /api/json
的路由,限定请求方法为 POST。在视图函数 json_data
中,我们使用 request.json
来获取解析后的 JSON 数据,并通过 jsonify
函数将其作为响应返回。当我们向 /api/json
发送包含 JSON 数据的 POST 请求时,我们将得到包含相同 JSON 数据的响应。
6. 文件上传
如果你的应用程序需要支持文件上传功能,request
对象可以帮助你获取上传的文件数据。使用 request.files
属性可以获取上传的文件对象。
@app.route('/api/upload', methods=['POST']) def upload(): file = request.files['file'] # 获取上传的文件对象 file.save('path/to/save/file') # 保存文件到指定路径 return "File uploaded successfully!"
在上面的示例中,我们创建了一个名为 /api/upload
的路由,限定请求方法为 POST。在视图函数 upload
中,我们使用 request.files['file']
来获取上传的文件对象,并使用 save()
方法将文件保存到指定路径。当我们向 /api/upload
发送包含文件上传的 POST 请求时,文件将被保存,并返回响应 "File uploaded successfully!"。
7. 获取请求 URL
有时候我们需要获取当前请求的完整 URL,包括协议、主机名、路径和查询参数等信息。request.url
属性可以帮助我们获取当前请求的完整 URL。
@app.route('/api/url', methods=['GET']) def url(): url = request.url # 获取当前请求的完整 URL return f"URL: {url}"
在上面的示例中,我们创建了一个名为 /api/url
的路由,限定请求方法为 GET。在视图函数 url
中,我们使用 request.url
来获取当前请求的完整 URL,并将其返回给客户端。
8. 判断请求头信息
有时候我们需要根据请求头信息来判断客户端的类型或处理特定逻辑。request.headers
属性返回的是一个字典对象,可以通过键来访问相应的值。
@app.route('/api/device', methods=['GET']) def device(): user_agent = request.headers.get('User-Agent') # 获取 User-Agent 头信息 if 'Mobile' in user_agent: return "Mobile device" else: return "Desktop device"
在上面的示例中,我们创建了一个名为 /api/device
的路由,限定请求方法为 GET。在视图函数 device
中,我们使用 request.headers.get('User-Agent')
来获取 User-Agent 头信息,并根据其中是否包含关键词 "Mobile" 来判断设备类型,并返回相应的响应。
9. 获取表单数据
如果请求是以 application/x-www-form-urlencoded
或 multipart/form-data
格式发送的 POST 请求,可以使用 request.form
属性来获取表单数据,它返回一个字典对象:
@app.route('/api/login', methods=['POST']) def login(): username = request.form.get('username') # 获取表单字段 'username' 的值 password = request.form.get('password') # 获取表单字段 'password' 的值 # 进行登录验证等操作 return "Login successful"
这些是一些 request
对象的常用功能。Flask 还提供了其他一些方法和属性,可以根据具体需求进行使用。