快捷導(dǎo)航

python使用FastAPI獲取請(qǐng)求頭信息的兩種方法

更新時(shí)間：2025年02月24日 08:49:37 作者：夢(mèng)想畫(huà)家

本文聚焦 FastAPI 獲取請(qǐng)求頭信息的兩種方法,首先闡述使用Request對(duì)象,通過(guò)在路由處理函數(shù)中注入Request,接著介紹參數(shù)依賴注入法,在函數(shù)參數(shù)里用Header聲明請(qǐng)求頭參數(shù),文中有相關(guān)的代碼示例供大家參考,需要的朋友可以參考下

http請(qǐng)求頭

HTTP 請(qǐng)求頭是 HTTP 請(qǐng)求的重要組成部分，它包含了關(guān)于請(qǐng)求的各種元信息，以鍵值對(duì)的形式存在，為服務(wù)器處理請(qǐng)求提供額外信息。下面從作用、常見(jiàn)請(qǐng)求頭、示例等方面進(jìn)行簡(jiǎn)要解釋。

作用：它可以告知服務(wù)器關(guān)于客戶端的一些信息，比如客戶端類型、支持的內(nèi)容類型、緩存策略等，讓服務(wù)器能根據(jù)這些信息來(lái)正確處理請(qǐng)求，返回合適的響應(yīng)。例如，通過(guò)請(qǐng)求頭中的User - Agent，服務(wù)器能識(shí)別客戶端是瀏覽器、手機(jī)應(yīng)用還是其他工具，從而返回適配的內(nèi)容。
常見(jiàn)請(qǐng)求頭
- User-Agent：包含發(fā)出請(qǐng)求的客戶端的相關(guān)信息，如瀏覽器類型、版本、操作系統(tǒng)等。例如Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36 ，就表明這是來(lái)自 Windows 10 系統(tǒng)、使用 Chrome 瀏覽器的請(qǐng)求。
- Content-Type：用于說(shuō)明請(qǐng)求體的媒體類型，常見(jiàn)的有application/json 表示請(qǐng)求體是 JSON 格式數(shù)據(jù)，application/x-www-form-urlencoded表示表單數(shù)據(jù) 。
- Accept：告訴服務(wù)器客戶端能夠接受的響應(yīng)內(nèi)容類型，如Accept: text/html表示客戶端期望接收 HTML 格式的響應(yīng)。

示例：在一個(gè)簡(jiǎn)單的登錄請(qǐng)求中，可能會(huì)有Content-Type: application/json，表明請(qǐng)求體中是 JSON 格式的數(shù)據(jù)，里面可能包含用戶名和密碼等信息；User-Agent表明客戶端的相關(guān)信息，服務(wù)器根據(jù)這些信息來(lái)進(jìn)行相應(yīng)的處理，如驗(yàn)證登錄信息、返回合適格式的響應(yīng)。

在 FastAPI 中，獲取 HTTP 請(qǐng)求頭可以幫助開(kāi)發(fā)者更好地理解請(qǐng)求的來(lái)源和特性，從而實(shí)現(xiàn)更靈活和個(gè)性化的業(yè)務(wù)邏輯，比如根據(jù)User - Agent進(jìn)行不同的頁(yè)面渲染，根據(jù)Content - Type正確解析請(qǐng)求體等。

在 FastAPI 中，有多種方式可以獲取請(qǐng)求頭信息，下面為你詳細(xì)介紹兩種常見(jiàn)的方法，并結(jié)合示例代碼進(jìn)行說(shuō)明。

方法一：使用 Request 對(duì)象

Request 對(duì)象是 FastAPI 中代表 HTTP 請(qǐng)求的對(duì)象，通過(guò)它可以訪問(wèn)請(qǐng)求的各個(gè)部分，包括請(qǐng)求頭。你可以在路由處理函數(shù)中注入 Request 對(duì)象，然后使用 headers 屬性來(lái)獲取請(qǐng)求頭信息。

示例代碼

from fastapi import FastAPI, Request

app = FastAPI()

