Django低级缓存API

有时，缓存整个页面不会让你获益很多，事实上，过度的矫正原来的不方便，变得更加不方便。

也许，例如，您的网站包含的结果取决于几个昂贵的查询，其结果在不同的时间间隔都有所不同。 在这种情况下，使用每个站点或每个视图缓存策略提供的全页缓存是不理想的，因为你不想缓存整个结果（因为一些数据经常变化），但你仍然想要缓存很少变化的结果。

对于这个情况 Django提供了一个底层的 cache API. 你可以用这个 API来储存在缓存中的对象，并且控制粒度随你喜欢。 您可以缓存可以安全pickle的任何Python对象：模型对象的字符串，字典，列表等等。 （最常见的Python对象可以Pickle;参考Python文档有关pickle更多信息。）

访问缓存

django.core.cache.caches

你可以通过 类字典对象django.core.cache.caches访问配置在CACHES 设置中的字典类对象. 对同一线程相同的别名重复请求将返回相同的对象。

>>> from django.core.cache import caches
>>> cache1 = caches['myalias']
>>> cache2 = caches['myalias']
>>> cache1 is cache2
True

 

如果key不存在，就会引发一个 InvalidCacheBackendError 。

为了提供线程安全， 不同的缓存实例将会返回给每一个线程。

django.core.cache.cache

作为一个快捷方式，默认缓存可用为django.core.cache.cache：

>>> from django.core.cache import cache

此对象等效于caches['default']。

基本用法

最基本的接口是 set(key, value, timeout) 和 get(key):

>>> cache.set('my_key', 'hello, world!', 30)
>>> cache.get('my_key')
'hello, world!'

key应该是Python 2上的str（或unicode），而value可以是任何可挑选的Python对象。

timeout参数是可选的，默认为CACHES设置中适当后端的timeout参数（如上所述）。 它是值应该存储在缓存中的秒数。 传递None给timeout将永久缓存该值。 timeout为0将不会缓存该值。

如果对象不存在于缓存中，则cache.get()返回None：

>>> # Wait 30 seconds for 'my_key' to expire...
>>> cache.get('my_key')
None

我们建议不要在缓存中存储文本值None，因为您将无法区分您存储的None值和由返回值表示的缓存未命中None。

cache.get()可以采用defualt参数。 如果对象不存在于缓存中，则指定返回哪个值：

>>> cache.get('my_key', 'has expired')
'has expired'

要添加键（如果它尚不存在），请使用add()方法。 它使用与set()相同的参数，但如果指定的键已经存在，它不会尝试更新缓存：

>>> cache.set('add_key', 'Initial value')
>>> cache.add('add_key', 'New value')
>>> cache.get('add_key')
'Initial value'

如果你需要知道add()是否在缓存中存储了一个值，你可以检查返回值。 如果值存储，则返回False，否则返回True。

如果要获取键的值或设置一个值，如果该键不在缓存中，则有get_or_set()方法。 它采用与get()相同的参数，但默认设置为该键的新缓存值，而不是简单地返回：

>>> cache.get('my_new_key')  # returns None
>>> cache.get_or_set('my_new_key', 'my new value', 100)
'my new value'

 

您还可以传递任何可调用作为默认值值：

>>> import datetime
>>> cache.get_or_set('some-timestamp-key', datetime.datetime.now)
datetime.datetime(2014, 12, 11, 0, 15, 49, 457920)

还有一个get_many()接口，只会命中一次缓存。 get_many()返回一个字典，其中包含您请求的所有实际存在于缓存中的键（并且未过期）：

>>> cache.set('a', 1)
>>> cache.set('b', 2)
>>> cache.set('c', 3)
>>> cache.get_many(['a', 'b', 'c'])
{'a': 1, 'b': 2, 'c': 3}

 

要更有效地设置多个值，请使用set_many()传递键值对的字典：

>>> cache.set_many({'a': 1, 'b': 2, 'c': 3})
>>> cache.get_many(['a', 'b', 'c'])
{'a': 1, 'b': 2, 'c': 3}

像cache.set()，set_many()采用可选的timeout参数。

您可以使用delete()显式删除键。 这是清除特定对象的缓存的简单方法：

>>> cache.delete('a')

如果您想一次清除一堆键，delete_many()可以取得要清除的键列表：

>>> cache.delete_many(['a', 'b', 'c'])

最后，如果要删除缓存中的所有键，请使用cache.clear()。 小心这个； clear()将从缓存中删除所有，而不仅仅是应用程序设置的键。

>>> cache.clear()

您还可以使用decr()或incr()方法分别递增或递减已存在的键。 默认情况下，现有高速缓存值将递增或递减1。 可以通过向增量/减量调用提供参数来指定其他增量/减量值。 如果尝试增加或减少不存在的缓存密钥，则会引发ValueError。:

>> cache.set('num', 1)
>>> cache.incr('num')
2
>>> cache.incr('num', 10)
12
>>> cache.decr('num')
11
>>> cache.decr('num', 5)
6

 

decr() / incr()方法不能保证是原子的。 在那些支持原子递增/递减（最明显的是memcached后端）的后端，递增和递减操作将是原子的。 然而，如果后端本身不提供增量/减量操作，则它将使用两步检索/更新来实现。

 

如果由缓存后端实现，您可以使用close()关闭与缓存的连接。

>>> cache.close()

对于不实现close方法的缓存，它是一个无操作。