FastAPI-Cache简易使用手册

FastAPI-Cache简易使用手册

fastapi-cachefastapi-cache is a tool to cache fastapi response and function result, with backends support redis and memcached.项目地址:https://gitcode.com/gh_mirrors/fa/fastapi-cache

1. 目录结构及介绍

FastAPI-Cache的仓库结构清晰地展现了其内部组织方式，以下是核心部分的目录结构概述：

fastapi-cache/
├── examples            # 示例应用代码，用于快速上手
│   └── ...             # 不同缓存后端的示例
├── fastapi_cache       # 主要源码模块
│   ├── __init__.py      # 初始化文件，定义核心类和函数
│   └── ...             # 其它相关python文件，实现具体功能
├── tests               # 测试套件，确保代码质量
│   ├── __init__.py
│   └── ...
├── README.md           # 项目说明文档，包含简介和基本使用说明
├── LICENSE             # 许可证文件，声明Apache-2.0许可
├── pyproject.toml      # 项目配置文件，指定Python依赖和其他元数据
└── setup.py            # 包安装脚本，用于发布到PyPI

重点目录说明:

• examples: 提供了使用不同缓存后端（如Redis）的示例，是学习如何集成至FastAPI项目的最佳起点。
• fastapi_cache: 源代码的核心所在，实现了缓存逻辑与FastAPI的集成接口。
• tests: 包含单元测试和集成测试，保证库的功能稳定。

2. 项目的启动文件介绍

虽然FastAPI-Cache本身不直接提供一个完整的启动文件，但通常在使用时，开发者会在自己的FastAPI项目中引入并配置FastAPI-Cache。一个典型的集成过程会在你的主应用程序文件(main.py, 或任何定义FastAPI实例的文件)中添加以下类似代码：

from fastapi import FastAPI
from fastapi_cache import FastAPICache
from fastapi_cache.backends.redis import RedisBackend
import redis

app = FastAPI()

# 假设我们使用Redis作为后台
redis_client = redis.Redis(host="localhost", port=6379, db=0)
backend = RedisBackend(redis_client)

@app.on_event("startup")
async def startup():
    FastAPICache.init(backend, prefix="fastapi-cache:")

这段代码展示了如何初始化FastAPI-Cache并与Redis建立连接，以便于整个应用生命周期内使用缓存服务。

3. 项目的配置文件介绍

FastAPI-Cache的主要配置并非通过单独的配置文件进行，而是通过代码方式进行灵活设定。这意味着配置通常是动态的，发生在应用程序启动阶段。例如，在上述启动文件中，通过FastAPICache.init()方法，可以指定后台存储类型、前缀等参数。

若需更复杂的配置或环境变量支持，开发者通常会在自己的项目中利用.env文件配合python-dotenv库管理环境变量，或者直接在项目的设置模块中定义这些配置项，并在初始化FastAPI-Cache时使用这些变量。比如：

from os import environ

redis_host = environ.get('REDIS_HOST', 'localhost')
redis_port = int(environ.get('REDIS_PORT', 6379))
...
redis_client = redis.Redis(host=redis_host, port=redis_port, db=0)

这样做可以让缓存配置更加灵活且易于维护，同时也方便在不同的部署环境中切换配置。

fastapi-cachefastapi-cache is a tool to cache fastapi response and function result, with backends support redis and memcached.项目地址:https://gitcode.com/gh_mirrors/fa/fastapi-cache