Django 标准缓存cache 模块API

一、Django缓存系统概述

Django提供了一个统一的缓存API，支持多种缓存后端（内存、数据库、文件、Redis等）。你可以在不改动代码的情况下，通过配置切换不同的缓存后端。

# 支持的缓存后端CACHES={'default':{'BACKEND':'django.core.cache.backends.locmem.LocMemCache',# 内存缓存# 'BACKEND': 'django.core.cache.backends.db.DatabaseCache', # 数据库缓存# 'BACKEND': 'django.core.cache.backends.filebased.FileBasedCache', # 文件缓存# 'BACKEND': 'django_redis.cache.RedisCache', # Redis缓存}}

二、缓存API基础

1. 导入缓存对象

# 方式1：导入默认缓存（最常用）fromdjango.core.cacheimportcache# 方式2：导入特定缓存fromdjango.core.cacheimportcaches cache_alias=caches['default']# 或 caches['session'] 等

2. 基本操作方法

defbasic_cache_operations():"""基本缓存操作"""# 1. set() - 设置缓存# 语法：cache.set(key, value, timeout=None, version=None)cache.set('username','张三')# 使用默认超时时间cache.set('user_age',25,timeout=300)# 5分钟后过期cache.set('permanent_data','重要数据',timeout=None)# 永不过期# 2. get() - 获取缓存# 语法：cache.get(key, default=None, version=None)username=cache.get('username')username=cache.get('username','默认值')# 获取不到时返回默认值not_found=cache.get('non_existent_key')# 返回 None# 3. add() - 仅当键不存在时设置# 语法：cache.add(key, value, timeout=None, version=None)added=cache.add('counter',1)# 第一次设置成功，返回Trueadded_again=cache.add('counter',2)# 已存在，不修改，返回False# 4. get_or_set() - 获取或设置# 语法：cache.get_or_set(key, default, timeout=None, version=None)value=cache.get_or_set('my_key','default_value',timeout=60)# 等价于：# value = cache.get('my_key')# if value is None:# value = 'default_value'# cache.set('my_key', value, timeout=60)# 5. delete() - 删除缓存# 语法：cache.delete(key, version=None)cache.delete('username')deleted=cache.delete('non_existent_key')# 返回False# 6. clear() - 清空所有缓存# 语法：cache.clear()# cache.clear() # 谨慎使用！return{'username':username,'counter':cache.get('counter'),'added_first':added,'added_again':added_again,}

3. 批量操作方法

defbatch_operations():"""批量缓存操作"""# 1. set_many() - 设置多个缓存# 语法：cache.set_many(dict, timeout=None, version=None)data={'user:1:name':'张三','user:1:age':25,'user:1:email':'zhangsan@example.com','user:2:name':'李四',}cache.set_many(data,timeout=300)# 2. get_many() - 获取多个缓存# 语法：cache.get_many(keys, version=None)keys=['user:1:name','user:1:age','user:1:email','user:2:name']values=cache.get_many(keys)# 返回字典# 3. delete_many() - 删除多个缓存# 语法：cache.delete_many(keys, version=None)cache.delete_many(['user:1:age','user:1:email'])returnvalues

4. 原子操作方法

defatomic_operations():"""原子操作（需要缓存后端支持）"""# 1. incr() - 递增# 语法：cache.incr(key, delta=1, version=None)cache.set('counter',1)cache.incr('counter')# 2cache.incr('counter',10)# 12# 2. decr() - 递减# 语法：cache.decr(key, delta=1, version=None)cache.decr('counter')# 11cache.decr('counter',5)# 6# 3. touch() - 更新过期时间# 语法：cache.touch(key, timeout=None, version=None)cache.touch('counter',timeout=600)# 重置为10分钟后过期return{'counter':cache.get('counter')}

三、缓存版本控制

defcache_versioning():"""缓存版本控制"""# 设置版本cache.set('config','v1_config',version=1)cache.set('config','v2_config',version=2)# 获取特定版本v1_config=cache.get('config',version=1)# 'v1_config'v2_config=cache.get('config',version=2)# 'v2_config'# 递增版本（旧版本自动失效）cache.incr_version('config')# version从2变为3v3_config=cache.get('config')# None（默认使用最新版本）# 删除特定版本cache.delete('config',version=1)return{'v1':v1_config,'v2':v2_config,'v3':v3_config}

四、缓存键的生成

