引言
FastAPI 是一个现代、快速（高性能）的 Web 框架，用于构建 API，由 Python 3.6+ 的类型提示驱动。依赖注入（Dependency Injection，简称 DI）是 FastAPI 中的一个核心特性，它可以帮助开发者以更简洁、更可维护的方式构建应用程序。本文将全面解析 FastAPI 的依赖注入，并通过实际案例展示如何高效实践。
FastAPI 简介
FastAPI 是由 Sebastián Ramírez 开发的一个高性能的 Web 框架，它结合了 Python 3.6+ 的类型提示、异步支持、自动文档和验证等特性。FastAPI 的设计目标是快速、简单且易于扩展。
FastAPI 特性
类型安全
：利用 Python 3.6+ 的类型提示进行自动验证和类型检查。
异步支持
：使用异步函数来处理请求，提高性能。
自动文档
：生成交互式的 API 文档。
验证
：自动验证输入参数，减少错误。
依赖注入概述
依赖注入是一种设计模式，它允许开发者将依赖关系从应用程序的代码中分离出来，从而使代码更加模块化、可测试和可维护。
依赖注入的好处
降低耦合度
：减少组件之间的直接依赖。
提高可测试性
：更容易对组件进行单元测试。
提高可维护性
：代码更易于理解和修改。
FastAPI 中的依赖注入
FastAPI 提供了一个简单的依赖注入系统，允许开发者注入任何类型的服务，例如数据库连接、配置对象等。
依赖注入的使用
在 FastAPI 中，你可以通过装饰器
@inject
或
@inject Depends
来注入依赖。
from fastapi import FastAPI, Depends
app = FastAPI()
# 定义一个依赖函数
def get_current_user(token: str = Depends(get_token)):
# 在这里实现获取当前用户的逻辑
return user
@app.get(“/items/”)
async def read_items(token: str = Depends(get_token)):
return {“token”: token}
依赖注入的原理
FastAPI 使用一个中间件来处理依赖注入。当请求到达时，中间件会查找所有标记为依赖项的函数，并调用它们来获取所需的依赖项。
实战案例：依赖注入在数据库中的应用
下面我们将通过一个简单的例子来展示如何使用依赖注入来管理数据库连接。
数据库模型
首先，我们需要定义一个数据库模型。
from pydantic import BaseModel
from typing import Optional
class Item(BaseModel):
id: int
name: str
description: Optional[str] = None
price: float
tax: Optional[float] = None
数据库连接
接下来，我们创建一个数据库连接函数。
from sqlalchemy import create_engine
from sqlalchemy.orm import sessionmaker
DATABASE_URL = “sqlite:///./test.db”
engine = create_engine(DATABASE_URL, connect_args={“check_same_thread”: False})
SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
def get_db():
db = SessionLocal()
try:
yield db
finally:
db.close()
依赖注入数据库连接
现在，我们将数据库连接作为一个依赖项注入到我们的路由中。
@app.get(“/items/”)
async def read_items(db: Session = Depends(get_db)):
items = db.query(Item).all()
return items
完整示例
以下是完整的 FastAPI 应用程序代码，包括依赖注入数据库连接的示例。
from fastapi import FastAPI, Depends
from sqlalchemy.orm import sessionmaker
from sqlalchemy import create_engine
from pydantic import BaseModel
app = FastAPI()
DATABASE_URL = “sqlite:///./test.db”
engine = create_engine(DATABASE_URL, connect_args={“check_same_thread”: False})
SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
def get_db():
db = SessionLocal()
try:
yield db
finally:
db.close()
class Item(BaseModel):
id: int
name: str
description: Optional[str] = None
price: float
tax: Optional[float] = None
@app.get(“/items/”)
async def read_items(db: Session = Depends(get_db)):
items = db.query(Item).all()
return items
总结
通过本文的解析，我们可以看到 FastAPI 的依赖注入功能是如何帮助开发者构建更简洁、更可维护的 API 应用程序的。依赖注入不仅降低了代码的耦合度，还提高了代码的可测试性和可维护性。在实际开发中，合理使用依赖注入可以帮助我们更好地管理应用程序的依赖关系，提高开发效率。