Django-Cachalot 安装与使用教程

Django-Cachalot 安装与使用教程

django-cachalotNo effort, no worry, maximum performance.项目地址:https://gitcode.com/gh_mirrors/dj/django-cachalot

Django-Cachalot 是一个用于 Django 框架的 ORM 查询缓存库，它能自动地缓存你的数据库查询并管理失效。本教程将指导您了解其目录结构、启动文件以及配置文件。

1. 项目目录结构及介绍

在克隆 https://github.com/noripyt/django-cachalot.git 后，您将得到以下基本的 Django-Cachalot 目录结构：

django-cachalot/
├── README.rst
├── LICENSE
├── setup.py
├── requirements.txt
├── django_cachalot/
│   ├── __init__.py
│   ├── middleware.py
│   ├── templatetags/
│   │   └── __init__.py
│   ├── tests/
│   │   ├── __init__.py
│   │   ├── models.py
│   │   └── testapp/
│   │       ├── __init__.py
│   │       ├── admin.py
│   │       ├── apps.py
│   │       ├── models.py
│   │       ├── tests.py
│   │       ├── urls.py
│   │       └── views.py
│   ├── utils.py
│   └── __version__.py
└── docs/
    ├── Makefile
    ├── conf.py
    ├── index.rst
    ├── ... （其他 Sphinx 文档相关文件）

• README.rst: 项目简介和安装说明。
• LICENSE: 开源许可文件。
• setup.py: Python 包安装脚本。
• requirements.txt: 依赖包列表。
• django_cachalot/: 主要代码目录，包括中间件、模板标签、测试等。
  • middleware.py: 实现缓存的中间件。
  • templatetags/: 提供用于模板中的缓存功能。
  • tests/: 测试目录，包含测试应用和相关的模型、测试用例。
  • utils.py: 辅助工具函数。
  • __version__.py: 存储版本号的文件。
• docs/: 项目文档的源码，使用 Sphinx 生成。

2. 项目启动文件介绍

Django-Cachalot 作为一个第三方库，没有自己的启动文件。不过，在集成到您的 Django 项目中时，您可以在 settings.py 中进行配置，然后通过 Django 的 manage.py runserver 命令来启动服务。

配置 Django 项目以使用 Cachalot

在您的 Django 项目的 settings.py 文件中：

1. 添加 'cachalot' 到 INSTALLED_APPS 列表中：

INSTALLED_APPS = [
    # ...
    'cachalot',
]

2. 可选：设置不缓存的表格（例如 public_test）：

CACHALOT_UNCACHABLE_TABLES = frozenset(['public_test'])

3. 为了确保跨服务器时的缓存一致性，检查所有服务器的时钟同步。

3. 项目配置文件介绍

Django-Cachalot 使用的是您的 Django 项目的 settings.py 文件来进行配置。以下是一些关键的配置选项：

• CACHES: 这是 Django 自带的缓存框架配置，用于定义你使用的缓存后端（如 Redis 或 Memcached）。请参照 Django 文档来配置这个选项，因为这取决于您选择的具体缓存系统。
• CACHALOT_UNCACHABLE_TABLES: 如果有某些数据表你不希望被缓存，可以在这里指定它们的名称（如列表或 frozenset）。

示例 settings.py 中的缓存配置可能如下所示：

CACHES = {
    'default': {
        'BACKEND': 'django_redis.cache.RedisCache',
        'LOCATION': 'redis://127.0.0.1:6379/0',
        'OPTIONS': {
            'CLIENT_CLASS': 'django_redis.client.DefaultClient',
            'PASSWORD': 'your_password',  # 如果需要的话
        }
    }
}

CACHALOT_UNCACHABLE_TABLES = frozenset(['public_test'])

完成以上步骤后，就可以通过执行 ./manage.py runserver 来启动带有 Django-Cachalot 缓存功能的开发服务器了。

django-cachalotNo effort, no worry, maximum performance.项目地址:https://gitcode.com/gh_mirrors/dj/django-cachalot