@app.get("/get_headers_with_request")
async def get_headers_with_request(request: Request):
    # 獲取所有請(qǐng)求頭信息
    all_headers = dict(request.headers)
    # 獲取特定請(qǐng)求頭信息，例如 'User-Agent'
    user_agent = request.headers.get('User-Agent')

    return {
        "all_headers": all_headers,
        "User-Agent": user_agent
    }

代碼解釋

導(dǎo)入必要的模塊：導(dǎo)入 FastAPI 和 Request。
創(chuàng)建 FastAPI 應(yīng)用實(shí)例：app = FastAPI()。
定義路由處理函數(shù)

- 在函數(shù)參數(shù)中注入 Request 對(duì)象。
- 使用 request.headers 獲取所有請(qǐng)求頭信息，并將其轉(zhuǎn)換為字典形式。
- 使用 request.headers.get('User - Agent') 獲取特定的請(qǐng)求頭信息。
返回結(jié)果：將所有請(qǐng)求頭信息和特定請(qǐng)求頭信息以 JSON 格式返回。

方法二：使用參數(shù)依賴注入

FastAPI 支持直接在路由處理函數(shù)的參數(shù)中聲明請(qǐng)求頭參數(shù)，通過(guò)指定參數(shù)名和類型，F(xiàn)astAPI 會(huì)自動(dòng)從請(qǐng)求頭中提取相應(yīng)的值。

示例代碼

from fastapi import FastAPI, Header

app = FastAPI()

@app.get("/get_headers_with_header")
async def get_headers_with_header(user_agent: str = Header(None), custom_header: str = Header(None)):
    return {
        "User-Agent": user_agent,
        "Custom-Header": custom_header
    }

代碼解釋

導(dǎo)入必要的模塊：導(dǎo)入 FastAPI 和 Header。
創(chuàng)建 FastAPI 應(yīng)用實(shí)例：app = FastAPI()。
定義路由處理函數(shù)
- 在函數(shù)參數(shù)中使用 Header 依賴注入請(qǐng)求頭參數(shù)。
- user_agent: str = Header(None) 表示從請(qǐng)求頭中提取 User - Agent 字段的值，并將其賦值給 user_agent 變量。如果請(qǐng)求頭中不存在該字段，則默認(rèn)值為 None。
- 同樣，custom_header: str = Header(None) 用于提取自定義請(qǐng)求頭 Custom - Header 的值。
返回結(jié)果：將提取的請(qǐng)求頭信息以 JSON 格式返回。

運(yùn)行示例

將上述代碼保存為 main.py，然后在終端中運(yùn)行以下命令啟動(dòng) FastAPI 應(yīng)用：

uvicorn main:app --reload

啟動(dòng)成功后，你可以使用工具（如 curl 或 Postman）向?qū)?yīng)的路由發(fā)送請(qǐng)求，查看返回的請(qǐng)求頭信息。例如，使用 curl 發(fā)送請(qǐng)求：

curl -H "User-Agent: MyCustomUserAgent" -H "Custom-Header: MyCustomValue" http://127.0.0.1:8000/get_headers_with_header

這樣你就可以看到請(qǐng)求頭信息被正確提取并返回。

最后總結(jié)

在 FastAPI 開(kāi)發(fā)中，獲取請(qǐng)求頭信息至關(guān)重要。Request對(duì)象方法提供全面靈活的操作，可對(duì)所有請(qǐng)求頭進(jìn)行整體處理和分析，適用于需要全面了解請(qǐng)求頭情況的場(chǎng)景。參數(shù)依賴注入法則簡(jiǎn)潔直觀，代碼更易讀，適合明確知道需要獲取哪些特定請(qǐng)求頭的情況。開(kāi)發(fā)者可依據(jù)具體需求選擇合適方法，通過(guò)合理運(yùn)用這兩種方式，能高效處理 HTTP 請(qǐng)求頭信息，提升 FastAPI 應(yīng)用的開(kāi)發(fā)效率和功能性。

以上就是python使用FastAPI獲取請(qǐng)求頭信息的兩種方法的詳細(xì)內(nèi)容，更多關(guān)于python FastAPI獲取信息的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: