flask caching缓存(flask 110)

官方文档:https://pythonhosted.org/Flask-Caching/#

为了尽量减少缓存穿透,同时减少web的响应时间,我们可以针对那些需要一定时间才能获取结果的函数和那些不需要频繁更新的视图函数提供缓存服务,可以在一定的时间内直接返回结果而不是每次都需要计算或者从数据库中查找。flask_caching插件就是提供这种功能的神器。

flask_caching
安装
pip install Flask-Caching
初始化配置

init.py

from flask import Flask
from extensions import cache
from setting import Config
app = Flask(name)
app.config.from_object(Config)

可以使用config参数添加配置

cache.init_app(app=app,config={'CACHE_TYPE' : 'simple'})

extensions.py

from flask_caching import Cache

cache = Cache()

也可以使用配置文件的方式,推荐使用这种方式

setting.py

class Config:
CACHE_TYPE = 'simple'
常用配置参数详解
CACHE_TYPE:设置缓存的类型

下面五个参数是所有的类型共有的

CACHE_NO_NULL_WARNING = "warning" # null类型时的警告消息
CACHE_ARGS = [] # 在缓存类实例化过程中解包和传递的可选列表,用来配置相关后端的额外的参数
CACHE_OPTIONS = {} # 可选字典,在缓存类实例化期间传递,也是用来配置相关后端的额外的键值对参数
CACHE_DEFAULT_TIMEOUT # 默认过期/超时时间,单位为秒
CACHE_THRESHOLD # 缓存的最大条目数

CACHE_TYPE = null # 默认的缓存类型,无缓存
CACHE_TYPE = 'simple' # 使用本地python字典进行存储,线程非安全

CACHE_TYPE = 'filesystem' # 使用文件系统来存储缓存的值
CACHE_DIR = "" # 文件目录

CACHE_TYPE = 'memcached' # 使用memcached服务器缓存
CACHE_KEY_PREFIX # 设置cache_key的前缀
CAHCE_MEMCACHED_SERVERS # 服务器地址的列表或元组
CACHE_MEMCACHED_USERNAME # 用户名
CACHE_MEMCACHED_PASSWORD # 密码

CACHE_TYPE = 'uwsgi' # 使用uwsgi服务器作为缓存
CACHE_UWSGI_NAME # 要连接的uwsgi缓存实例的名称

CACHE_TYPE = 'redis' # 使用redis作为缓存
CACHE_KEY_PREFIX # 设置cache_key的前缀
CACHE_REDIS_HOST # redis地址
CACHE_REDIS_PORT # redis端口
CACHE_REDIS_PASSWORD # redis密码
CACHE_REDIS_DB # 使用哪个数据库

也可以一键配置

CACHE_REDIS_URL 连接到Redis服务器的URL。示例redis://user:password@localhost:6379/2
配置多个缓存实例
如果有多个缓存需要使用不同的缓存后端,则可以备用多个字典;

cache1 = Cache()
cache2 = Cache()
cache1.init_app(app, config={ 'CACHE_TYPE' : 'redis','CACHE_REDIS_HOST':'192.168.1.20',
'CACHE_REDIS_PORT':'6390'})
cache2.init_app(app, config={ 'CACHE_TYPE' : 'redis','CACHE_REDIS_HOST':'192.168.1.21',
'CACHE_REDIS_PORT':'6390'})
使用实例
缓存函数或视图函数

init.py

from flask import Flask, current_app, make_response, request
from test import get_result, test_xxx
from exsentions import cache

app = Flask(name)
app.config['SECRET_KEY'] = '123'

配置缓存后端

cache.init_app(app, config={ 'CACHE_TYPE' : 'redis','CACHE_REDIS_HOST':'192.168.1.20',
'CACHE_REDIS_PORT':'6390'})

@app.route('/test1')
def test():
form_dict = request.args
n = form_dict.get('n')
res = get_result(int(n)) # 调用函数,结果会被缓存
return res

@app.route('/test2')
@cache.cached(timeout=30) # 专门为装饰视图函数准备的装饰器
def test2():
cache.delete_memoized(get_result,4) # 删除缓存数据
return 'ok'

@app.route('/test3')
def test3():
res = test_xxx()
return res

if name == 'main':
app.run(host='127.0.0.1', port=80, debug=True)

extensions.py

from flask_caching import Cache
cache = Cache()

test.py

from exsentions import cache

装饰有参的函数

@cache.memoize(timeout=60, make_name='get_result')
def get_result(n):
return str(n)

@cache.cached(timeout=30)
def test_xxx():
return 'this is a test'
缓存键值对

init.py

from flask import Flask, current_app, make_response, request
from test import get_result, test_xxx
from exsentions import cache

app = Flask(name)
app.config['SECRET_KEY'] = '123'
cache.init_app(app, config={ 'CACHE_TYPE' : 'redis','CACHE_REDIS_HOST':'192.168.1.20',
'CACHE_REDIS_PORT':'6390'})

