Python Web 開發：使用 FastAPI 進行依賴注入與異常處理

1. 🛠? 依賴注入與 FastAPI 高級特性

FastAPI 提供了非常強大的依賴注入機制，可以幫助開發者簡化代碼結構，使得應用更加清晰、可維護和易于擴展。依賴注入是一種設計模式，它使得組件之間的依賴關系得以解耦，尤其適用于大型應用程序。在 FastAPI 中，依賴注入不僅可以注入數據庫連接、配置文件、服務類等，還能夠注入復雜的業務邏輯處理層。

依賴注入的基礎

在 FastAPI 中，依賴注入機制是通過 Depends 類來實現的。開發者只需要將需要依賴的組件作為參數傳遞給函數，FastAPI 會自動解析并將依賴項注入函數中。這種方式使得代碼的模塊化程度大大提高，也讓代碼更加簡潔和可測試。

from fastapi import FastAPI, Dependsapp = FastAPI()# 定義一個簡單的依賴項
def get_db():db = "數據庫連接"return db# 依賴注入到路徑操作函數中
@app.get("/items/")
async def read_items(db: str = Depends(get_db)):return {"message": f"使用的數據庫是：{db}"}

在上面的例子中，get_db() 函數返回一個“數據庫連接”字符串，并通過 Depends(get_db) 注入到 read_items() 路由函數的參數中。FastAPI 會自動識別并調用 get_db()，將返回值傳遞給 db 參數。

依賴注入的優勢

依賴注入提供了許多好處，尤其是在項目的可維護性和可擴展性方面。以下是幾種常見的優勢：

解耦和模塊化：各個模塊之間的依賴關系通過注入來管理，而不是硬編碼在代碼中，降低了模塊間的耦合度。
代碼清晰度：通過明確聲明依賴項，代碼變得更加清晰，易于理解和維護。
更容易進行單元測試：由于各個部分的依賴被解耦，因此可以通過模擬 (Mock) 或替換依賴項來更容易地進行單元測試。
復用性：開發者可以更容易地復用依賴項，無需重復創建新的實例或進行配置。

動態依賴注入

FastAPI 還支持動態依賴注入，這使得開發者可以根據不同的情況動態地決定依賴項。例如，可以根據用戶角色注入不同的數據庫連接、配置或服務。

from fastapi import FastAPI, Depends, HTTPException
from typing import Optionalapp = FastAPI()# 模擬根據不同角色返回不同數據庫連接
def get_db(role: Optional[str] = None):if role == "admin":return "管理員數據庫連接"elif role == "user":return "普通用戶數據庫連接"else:raise HTTPException(status_code=400, detail="無效角色")@app.get("/items/")
async def read_items(db: str = Depends(get_db)):return {"message": f"當前使用的數據庫連接是：{db}"}

這種動態注入方式在復雜的系統中非常有用，能夠根據業務邏輯需要選擇不同的依賴項。

2. ?? 自定義異常類的實現與應用

在 Web 開發中，處理錯誤和異常是至關重要的一部分。FastAPI 提供了許多內建的異常處理機制，但對于一些特定業務場景，開發者往往需要自定義異常類。自定義異常類能夠讓我們更好地管理錯誤代碼、錯誤消息，并且使 API 的錯誤信息更加語義化。

自定義異常類的實現

自定義異常類通常是通過繼承 Exception 類來創建，并根據業務需要添加錯誤代碼、消息或更多詳細信息。以下是一個簡單的自定義異常類實現的例子：

class ItemNotFoundError(Exception):def __init__(self, item_id: int):self.item_id = item_idself.message = f"項目 {item_id} 未找到"super().__init__(self.message)

在上述代碼中，ItemNotFoundError 是一個自定義的異常類，繼承了 Exception。該異常類具有一個初始化方法，用于接收 item_id 參數并構造錯誤信息。

使用自定義異常

在 FastAPI 中，異常可以通過 HTTPException 或通過自定義的異常類拋出。通過 Depends 注入依賴項，我們可以在路由函數中觸發自定義異常。例如：

from fastapi import FastAPI, HTTPException, Dependsapp = FastAPI()# 假設這是數據庫查詢操作
def get_item(item_id: int):if item_id != 123:raise ItemNotFoundError(item_id)return {"item_id": item_id, "name": "商品名稱"}@app.get("/items/{item_id}")
async def read_item(item_id: int, item: dict = Depends(get_item)):return item

在上面的代碼中，get_item 函數嘗試查找指定 item_id 的項目，如果沒有找到該項目，拋出 ItemNotFoundError 異常。FastAPI 會自動捕捉到這個異常并返回合適的錯誤信息。

異常類的擴展

自定義異常類不僅僅可以添加錯誤信息，還可以增加 HTTP 狀態碼、錯誤碼等，以便更好地進行錯誤分類和處理。例如：

class ItemNotFoundError(HTTPException):def __init__(self, item_id: int):self.item_id = item_idself.status_code = 404self.detail = f"項目 {item_id} 未找到"super().__init__(status_code=self.status_code, detail=self.detail)

這種做法使得自定義的異常類可以直接作為 HTTPException 使用，FastAPI 會自動將其作為 HTTP 響應返回。

3. 🚨 使用 HTTPException 處理常見錯誤

