Flask扩展系列(六)–缓存

如果同一个请求会被多次调用,每次调用都会消耗很多资源,并且每次返回的内容都相同,大家第一个反应就是该使用缓存了。的确对于大规模互联网应用,缓存是必不可少的,一个好的缓存设计可以使得应用的性能几何级数地上升。本篇我们将阐述如何缓存Flask的请求,并同时介绍一个缓存扩展,Flask-Cache。

系列文章

自定义缓存装饰器

在使用Flask-Cache扩展实现缓存功能之前,我们先来自己写个视图缓存装饰器,方便我们来理解视图缓存的实现。首先,我们要有一个缓存,Werkzeug框架中的提供了一个简单的缓存对象SimpleCache,它是将缓存项存放在Python解释器的内存中,我们可以用下面的代码获取SimpleCache的缓存对象:

如果你要使用第三方的缓存服务器,比如Memcached,Werkzeug框架也提供了它的wrapper:

此后你就可以使用cache对象的”set(key, value, timeout)”和”get(key)”方法来存取缓存项了。注意”set()”方法的第三个参数”timeout”是缓存过期时间,默认为0,也就是永不过期。

接下来,我们就开始写个缓存装饰器用来装饰视图函数:

这段装饰器代码还是很好理解吧,如果大家对装饰器不熟悉,可以看下这篇文章。装饰器的两个参数分别是缓存的过期时间,默认是5分钟;缓存项键值的前缀,默认是”view_”。然后我们写个视图,并使用此装饰器:

我们试下访问这个视图,对于同样的URL地址,第一次访问时,控制台上会有”view called”输出,第二次就不会了。如果过5分钟后访问,”view called”才会再次输出。

安装和启用Flask-Cache

了解了缓存装饰器的内部实现,我们就可以开始介绍Flask的缓存扩展,Flask-Cache。首先使用pip将其安装上:

$ pip install Flask-Cache

然后创建一个Flask-Cache的实例:

上例中,我们使用了’simple’类型缓存,其内部实现就是Werkzeug中的SimpleCache。我们也可以使用第三方的缓存服务器,比如Redis,代码如下:

其内部实现是”werkzeug.contrib.cache”包下的”RedisCache”,所以说Flask-Cache就是基于Werkzeug框架的Cache库实现的。

应用中使用缓存

同自定义缓存装饰器一样,我们可以用cache对象的”cached()”方法来装饰视图函数,以达到缓存视图的目的:

“cache.cached()”装饰器有三个参数:

  1. timeout:过期时间,默认为None,即永不过期
  2. key_prefix:缓存项键值的前缀,默认为”view/%s”
  3. unless:回调函数,当其返回True时,缓存不起作用。默认为None,即缓存有效

除了装饰视图函数,”cache.cached()”装饰器也可以用来装饰普通函数:

我们访问”/list”地址时,第一次控制台上会有”method called”输出,第二次就不会了,说明缓存起效了。装饰普通函数时必须指定明确的”key_prefix”参数,因为它不像视图函数,可以使用请求路径”request.path”作为缓存项的键值。另外,如果函数带参数,对于不同的参数调用,都会使用同一缓存项,即返回结果一样。但大部分时候,对于不同的输入,输出结果是不一样的,那使用缓存岂不是有问题?是的,所以Flask-Cache还提供了另一个装饰器方法”cache.memoize()”,它与”cache.cached()”的区别就是它会将函数的参数也放在缓存项的键值中:

我们再次访问”/list”地址,对于不同的参数,”method called”会一直在控制台上打印出,而对于相同的参数,第二次就不会打印了。所以对于带参数的函数,你要使用”cache.memoize()”装饰器,而对于不带参数的函数,它同”cache.cached()”基本上一样。”cache.memoize()”装饰器也有三个参数,”timeout”和”unless”参数同”cache.cached()”一样,就是第二个参数”make_name”比较特别。它是一个回调函数,传入的是被装饰的函数名,返回是一个字符串,会被作为缓存项键值的一部分,如果不设,就直接使用函数名。

删除缓存

对于普通缓存,你可以使用”delete()”方法来删除缓存项,而对于”memoize”缓存,你需要使用”delete_memoized”方法。如果想清除所有缓存,可以使用”clear()”方法。

Jinja2模板中使用缓存

上面介绍的缓存功能都是在应用代码中使用,其实在Jinja2模板中,我们还可以使用”{% cache %}”语句来缓存模板代码块:

这样”{% cache %}”和”{% endcache %}”语句中所包括的内容就会被缓存起来。”{% cache %}”语句的第一个参数是”timeout”过期时间,默认为永不过期;第二个参数指定了缓存项的键值,如果不设,键值就是”模板文件路径”+”缓存块的第一行”。上例中,我们设了键值是”temp”,然后在代码中,我们可以这样获取缓存项实际的键值:

打印出来看看,你会发现实际的键值其实是”_template_fragment_cache_temp”。如果你要删除该缓存项,记得要传入实际的键值,而不是模板上定义的’temp’。

更多参考资料

Werkzeug的Cache API文档
Flask-Login的官方文档
Flask-Login的源码

本篇的示例代码可以在这里下载

《Flask扩展系列(六)–缓存》有4个想法

  1. 请教下这个cache如何跟header中的If_None_Match的etag更新的检测结合在一起呢?比如我想判断etag是否有变化,有变化的话就不使用缓存,而返回最新的Resource,如果没有变化就使用缓存

    1. If_None_Match的etag检测跟本文所说的缓存没有太大关系,etag检测主要针对的是客户端缓存,这里说的服务器端的缓存,自问自答了

发表评论

电子邮件地址不会被公开。 必填项已用*标注