Redis Django 缓存后端技术文档

1. 安装指南

1.1 环境要求

• redis-py >= 2.10.3
• redis >= 2.4
• hiredis
• python >= 2.7

1.2 安装步骤

1. 使用 pip 安装 django-redis-cache：

   pip install django-redis-cache
   

2. 修改 Django 项目的 settings.py 文件，配置缓存后端为 redis_cache。

2. 项目安装方式

2.1 使用 TCP 连接

在 settings.py 中配置 CACHES 如下：

CACHES = {
    'default': {
        'BACKEND': 'redis_cache.RedisCache',
        'LOCATION': [
            '<host>:<port>',
            '<host>:<port>',
            '<host>:<port>',
        ],
        'OPTIONS': {
            'DB': 1,
            'PASSWORD': 'yadayada',
            'PARSER_CLASS': 'redis.connection.HiredisParser',
            'CONNECTION_POOL_CLASS': 'redis.BlockingConnectionPool',
            'CONNECTION_POOL_CLASS_KWARGS': {
                'max_connections': 50,
                'timeout': 20,
            },
            'MAX_CONNECTIONS': 1000,
            'PICKLE_VERSION': -1,
        },
    },
}

2.2 使用 Unix 域套接字

在 settings.py 中配置 CACHES 如下：

CACHES = {
    'default': {
        'BACKEND': 'redis_cache.RedisCache',
        'LOCATION': '/path/to/socket/file',
        'OPTIONS': {
            'DB': 1,
            'PASSWORD': 'yadayada',
            'PARSER_CLASS': 'redis.connection.HiredisParser',
            'PICKLE_VERSION': 2,
        },
    },
}

2.3 主从配置

在 settings.py 中配置 CACHES 如下：

CACHES = {
    'default': {
        'BACKEND': 'redis_cache.RedisCache',
        'LOCATION': [
            '<host>:<port>',
            '<host>:<port>',
            '<host>:<port>',
        ],
        'OPTIONS': {
            'DB': 1,
            'PASSWORD': 'yadayada',
            'PARSER_CLASS': 'redis.connection.HiredisParser',
            'PICKLE_VERSION': 2,
            'MASTER_CACHE': '<master host>:<master port>',
        },
    },
}

3. 项目的使用说明

3.1 缓存操作

django-redis-cache 提供了与 Django 内置缓存后端相同的 API，并增加了一些额外的功能。

3.1.1 cache.delete_pattern

使用通配符模式删除缓存键。

示例：

>>> from news.models import Story
>>>
>>> most_viewed = Story.objects.most_viewed()
>>> highest_rated = Story.objects.highest_rated()
>>> cache.set('news.stories.most_viewed', most_viewed)
>>> cache.set('news.stories.highest_rated', highest_rated)
>>> data = cache.get_many(['news.stories.highest_rated', 'news.stories.most_viewed'])
>>> len(data)
2
>>> cache.delete_pattern('news.stories.*')
>>> data = cache.get_many(['news.stories.highest_rated', 'news.stories.most_viewed'])
>>> len(data)
0

3.1.2 cache.clear

清除缓存中的所有键，可以选择指定版本号来删除特定版本的键。

3.1.3 cache.reinsert_keys

重新插入所有缓存键，适用于更改缓存条目的 pickle 协议版本时。

3.2 防雪崩保护

get_or_set 方法支持防雪崩保护，通过传入一个可调用对象和超时时间，确保在缓存失效时只有一个请求去获取新数据，其他请求则使用旧数据。

示例：

tweets = cache.get_or_set('tweets', twitter.get_newest, timeout=300)

4. 项目API使用文档

4.1 缓存设置

• BACKEND: 缓存后端，设置为 redis_cache.RedisCache。
• LOCATION: Redis 服务器地址，可以是 TCP 连接或 Unix 域套接字。
• OPTIONS: 缓存选项，包括数据库编号、密码、解析器类、连接池类等。

4.2 缓存操作API

• cache.set(key, value, timeout=None): 设置缓存键值对。
• cache.get(key, default=None): 获取缓存键的值。
• cache.delete(key): 删除缓存键。
• cache.delete_pattern(pattern): 使用通配符模式删除缓存键。
• cache.clear(version=None): 清除缓存中的所有键，可选指定版本号。
• cache.reinsert_keys(): 重新插入所有缓存键。

4.3 防雪崩保护API

• cache.get_or_set(key, callable, timeout=None): 获取缓存键的值，如果缓存失效则调用可调用对象获取新值。

通过以上文档，您可以轻松安装、配置和使用 django-redis-cache 项目，并了解其提供的 API 和功能。