缓存 Flask-登录 user_loader

lus*_*nte 5 python flask flask-sqlalchemy flask-login flask-cache

我有这个。

@login_manager.user_loader
def load_user(id=None):
     return User.query.get(id)
Run Code Online (Sandbox Code Playgroud)

在我介绍 Flask-Principal 之前,它运行良好。

@identity_loaded.connect_via(app)
def on_identity_loaded(sender, identity):

    # Set the identity user object
    identity.user = current_user
    # return
    if hasattr(current_user, 'id'):
        identity.provides.add(UserNeed(current_user.id))

    # Assuming the User model has a list of roles, update the
    # identity with the roles that the user provides
    if hasattr(current_user, 'roles'):
        for role in current_user.roles:
            identity.provides.add(RoleNeed(role.name))
Run Code Online (Sandbox Code Playgroud)

添加它会导致严重的性能问题。SQLALCHEMY_ECHO 显示每次加载静态文件时都会查询 User 表。

#Warning: Dummy Cache
users = {}
@login_manager.user_loader
def load_user(uid=None):
    if uid not in users:
        users[uid] = User.query.get(uid)
    return users[uid]
Run Code Online (Sandbox Code Playgroud)

在这个解决重复查询问题的实验之后,我意识到我需要在我的 Flask 应用程序中引入缓存。以下是问题。

  1. 如何缓存User.query.get(id)
  2. 我什么时候需要清除这个用户缓存?

Bob*_*dan 6

老问题,但在 SO 上或通过谷歌似乎没有其他答案,我花了一段时间来解决这个问题,所以也许这个答案会对某人有所帮助。

首先,您需要一些缓存后端,我使用带有redis 的烧瓶缓存和来自 pypi的 python库 。redissudo pip install redis

接下来,执行 afrom flask_caching import Cache然后cache = Cache()我在另一个名为extensions.py. 如果您使用应用工厂模式,这一点很重要,因为您需要cache稍后导入,这有助于避免较大的 Flask 应用程序的循环引用问题。

在此之后,您需要在烧瓶应用程序上注册烧瓶缓存扩展,我做了一个app.py像这样的单独文件:

from flask import Flask
from extensions import cache

def create_app(config_obj=None):
    """An application factory"""

    app = Flask(__name__)
    app.config.from_object(config_obj)
    cache.init_app(app, config={'CACHE_TYPE': 'redis',
                               'CACHE_REDIS_HOST': '127.0.0.1',
                               'CACHE_REDIS_PORT': '6379',
                               'CACHE_REDIS_URL': 'redis://127.0.0.1:6379'})
    return app
Run Code Online (Sandbox Code Playgroud)

因此,既然已经cache在 Flask 中注册了它,就可以从extensions.py整个应用程序中导入和使用它,而不会出现循环引用问题。继续使用您正在使用的任何文件user_loader

import pickle
from flask import current_user
from extensions import cache
from models.user_models import User

@login_manager.user_loader
def load_user(user_id):
    """Load user by ID from cache, if not in cache, then cache it."""
    # make a unique cache key for each user
    user = 'user_{}'.format(user_id)
    # check if the user_object is cached
    user_obj = pickle.loads(cache.get(user)) if cache.get(user) else None
    if user_obj is None:
        query = User.query.get(int(user_id))
        user_obj = pickle.dumps(query)
        cache.set(user, user_obj, timeout=3600)
        return query
    return user_obj
Run Code Online (Sandbox Code Playgroud)

最后,当您注销用户时,您可以从缓存中删除它们:

@blueprint.route('/logout/')
@login_required
def logout():
    """Logout."""
    # remove the user information from redis cache
    user = 'user_{}'.format(current_user.id)
    cache.delete(user)
    # remove the user information from the session
    logout_user()
    # Remove session keys set by Flask-Principal
    for key in ('identity.name', 'identity.auth_type'):
        session.pop(key, None)
    flash('You are logged out.', 'info')
    return redirect(url_for('public.home')
Run Code Online (Sandbox Code Playgroud)

这似乎工作得很好,它减少了对 SQLAlchemy 的查询命中,每个用户每页减少了三个查询,并将我的应用程序的几个部分的页面加载速度提高了 200 毫秒,同时消除了达到 SQLAlchemy 连接池限制的令人讨厌的问题。

此解决方案的最后一个要点。如果出于任何原因更改用户对象,例如为用户分配新角色或能力,则必须从缓存中清除用户对象。例如像下面这样:

# set the user_id from current_user.id CACHE object
user_id = current_user.id
# remove the old USER object from cache since you will change it
# first set the cache key to user_{id}
cache_user = 'user_{}'.format(user_id)
# now delete the cache key
cache.delete(cache_user)
Run Code Online (Sandbox Code Playgroud)

背景:

我需要考虑缓存flask-login user_loader 是因为我已经通过扩展flask-login 类UserMixinAnonymousUserMixin一些类方法(如get_rolesand )实现了访问控制列表管理get_abilities。我也在使用flask-sqlalchemy 和postgresql 后端,并且有一个角色表和一个与用户对象有关系的能力表。这些用户角色和能力主要在模板中检查,以根据用户角色和能力呈现各种视图。

在某些时候,我注意到当打开多个浏览器选项卡或只是浏览器在我的应用程序中重新加载页面时,我开始收到错误消息TimeoutError: QueuePool limit of size 5 overflow 10 reached, connection timed out, timeout 30。Flask-sqlalchemy 有设置SQLALCHEMY_POOL_SIZESQLALCHEMY_MAX_OVERFLOW但增加这些值只是掩盖了我的问题,错误仍然发生,只需加载更多选项卡或进行更多页面重新加载。

深入挖掘以找出根本原因,我查询了我的 postgresql 数据库,SELECT * FROM pg_stat_activity;发现在每个请求中我都积累了多个连接,idle in transaction其中 SQL 查询明确链接到用户、角色、能力访问检查的状态。这些idle in transaction连接导致我的数据库连接池达到容量。

进一步的测试发现,缓存flask-login user_loaderUser对象消除了idle in transaction连接,然后即使我离开SQLALCHEMY_POOL_SIZESQLALCHEMY_MAX_OVERFLOW使用默认值,我也没有TimeoutError: QueuePool limit再次受到影响。问题解决了!