@app.route('/test1')
def test():
cache.set('name','xiaoming', timeout=30)
cache.set('person',{'name':'aaa', 'age':20})
x = cache.get('name')
print(x)
cache.set_many([('name1','hhh'),('name2','jjj')])
print(cache.get_many("name1","name2"))
print(cache.delete("name"))
print(cache.delete_many("name1","name2"))
return res

if name == 'main':
app.run(host='127.0.0.1', port=80, debug=True)
分析
Cache对象
Cache作为缓存对象,主要有三个参数:
app:app对象
with_jinja2_ext:是否支持jinja2语法,默认True
config:配置参数
主要方法
cache.cached:装饰器,装饰无参数函数,使得该函数结果可以缓存
参数:
timeout:超时时间
key_prefix:设置该函数的标志
unless:设置是否启用缓存,如果为True,不启用缓存
forced_update:设置缓存是否实时更新,如果为True,无论是否过期都将更新缓存
query_string:为True时,缓存键是先将参数排序然后哈希的结果

cache.memoize:装饰器,装饰有参数函数,使得该函数结果可以缓存
make_name:设置函数的标志,如果没有就使用装饰的函数

其他参数同cached

cache.delete_memoized:删除缓存
参数:
fname:缓存函数的名字或引用
*args:函数参数

cache.clear() # 清除缓存所有的缓存,这个操作需要慎重
cache.cache # 获取缓存对象
BaseCache对象
所有类型的缓存对象都继承自flask框架的BaseCache,它定义了一个使用缓存的标准接口,通过继承BaseCache实现这些接口就可以在flask中方便的集成各种缓存;而flask_caching插件为我们对redis、memcached等实现了接口,做好了适配工作,我们可以直接使用。

from werkzeug.contrib.cache import BaseCache

标准接口

clear():清除缓存
get(key):获取一个键的值,如果值是json格式会自动转化成字典
set(key,value,timeout):设置一个键值,value可以是字典,会自动转化json格式的字符串
set_many(key,value,timeout):设置多个键值对
add(key, value, timeout=None):设置一个键值,如果存在就pass,注意和set的区别
delete(key):删除键
delete_many(k1,k2...):删除多个键值
get_many(k1,k2...):获取多个键的值
get_dict(k1,k2...):获取多个键的值,返回一个字典
has(k):查询是否存在一个键
inc(self, key, delta=1):将键的值加一
dec(self, key, delta=1):将键的值减一
自定义缓存后端
如果flask_caching当前集成的缓存服务器不符合我们的要求,比如需要使用mongodb做为后端缓存,那么我们可以自己实现那些标准接口。

mycache.py

定义缓存类

from werkzeug.contrib.cache import BaseCache

class MongoCache(BaseCache):
def init(self, host='localhost', port=27017, username=None, password=None, default_timeout=500,**kwargs):
BaseCache.init(self, default_timeout)
if isinstance(host, str):
try:
from pymongo import MongoClient
except ImportError:
raise RuntimeError('no pymongo module found')
self._client = MongoClient(host=host,port=port, username=username, password=password, **kwargs)
else:
self._client = host

# 接下来使用pymongo实现BaseCache的各个接口
pass

def mongo(app, config, args, kwargs):
"""
这里处理app传进来的参数用来连接mongodb
:param app:
:param config:
:param args:
:param kwargs:
:return:
"""
args.append(app.config['MONGO_SERVERS'])
return MongoCache(*args, **kwargs)

初始化时

init.py

from flask import Flask, current_app, make_response, request
from exsentions import cache

app = Flask(name)
app.config['SECRET_KEY'] = '123'
cache.init_app(app, config={ 'CACHE_TYPE' : 'mycache.mongo',
'MONGO_SERVERS':'mongodb://username:passwd@localhost:27017/db'})

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,716评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,558评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,431评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,127评论 0 209
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,511评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,692评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,915评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,664评论 0 202
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,412评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,616评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,105评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,424评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,098评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,096评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,869评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,748评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,641评论 2 271

推荐阅读更多精彩内容

  • 一、Flask-Bootstrap插件 安装pip install flask-bootstrap 初始化在ext...
    陈small末阅读 368评论 0 0
  • FLASK框架 简介: flask是一个非常小的python web框架 只提供了一个强劲的核心 其它都...
    riverstation阅读 1,954评论 2 38
  • NOSQL类型简介键值对:会使用到一个哈希表,表中有一个特定的键和一个指针指向特定的数据,如redis,volde...
    MicoCube阅读 3,902评论 2 27
  • 缓存是最直接有效提升系统性能的手段之一。个人认为用好用对缓存是优秀程序员的必备基本素质。 本文结合实际开发经验,从...
    Java小生阅读 753评论 1 3
  • 既然你这么任性,那就把你的任性走好
    惺惜衡晟阅读 131评论 0 0