defcache_key_generation():"""缓存键的生成"""# Django会自动处理键的生成# 最终的键 = 前缀:版本:原始键# 自定义键生成函数defmake_cache_key(model_name,object_id,action='detail'):"""生成结构化缓存键"""returnf'{model_name}:{object_id}:{action}'# 使用示例user_key=make_cache_key('user',123,'profile')cache.set(user_key,{'name':'张三','age':25})# 复杂的键complex_key=f'search:{hashlib.md5("python tutorial".encode()).hexdigest()}:page:1'cache.set(complex_key,['result1','result2'])return{'user_key':user_key,'user_data':cache.get(user_key),'complex_key':complex_key}

五、实战：缓存数据库查询

fromdjango.dbimportmodelsfromdjango.core.cacheimportcacheimporttimeclassProduct(models.Model):"""产品模型"""name=models.CharField(max_length=100)price=models.DecimalField(max_digits=10,decimal_places=2)stock=models.IntegerField(default=0)category=models.CharField(max_length=50)created_at=models.DateTimeField(auto_now_add=True)def__str__(self):returnself.nameclassProductCacheService:"""产品缓存服务"""@staticmethoddefget_product(product_id):"""获取单个产品（带缓存）"""cache_key=f'product:{product_id}'# 尝试从缓存获取product=cache.get(cache_key)ifproductisNone:print(f"缓存未命中，从数据库查询产品{product_id}")# 模拟数据库查询time.sleep(1)# 假设查询耗时1秒try:product_obj=Product.objects.get(id=product_id)product={'id':product_obj.id,'name':product_obj.name,'price':float(product_obj.price),'stock':product_obj.stock,'category':product_obj.category,}# 存入缓存，有效期1小时cache.set(cache_key,product,timeout=3600)exceptProduct.DoesNotExist:# 缓存空结果，防止缓存穿透cache.set(cache_key,None,timeout=60)product=Noneelse:print(f"缓存命中，从缓存获取产品{product_id}")returnproduct@staticmethoddefget_products_by_category(category,page=1,per_page=20):"""按分类获取产品列表（带缓存）"""cache_key=f'products:category:{category}:page:{page}:per_page:{per_page}'products=cache.get(cache_key)ifproductsisNone:print(f"缓存未命中，查询分类{category}的产品")# 模拟数据库查询time.sleep(2)# 假设查询耗时2秒queryset=Product.objects.filter(category=category,stock__gt=0).order_by('-created_at')# 分页start=(page-1)*per_page end=start+per_page products=list(queryset.values('id','name','price','stock')[start:end])# 存入缓存，有效期5分钟cache.set(cache_key,products,timeout=300)returnproducts@staticmethoddefinvalidate_product_cache(product_id=None):"""使产品缓存失效"""ifproduct_id:# 删除单个产品缓存cache.delete(f'product:{product_id}')# 删除所有产品列表缓存# 注意：实际项目中可能需要更精细的控制# 这里简单删除所有包含'products:'的键# 实际可以使用更复杂的方法，如缓存标签# 示例：删除特定模式的键# 注意：keys() 命令在生产环境慎用# 更好的方案是使用缓存版本或单独管理缓存键@staticmethoddefget_or_set_product_stats():"""获取或设置产品统计信息"""cache_key='product_stats'stats=cache.get_or_set(cache_key,lambda:ProductCacheService._calculate_product_stats(),timeout=600# 10分钟)returnstats@staticmethoddef_calculate_product_stats():"""计算产品统计信息（耗时操作）"""print("计算产品统计信息...")time.sleep(3)# 模拟耗时计算return{'total_products':Product.objects.count(),'total_stock':Product.objects.aggregate(models.Sum('stock'))['stock__sum'],'average_price':Product.objects.aggregate(models.Avg('price'))['price__avg'],}

六、视图缓存

