[Python知识库]Django缓存框架-底层缓存API

底层缓存 API

Django 公开了一个底层的缓存 API 。你可以使用这个 API 以任意级别粒度在缓存中存储对象。你可以缓存任何可以安全的 pickle 的 Python 对象：模型对象的字符串、字典、列表，或者其他。

作为快捷方式，默认缓存可以通过 django.core.cache.cache 引用：

from django.core.cache import cache

这个对象等价于 caches[‘default’] 。

基本用法
基本接口是：

cache.set(key, value, timeout=DEFAULT_TIMEOUT, version=None)
cache.set('my_key', 'hello, world!', 30)
cache.get(key, default=None, version=None)
cache.get('my_key')
'hello, world!'

key 是一个字符串，value 可以任何 picklable 形式的 Python 对象。

timeout 参数是可选的，默认为 CACHES 中相应后端的 timeout 参数。它是值存在缓存里的秒数。timeout 设置为 None 时将永久缓存。timeout 为0将不缓存值。

如果对象不在缓存中，cache.get() 将返回 None。

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

如果你需要确定对象是否存在于缓存中，并且你已经存储了一个字面值 None，使用一个前哨对象作为默认：

sentinel = object()
cache.get('my_key', sentinel) is sentinel
False
# Wait 30 seconds for 'my_key' to expire...
cache.get('my_key', sentinel) is sentinel
True

cache.get() 可以带一个默认参数。如果对象不在缓存中，将返回指定的值。

cache.get('my_key', 'has expired')
'has expired'
cache.add(key, value, timeout=DEFAULT_TIMEOUT, version=None)

在键不存在的时候，使用 add() 方法可以添加键。它与 set() 带有相同的参数，但如果指定的键已经存在，将不会尝试更新缓存。

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

如果你想知道通过 add() 存储的值是否在缓存中，你可以检查返回值。如果值已保存，将返回 True ，否则返回 False 。

如果你想得到键值或者如果键不在缓存中时设置一个值，可以使用 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'

你可以使用 delete() 显示地删除键，以清空特定对象的缓存：

cache.delete('a')
True

如果键被成功删除，将返回 delete() ，否则返回 False 。

如果你想一次性清除很多键，给 delete_many() 传递一个键列表即可删除。

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

最后，如果你想删除缓存里的所有键，使用 cache.clear()。注意，clear() 将删除缓存里的 任何 键，不只是你应用里设置的那些键。

cache.clear()
cache.touch(key, timeout=DEFAULT_TIMEOUT, version=None)

cache.touch() 为键设置一个新的过期时间。比如，更新一个键为从现在起10秒钟后过期：

cache.touch('a', 10)
True

和其他方法一样，timeout 参数是可选的，并且默认是 CACHES 设置的相应后端的 TIMEOUT 选项。

如果键被成功 touch()，将返回 True，否则返回 False。

如果缓存后端已经实现了 close() 方法，你可以关闭和缓存的连接。

cache.close()