首页
/ Redis Django 缓存后端技术文档

Redis Django 缓存后端技术文档

2024-12-12 15:41:12作者:凌朦慧Richard

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 和功能。

热门项目推荐
相关项目推荐

项目优选

收起
Python-100-DaysPython-100-Days
Python - 100天从新手到大师
Python
373
72
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
276
72
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
200
47
xzs-mysqlxzs-mysql
学之思开源考试系统是一款 java + vue 的前后端分离的考试系统。主要优点是开发、部署简单快捷、界面设计友好、代码结构清晰。支持web端和微信小程序,能覆盖到pc机和手机等设备。 支持多种部署方式:集成部署、前后端分离部署、docker部署
HTML
5
1
LangChatLangChat
LangChat: Java LLMs/AI Project, Supports Multi AI Providers( Gitee AI/ 智谱清言 / 阿里通义 / 百度千帆 / DeepSeek / 抖音豆包 / 零一万物 / 讯飞星火 / OpenAI / Gemini / Ollama / Azure / Claude 等大模型), Java生态下AI大模型产品解决方案,快速构建企业级AI知识库、AI机器人应用
Java
10
3
gin-vue-admingin-vue-admin
🚀Vite+Vue3+Gin的开发基础平台,支持TS和JS混用。它集成了JWT鉴权、权限管理、动态路由、显隐可控组件、分页封装、多点登录拦截、资源权限、上传下载、代码生成器【可AI辅助】、表单生成器和可配置的导入导出等开发必备功能。
Go
16
3
source-vuesource-vue
🔥 一直想做一款追求极致用户体验的快速开发平台,看了很多优秀的开源项目但是发现没有合适的。于是利用空闲休息时间对若依框架进行扩展写了一套快速开发系统。如此有了开源字节快速开发平台。该平台基于 Spring Boot + MyBatis + Vue & Element ,包含微信小程序 & Uniapp, Web 报表、可视化大屏、三方登录、支付、短信、邮件、OSS...
Java
24
2
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
898
0
madongmadong
基于Webman的权限管理系统
PHP
4
0
cool-admin-javacool-admin-java
🔥 cool-admin(java版)一个很酷的后台权限管理框架,Ai编码、流程编排、模块化、插件化、CRUD极速开发,永久开源免费,基于springboot3、typescript、vue3、vite、element-ui等构建
Java
18
2