fromdjango.views.decorators.cacheimportcache_page,never_cachefromdjango.utils.decoratorsimportmethod_decoratorfromdjango.viewsimportViewfromdjango.httpimportJsonResponseimporttime# 1. 函数视图缓存@cache_page(60*5)# 缓存5分钟defexpensive_view(request):"""缓存整个视图响应"""time.sleep(2)# 模拟耗时操作returnJsonResponse({'data':'这是缓存的结果','timestamp':time.time(),'message':'这个视图被缓存了5分钟'})@cache_page(60*15)# 缓存15分钟defproduct_list_view(request,category):"""带参数的视图缓存"""# 注意：不同参数会生成不同的缓存products=ProductCacheService.get_products_by_category(category)returnJsonResponse({'products':products})# 2. 类视图缓存classCachedView(View):"""缓存的类视图"""@method_decorator(cache_page(60*10))defdispatch(self,*args,**kwargs):returnsuper().dispatch(*args,**kwargs)defget(self,request):time.sleep(1)returnJsonResponse({'message':'类视图缓存示例'})# 3. 条件缓存defconditional_cached_view(request):"""根据条件决定是否缓存"""ifrequest.user.is_staff:# 管理员不缓存returnexpensive_operation(request)# 普通用户缓存returncache_page(60*5)(expensive_operation)(request)# 4. 不缓存装饰器@never_cachedefsensitive_data_view(request):"""敏感数据，不缓存"""returnJsonResponse({'token':'sensitive_token_123456','timestamp':time.time()})

七、模板缓存

<!--在Django模板中使用缓存-->{%load cache%}<!DOCTYPE html><html><head><title>产品详情</title></head><body><h1>{{product.name}}</h1><!--1.基本模板缓存-->{%cache300product_sidebar%}<divclass="sidebar"><h3>相关产品</h3><ul>{%forrelatedinrelated_products%}<li>{{related.name}}</li>{%endfor%}</ul></div>{%endcache%}<!--2.带变量的缓存-->{%cache300product_detail product.idproduct.updated_at%}<divclass="content"><p>价格:¥{{product.price}}</p><p>库存:{{product.stock}}</p><p>描述:{{product.description}}</p></div>{%endcache%}<!--3.根据用户缓存-->{%cache300user_recommendations request.user.id%}<divclass="recommendations"><h3>为您推荐</h3>{%foriteminuser_recommendations%}<p>{{item}}</p>{%endfor%}</div>{%endcache%}<!--4.多变量组合-->{%withcache_key="product_"|add:product.id|add:"_"|add:category%}{%cache300cache_key%}<divclass="category-info">分类:{{category}}</div>{%endcache%}{%endwith%}</body></html>

八、缓存中间件

# settings.pyMIDDLEWARE=['django.middleware.cache.UpdateCacheMiddleware',# 必须第一个# ... 其他中间件 ...'django.middleware.cache.FetchFromCacheMiddleware',# 必须最后一个]# 全站缓存配置CACHE_MIDDLEWARE_ALIAS='default'CACHE_MIDDLEWARE_SECONDS=60*15# 15分钟CACHE_MIDDLEWARE_KEY_PREFIX='mysite'# views.pyfromdjango.views.decorators.cacheimportcache_controlfromdjango.views.decorators.varyimportvary_on_cookie,vary_on_headers# 控制HTTP缓存头@cache_control(public=True,max_age=300,# 客户端缓存5分钟s_maxage=600,# 代理服务器缓存10分钟must_revalidate=True)defapi_view_with_cache_control(request):"""控制HTTP缓存的视图"""returnJsonResponse({'data':'可缓存的数据'})# 根据Cookie变化缓存@vary_on_cookie@cache_page(300)defuser_specific_view(request):"""不同用户看到不同的缓存内容"""returnJsonResponse({'user':request.user.username,'data':'用户特定数据'})# 根据请求头变化缓存@vary_on_headers('User-Agent','Accept-Language')@cache_page(300)defvary_by_header_view(request):"""根据请求头变化缓存"""returnJsonResponse({'user_agent':request.META.get('HTTP_USER_AGENT'),'accept_language':request.META.get('HTTP_ACCEPT_LANGUAGE')})

九、多缓存配置

# settings.pyCACHES={'default':{'BACKEND':'django.core.cache.backends.locmem.LocMemCache','LOCATION':'unique-snowflake','TIMEOUT':300,},'user_sessions':{'BACKEND':'django_redis.cache.RedisCache','LOCATION':'redis://127.0.0.1:6379/1','OPTIONS':{'CLIENT_CLASS':'django_redis.client.DefaultClient',},'TIMEOUT':60*60*24,# 24小时},'fast_cache':{'BACKEND':'django.core.cache.backends.memcached.MemcachedCache','LOCATION':'127.0.0.1:11211','TIMEOUT':60,}}# 使用不同的缓存后端fromdjango.core.cacheimportcachesdefuse_multiple_caches():"""使用多个缓存后端"""# 获取不同的缓存default_cache=caches['default']session_cache=caches['user_sessions']fast_cache=caches['fast_cache']# 存储到不同的缓存default_cache.set('site_config',{'theme':'dark'},timeout=3600)session_cache.set(f'session:{user_id}',session_data,timeout=86400)fast_cache.set('hot_data',hot_data,timeout=60)# 从不同的缓存获取config=default_cache.get('site_config')session=session_cache.get(f'session:{user_id}')hot=fast_cache.get('hot_data')return{'config':config,'session':session,'hot':hot}

