FastAPI中Redis客户端的实例化与传递：哪种方式更优？

方案一：模块级Redis客户端实例 #

代码示例：

from fastapi import FastAPI
import redis

# 初始化Redis客户端
r = redis.Redis(host='localhost', port=6379, db=0, decode_responses=True)

# 初始化FastAPI应用
app = FastAPI()

@app.get("/foo/")
async def foo():
    x = r.get("foo")
    return {"message": x}

@app.get("/bar/")
async def bar():
    x = r.get("bar")
    return {"message": x}

该方案是否属于不良实践？弊端有哪些？ #

这种做法不算绝对的不良实践，但存在几个明显弊端：

• 测试成本高：编写单元测试时，无法轻松替换Redis客户端为模拟实例，只能依赖真实Redis服务，或用 monkey patch 这类不够优雅的方式，增加测试复杂度。
• 灵活性不足：后续如果需要修改Redis配置（比如切换数据库、调整连接参数），或根据请求上下文动态切换客户端（如多租户场景），模块级变量完全无法支持这类需求。
• 潜在并发风险：虽然redis-py这类主流客户端实例是线程安全的，但如果使用的客户端本身不支持线程/协程安全，模块级单实例会引发并发访问问题；此外，模块级实例的连接池配置固定，无法根据请求动态调整。
• 依赖关系隐藏：接口函数直接调用模块级变量，外部无法直观看到它依赖Redis客户端，降低了代码的可读性和可维护性，新人接手时需要追踪模块变量才能理清依赖逻辑。

方案二：依赖注入获取Redis客户端实例 #

代码示例：

from fastapi import Depends, FastAPI
import redis

# 初始化FastAPI应用
app = FastAPI()

# 依赖函数
def get_redis():
    return redis.Redis(host='localhost', port=6379, db=0, decode_responses=True)

@app.get("/foo/")
async def foo(r = Depends(get_redis)):
    x = r.get("foo")
    return {"message": x}

@app.get("/bar/")
async def bar(r = Depends(get_redis)):
    x = r.get("bar")
    return {"message": x}

推荐方案及原因 #

优先推荐方案二（依赖注入），原因如下：

• 可测试性强：测试时可以直接替换get_redis函数的返回值，返回模拟的Redis客户端实例，无需连接真实Redis服务，大幅降低测试成本。
• 灵活性高：后续修改Redis配置、切换实例时，只需要调整get_redis函数的实现，所有依赖该函数的接口会自动生效；甚至可以根据请求参数动态返回不同的Redis实例，适配多租户等复杂场景。
• 依赖关系清晰：接口函数的参数明确标注了依赖Redis客户端，代码可读性和可维护性更好，任何人看接口定义就能清楚它的依赖项。
• 资源管理可控：如果需要在请求结束后清理资源（比如关闭连接，redis-py的连接池会自动管理，但特殊场景下可手动处理），可以用上下文管理器优化依赖函数：

def get_redis():
    r = redis.Redis(host='localhost', port=6379, db=0, decode_responses=True)
    try:
        yield r
    finally:
        r.close()

确保资源被正确释放。

另外，当前方案二的实现会为每个请求创建新的Redis客户端实例，可能带来连接开销。可以优化为单实例模式：

redis_client = None

def get_redis():
    global redis_client
    if not redis_client:
        redis_client = redis.Redis(host='localhost', port=6379, db=0, decode_responses=True)
    return redis_client

这样既保留依赖注入的优势，又避免了重复创建客户端的开销。

内容的提问来源于stack exchange，提问作者Ben