FastAPI 中如何使用 Request 对象访问请求信息？

推荐答案

在 FastAPI 中，可以通过 Request 对象来访问请求信息。以下是一个简单的示例，展示了如何在路由处理函数中使用 Request 对象来获取请求的详细信息：

// www.javascriptcn.com code example
from fastapi import FastAPI, Request

app = FastAPI()

@app.get("/info")
async def get_request_info(request: Request):
    client_host = request.client.host
    method = request.method
    url = str(request.url)
    headers = request.headers
    query_params = request.query_params

    return {
        "client_host": client_host,
        "method": method,
        "url": url,
        "headers": dict(headers),
        "query_params": dict(query_params)
    }

在这个示例中，Request 对象被注入到路由处理函数中，允许你访问请求的各种信息，如客户端的主机地址、HTTP 方法、URL、请求头和查询参数。

本题详细解读

1. 什么是 Request 对象？

Request 对象是 FastAPI 提供的一个类，它封装了 HTTP 请求的所有信息。通过这个对象，你可以访问请求的各个方面，包括请求头、请求体、查询参数、路径参数等。

2. 如何获取 Request 对象？

在 FastAPI 中，你可以通过将 Request 对象作为路由处理函数的参数来获取它。FastAPI 会自动将当前的请求对象注入到这个参数中。

from fastapi import Request

@app.get("/example")
async def example(request: Request):
    # 使用 request 对象
    pass

3. Request 对象的常用属性

• request.method: 获取请求的 HTTP 方法（如 GET, POST 等）。
• request.url: 获取请求的完整 URL。
• request.headers: 获取请求头，返回一个 Headers 对象，可以转换为字典。
• request.query_params: 获取查询参数，返回一个 QueryParams 对象，可以转换为字典。
• request.client: 获取客户端信息，包括 IP 地址和端口号。
• request.body(): 获取请求体内容（异步方法）。
• request.json(): 解析请求体为 JSON（异步方法）。

4. 示例代码解析

在示例代码中，我们定义了一个路由 /info，它通过 Request 对象获取了以下信息：

• client_host: 客户端的 IP 地址。
• method: 请求的 HTTP 方法。
• url: 请求的完整 URL。
• headers: 请求头，转换为字典格式。
• query_params: 查询参数，转换为字典格式。

这些信息被封装在一个字典中并返回给客户端。

5. 使用场景

Request 对象在以下场景中非常有用：

• 需要根据请求头或查询参数进行条件处理。
• 需要记录请求的详细信息，如日志记录。
• 需要动态处理请求体或查询参数。

通过 Request 对象，你可以灵活地处理各种 HTTP 请求，并根据需要提取和使用请求信息。