十、缓存模式和最佳实践

1. 缓存穿透防护

defget_product_safe(product_id):""" 防止缓存穿透 缓存空值避免大量请求直接打到数据库 """cache_key=f'product:{product_id}'# 尝试获取缓存product=cache.get(cache_key)ifproductisNone:# 查询数据库try:product=Product.objects.get(id=product_id)# 缓存1小时cache.set(cache_key,product,timeout=3600)exceptProduct.DoesNotExist:# 缓存空值，短时间（如1分钟）cache.set(cache_key,'NULL',timeout=60)product=Noneelifproduct=='NULL':# 空值标记product=Nonereturnproduct

2. 缓存雪崩防护

importrandomdefset_with_random_ttl(key,value,base_ttl=3600,jitter=300):""" 防止缓存雪崩 设置随机过期时间，避免大量缓存同时过期 """# 添加随机抖动ttl=base_ttl+random.randint(-jitter,jitter)cache.set(key,value,timeout=ttl)returnttl

3. 缓存预热

defwarmup_cache():"""缓存预热"""print("开始缓存预热...")# 预热热门数据hot_products=Product.objects.filter(stock__gt=0).order_by('-sales')[:100]forproductinhot_products:cache_key=f'product:{product.id}'product_data={'id':product.id,'name':product.name,'price':float(product.price),}cache.set(cache_key,product_data,timeout=3600)# 预热分类数据categories=Product.objects.values_list('category',flat=True).distinct()forcategoryincategories:cache_key=f'products:category:{category}'products=list(Product.objects.filter(category=category,stock__gt=0).values('id','name')[:20])cache.set(cache_key,products,timeout=1800)print("缓存预热完成")

4. 缓存统计

classCacheStats:"""缓存统计"""def__init__(self):self.hits=0self.misses=0defget_with_stats(self,key,default=None):"""带统计的获取"""value=cache.get(key)ifvalueisnotNone:self.hits+=1else:self.misses+=1value=defaultreturnvaluedefget_hit_rate(self):"""获取命中率"""total=self.hits+self.missesiftotal==0:return0return(self.hits/total)*100defget_stats(self):"""获取统计信息"""return{'hits':self.hits,'misses':self.misses,'total':self.hits+self.misses,'hit_rate':f"{self.get_hit_rate():.2f}%"}

十一、常见问题

1. 缓存键太长

# 解决方法：对长键进行哈希importhashlibdefget_hashed_key(key):"""对长键进行哈希"""iflen(key)>200:returnhashlib.md5(key.encode()).hexdigest()returnkey

2. 缓存不一致

# 解决方法：及时清理缓存defupdate_product_and_clear_cache(product_id,data):"""更新产品并清理相关缓存"""# 1. 更新数据库Product.objects.filter(id=product_id).update(**data)# 2. 清理相关缓存cache.delete(f'product:{product_id}')cache.delete('product_list')# 列表缓存cache.delete_pattern('products:category:*')# 如果有相关分类缓存# 3. 可选：重新设置缓存new_product=Product.objects.get(id=product_id)cache.set(f'product:{product_id}',new_product,timeout=3600)

3. 缓存序列化问题

# Django模型对象需要序列化才能缓存fromdjango.coreimportserializersdefcache_model_object(model_obj):"""缓存模型对象"""# 方法1：转换为字典data={'id':model_obj.id,'name':model_obj.name,# ... 其他字段}cache.set(f'model:{model_obj.id}',data)# 方法2：使用Django序列化serialized=serializers.serialize('json',[model_obj])cache.set(f'model_serialized:{model_obj.id}',serialized)# 方法3：使用values()查询data=Model.objects.filter(id=model_obj.id).values().first()cache.set(f'model_values:{model_obj.id}',data)