FastAPI-Cache简易缓存系统教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00059/article/details/137420599

ZhuYanXue是一个基于深度学习的Python工具包，提供Transformer架构的预训练模型，用于执行语义解析、情感分析等任务。其简洁API和兼容性使其易用且高效，适合开发者和研究人员快速开发NLP应用。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

FastAPI-Cache简易缓存系统教程

fastapi_cache FastAPI simple cache 项目地址: https://gitcode.com/gh_mirrors/fa/fastapi_cache

FastAPI-Cache是一个专为FastAPI设计的轻量级缓存解决方案，它允许开发者轻松地在API端点中添加缓存机制，以此提升应用性能。本教程将引导您了解其核心组件，通过分析目录结构、启动文件以及配置方式，帮助您快速上手FastAPI-Cache。

1. 项目目录结构及介绍

FastAPI-Cache的仓库遵循简洁的组织结构，下面是主要的目录和文件说明：

fastapi_cache: 核心模块，包含了缓存逻辑与依赖。
- 此目录下通常存放的是实现缓存逻辑的Python文件。
tests: 测试目录，用来存放所有与缓存相关的单元测试。
pytest.ini: PyTest配置文件，定义了测试运行的特定参数或配置。
setup.py: Python项目的标准设置文件，用于打包和发布项目到pip。
requirements.txt 和 requirements-test.txt: 分别列出项目运行和测试所需的第三方库。
LICENSE: 许可证文件，表明该项目采用了MIT许可证。
README.md: 项目的主要读我文件，提供快速入门和关键信息。

2. 项目的启动文件介绍

虽然FastAPI-Cache本身并不直接提供一个完整的“启动文件”，但它需被整合进您的FastAPI应用中。以下是整合示例流程，通常发生在您的FastAPI应用的主入口文件中（如main.py或app.py）:

引入依赖:

from fastapi import FastAPI
from fastapi_cache import caches, close_caches
from fastapi_cache.backends.redis import CACHE_KEY, RedisCacheBackend

配置缓存: 应用启动时配置缓存实例，并在关闭时清理缓存资源。

app = FastAPI()

@app.on_event("startup")
async def on_startup():
    # 假设使用Redis作为后台缓存
    rc = RedisCacheBackend('redis://localhost')
    caches.set(CACHE_KEY, rc)

@app.on_event("shutdown")
async def on_shutdown():
    await close_caches()

在端点中使用缓存: 示例代码展示如何在路由处理中使用缓存。

@app.get('/')
async def home(cache: RedisCacheBackend = Depends(caches.get(CACHE_KEY))):
    data = await cache.get('my_data')
    if not data:
        data = "Initial Data"
        await cache.set('my_data', data)
    return {'data': data}

3. 项目的配置文件介绍

FastAPI-Cache本身没有独立的配置文件，它的配置是动态进行的，通常在你的FastAPI应用初始化过程中完成。配置细节取决于所使用的缓存后端，比如Redis。配置过程更多地涉及到代码中的设定，而不是外部配置文件。例如，如果你选择Redis作为缓存后端，你需要在应用启动事件中指定Redis连接字符串，如上述示例所示。