FastAPI 內置了許多常用的 HTTP 錯誤狀態碼和異常處理類，其中 HTTPException 是最常用的異常類。它允許開發者通過設置狀態碼、錯誤信息等來拋出 HTTP 錯誤，進而在 API 響應中提供友好的錯誤提示。

使用 `HTTPException`

HTTPException 是一個簡單的異常類，可以用來返回 HTTP 錯誤。它接受 status_code 和 detail 兩個參數，分別表示 HTTP 狀態碼和錯誤信息。以下是一個簡單的示例：

from fastapi import FastAPI, HTTPExceptionapp = FastAPI()@app.get("/items/{item_id}")
async def read_item(item_id: int):if item_id != 123:raise HTTPException(status_code=404, detail="項目未找到")return {"item_id": item_id, "name": "商品名稱"}

在上面的代碼中，當 item_id 不為 123 時，FastAPI 會拋出 HTTPException，返回 404 狀態碼并顯示錯誤信息“項目未找到”。

錯誤處理與自定義響應

在實際開發中，錯誤的處理往往需要根據業務場景進行定制化，比如添加更多的錯誤細節信息或返回不同格式的響應。例如，除了返回標準的 JSON 錯誤響應外，還可以添加額外的字段，幫助前端更好地理解錯誤。

from fastapi import FastAPI, HTTPException
from fastapi.responses import JSONResponse@app.exception_handler(HTTPException)
async def custom_http_exception_handler(request, exc: HTTPException):return JSONResponse(status_code=exc.status_code,content={"error": exc.detail,"request_url": str(request.url),},)

在上面的代碼中，我們定義了一個全局異常處理器，它會在遇到 HTTPException 異常時，返回自定義的 JSON 響應格式，并附加請求的 URL 作為調試信息。

4. 🌍 全局異常處理器的設計與實現

FastAPI 允許開發者通過全局異常處理器來捕獲和處理應用中的所有異常。通過這種方式，開發者可以集中管理所有錯誤響應邏輯，而不需要在每個路由中單獨處理異常。這使得應用的異常管理變得更加統一和高效。

定義全局異常處理器

FastAPI 通過 @app.exception_handler 裝飾器提供了全局異常處理的功能。開發者可以為不同類型的

異常定義專門的處理函數，下面是一個處理所有未捕獲異常的例子：

from fastapi import FastAPI, HTTPException
from fastapi.responses import JSONResponseapp = FastAPI()@app.exception_handler(Exception)
async def global_exception_handler(request, exc: Exception):return JSONResponse(status_code=500,content={"message": "服務器發生了未知錯誤","detail": str(exc),},)

在上面的代碼中，我們定義了一個全局異常處理器，它會捕獲所有未處理的異常，并返回一個統一的 500 錯誤響應。響應中包含了錯誤的詳細信息以及“服務器發生了未知錯誤”的提示。

捕獲特定異常

除了捕獲所有異常，開發者還可以為特定的異常類型定義專門的處理函數。例如，當捕獲 HTTPException 時，我們希望返回更加詳細的錯誤信息和建議。如下所示：

@app.exception_handler(HTTPException)
async def custom_http_exception_handler(request, exc: HTTPException):return JSONResponse(status_code=exc.status_code,content={"error": exc.detail,"advice": "請檢查請求參數或嘗試稍后重試。",},)

這種做法能夠讓錯誤響應更加用戶友好，并提供一些建議，幫助客戶端更容易地解決問題。

5. ?? 異常處理與 API 響應的整合

在實際的 API 開發中，錯誤處理不僅僅是返回一個錯誤狀態碼和消息那么簡單。開發者往往需要將錯誤處理與 API 響應的整體設計相結合，以確保前端能夠準確地解析和顯示錯誤信息。FastAPI 提供了一些靈活的機制，能夠幫助開發者實現這一點。

設計一致的錯誤響應格式

為了讓前端更加方便地處理錯誤信息，通常需要設計一種統一的錯誤響應格式。這可以通過全局異常處理器和自定義異常類來實現。

from fastapi import FastAPI, HTTPException
from fastapi.responses import JSONResponseapp = FastAPI()@app.exception_handler(HTTPException)
async def custom_http_exception_handler(request, exc: HTTPException):return JSONResponse(status_code=exc.status_code,content={"status": "error","error_code": exc.status_code,"message": exc.detail,},)

這種格式化的錯誤響應使得前端可以快速定位錯誤信息，并根據 error_code 進行相應的處理。

錯誤日志記錄

除了返回錯誤信息外，錯誤日志記錄也是異常處理中重要的一部分。通過將錯誤信息記錄到日志中，開發者可以追蹤應用的異常并分析問題根源。FastAPI 可以與 Python 標準庫的 logging 模塊集成，以便記錄錯誤日志。

import logging
from fastapi import FastAPI, HTTPException
from fastapi.responses import JSONResponse# 配置日志記錄
logging.basicConfig(level=logging.ERROR)
logger = logging.getLogger(__name__)app = FastAPI()@app.exception_handler(HTTPException)
async def custom_http_exception_handler(request, exc: HTTPException):logger.error(f"發生錯誤: {exc.detail}, URL: {request.url}")return JSONResponse(status_code=exc.status_code,content={"status": "error","error_code": exc.status_code,"message": exc.detail,},)