FlaskCache文档

安装

pip install Flask-Cache

使用

cache缓存是通过使用一个cache实例进行管理 可以使用init_app方法在初始化cache后设置它 如果有多个cache实例以及每一个实例都有不同后端的话,即是每一个实例使用不同的缓存类型cache_type, 使用配置字典
#: Method A: During instantiation of class
cache = Cache(config={‘CACHE_TYPE’: ‘simple’})

#: Method B: During init_app call
cache.init_app(app, config={'CACHE_TYPE': 'simple'})

缓存视图函数

使用装饰器cached()能够缓存视图函数, 它在默认情况下使用请求路径request.path作为cache_key

@cache.cached(timeout=50)
def index():
    return render_template('index.html')

该装饰器有一个可选的参数,unless,允许一个可调用的,返回值是True,或者Flase的函数 如果 unless返回 True,将会完全忽略缓存机制(内置的缓存机制会完全不起作用)

缓存其他函数

使用 @cached装饰器也能够缓存其它非视图函数的结果。 唯一的要求是需要指定 key_prefix, 否则会使用请求路径(request.path)作为cache_key:

@cache.cached(timeout=50, key_prefix='all_comments')
def get_all_comments():
    comments = do_serious_dbio()
    return [x.author for x in comments]

cached_comments = get_all_comments()

Memoization(一种缓存技术)

在memoization中,函数参数同样包含cache_key 如果函数不接受参数的话,cached()和memoize()两者的作用是一样的。 Memoize同样也为类成员函数而设计, 因为它根据 identity 将 ‘self’ 或者 ‘cls’ 参数考虑进作为缓存键的一部分 memoization背后的理论是:在一次请求中如果一个函数需要被调用多次,它只会计算第一次使用这些参数调用该函数。

例如,存在一个决定用户角色的 sqlalchemy对象,

在一个请求中可能需要多次调用这个函数。

为了避免每次都从数据库获取信息,你可以这样做:

《FlaskCache文档》 memoization实例.png

使用可变对象(例如类)作为缓存键的一部分是十分棘手的 最好不要让一个对象的实例成为一个memoized函数 memoize在处理参数的时候会执行repr(), 因此如果一个对象有__repr__函数,并且返回一个唯一标识该对象的字符串, 它将能够作为缓存键的一部分

删除memoize的缓存

在每个函数的基础上,您可能需要删除缓存 假设用户新拥有或者失去某些成员关系,需要删除原有的缓存记录 可以使用函数delete_memoized()

cache.delete_memoized('user_has_membership')

如果仅仅只有函数名作为参数,所有的memoized的版本将会无效的 可以删除特定的缓存提供缓存时相同的参数值

user_has_membership('demo', 'admin')
user_has_membership('demo', 'user')

cache.delete_memoized('user_has_membership', 'demo', 'user')

配置flask-cache

flask-cache的配置选项,

此外,如果标准的Flask配置项 TESTING 使用并且设置为True的话, 

Flask-Cache 将只会使用NullCache作为缓存类型

《FlaskCache文档》 配置选项.png

内建的缓存类型

NullCache – null(不缓存内容)
SimpleCache – simple(使用本地Python字典缓存。这不是真正的线程安全)
FileSystemCache – filesystem(使用文件系统来存储缓存值)
MemcachedCache – memcached

使用memcached服务器作为后端。支持pylibmc或memcache或谷歌应用程序引擎的memcache库 相关配置项: CACHE_DEFAULT_TIMEOUT CACHE_KEY_PREFIX CACHE_MEMCACHED_SERVERS CACHE_ARGS CACHE_OPTIONS

GAEMemcachedCache – gaememcached

MemcachedCache一个不同的名称

SASLMemcachedCache – saslmemcached

使用memcached服务器作为后端。 使用SASL建立与memcached服务器的连接。 pylibmc是必须的, libmemcached必须支持SASL。 相关配置项 CACHE_DEFAULT_TIMEOUT CACHE_KEY_PREFIX CACHE_MEMCACHED_SERVERS CACHE_MEMCACHED_USERNAME CACHE_MEMCACHED_PASSWORD CACHE_ARGS CACHE_OPTIONS

SpreadSASLMemcachedCache – spreadsaslmemcachedcache

与SASLMemcachedCache一样,但是如果大于memcached的传输安全性,默认是1M,能够跨不同的键名缓存值。 使用pickle模块

RedisCache – redis

CACHE_DEFAULT_TIMEOUT CACHE_KEY_PREFIX CACHE_REDIS_HOST CACHE_REDIS_PORT CACHE_REDIS_PASSWORD CACHE_REDIS_DB CACHE_ARGS CACHE_OPTIONS CACHE_REDIS_URL

定制缓存后端(后台)

你能够轻易的定制缓存后端,只需要导入一个能够实例化以及返回缓存对象的函数 CACHE_TYPE将是你自定义的函数名的字符串, 函数可以包含三个参数:app,args,kwargs 你自定义的缓存对象必须是 werkzeug.contrib.cache.BaseCache的子类。 确保threshold 是包含在kwargs参数中, 因为它是所有BaseCache类通用的

引用
flaskcache官方文档

    原文作者:一曲广陵散
    原文地址: https://www.jianshu.com/p/051e9f344180
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