Flask---session源码分析

2024-08-31 22:18
文章标签 分析 源码 session flask

本文主要是介绍Flask---session源码分析,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

我在Flask—上下文源码分析这篇笔记中,简单分析了下Flask的上下文管理源码分析,今天我单拎出来session来,并且结合flask-session保存到redis进行分析,先抛出一张图
这里写图片描述

当我们在项目中构造app = Flask(__name__)实例时,在发起request请求时,会执行app的__call__方法

 def __call__(self, environ, start_response):"""Shortcut for :attr:`wsgi_app`."""return self.wsgi_app(environ, start_response)

跟踪方法wsgi_app参看如下代码

ctx = self.request_context(environ)

RequestContext(self, environ)中封装了session

    def __init__(self, app, environ, request=None):self.app = appif request is None:request = app.request_class(environ)self.request = requestself.url_adapter = app.create_url_adapter(self.request)self.flashes = Noneself.session = None、、、省略部分代码、、、

然后继续回到wsgi_app方法中,在ctx = self.request_context(environ)中封装了session属性之后,在下一行代码中

 ctx.push()

进行了如下操作

self.session = self.app.open_session(self.request)

继而跟踪到class SecureCookieSessionInterface(SessionInterface)类的如下代码

  def open_session(self, app, request):s = self.get_signing_serializer(app)if s is None:return Noneval = request.cookies.get(app.session_cookie_name)if not val:return self.session_class()max_age = total_seconds(app.permanent_session_lifetime)try:data = s.loads(val, max_age=max_age)return self.session_class(data)except BadSignature:return self.session_class()

上述代码中通过get_signing_serializer拿到序列化器,通过val = request.cookies.get(app.session_cookie_name)获取浏览器Cookiesession键对应的值,然后通过data = s.loads(val, max_age=max_age)获取session数据,以下是数据格式

我们通过如下代码进行设置

session['k1'] = 123session['k2'] = 456

然后如下是输出格式:
val
eyJrMSI6MTIzLCJrMiI6NDU2fQ.DcrHQQ.WGPBpjRyamwNVxWKU7CM_YB8w4

data
{‘k1’: 123, ‘k2’: 456}

浏览器Cookie的键值对

session=eyJrMSI6MTIzLCJrMiI6NDU2fQ.DcrHQQ.WGPBpjRyamwNVxWKU7CM_YB8w4A

然后在open_session中进行如下操作

return self.session_class(data)
session_class = SecureCookieSession

是构造了一个SecureCookieSession对象,跟踪代码如下

class SecureCookieSession(CallbackDict, SessionMixin):"""Base class for sessions based on signed cookies."""def __init__(self, initial=None):def on_update(self):self.modified = TrueCallbackDict.__init__(self, initial, on_update)self.modified = False

打印出来这个对象输出如下:<SecureCookieSession {'k1': 123, 'k2': 456}>

以上就是self.session = self.app.open_session(self.request)的流程

接下来继续看wsgi_app方法,去看如下代码

response = self.full_dispatch_request()

定位到如下代码

return self.finalize_request(rv)
response = self.process_response(response)

然后在process_response方法中看看如何进行保存session

self.save_session(ctx.session, response)
    def save_session(self, session, response):return self.session_interface.save_session(self, session, response)

最后执行如下的方法

   def save_session(self, app, session, response):domain = self.get_cookie_domain(app)path = self.get_cookie_path(app)if not session:if session.modified:response.delete_cookie(app.session_cookie_name,domain=domain, path=path)returnif not self.should_set_cookie(app, session):returnhttponly = self.get_cookie_httponly(app)secure = self.get_cookie_secure(app)expires = self.get_expiration_time(app, session)val = self.get_signing_serializer(app).dumps(dict(session))response.set_cookie(app.session_cookie_name, val,expires=expires, httponly=httponly,domain=domain, path=path, secure=secure)

通过not self.should_set_cookie(app, session)进行判断是不是进行了session.modified可以修改操作
然后通过后,执行保存

val = self.get_signing_serializer(app).dumps(dict(session))response.set_cookie(app.session_cookie_name, val,expires=expires, httponly=httponly,domain=domain, path=path, secure=secure)

序列化dict(session),然后写回set_cookie即可

以上是flask的session源码部分的分析

接下里我们结合flask-session,保存redis进行简单分析

通过pip3 install redispip3 install flask_session安装

我们通过如下代码进行使用

def create_app():app = Flask(__name__)app.config.from_object('settings.DevelopmentConfig')app.register_blueprint(account.account)app.register_blueprint(home.home)# 将session替换成redis sessionSession(app)return app

Session(app)这句代码中,进行了如下的初始化操作

    def __init__(self, app=None):self.app = appif app is not None:self.init_app(app)def init_app(self, app):app.session_interface = self._get_interface(app)

然后在_get_interface方法中去设置自己的配置
如下是_get_interface方法全部代码

    def _get_interface(self, app):config = app.config.copy()config.setdefault('SESSION_TYPE', 'null')config.setdefault('SESSION_PERMANENT', True)config.setdefault('SESSION_USE_SIGNER', False)config.setdefault('SESSION_KEY_PREFIX', 'session:')config.setdefault('SESSION_REDIS', None)config.setdefault('SESSION_MEMCACHED', None)config.setdefault('SESSION_FILE_DIR',os.path.join(os.getcwd(), 'flask_session'))config.setdefault('SESSION_FILE_THRESHOLD', 500)config.setdefault('SESSION_FILE_MODE', 384)config.setdefault('SESSION_MONGODB', None)config.setdefault('SESSION_MONGODB_DB', 'flask_session')config.setdefault('SESSION_MONGODB_COLLECT', 'sessions')config.setdefault('SESSION_SQLALCHEMY', None)config.setdefault('SESSION_SQLALCHEMY_TABLE', 'sessions')if config['SESSION_TYPE'] == 'redis':session_interface = RedisSessionInterface(config['SESSION_REDIS'], config['SESSION_KEY_PREFIX'],config['SESSION_USE_SIGNER'], config['SESSION_PERMANENT'])elif config['SESSION_TYPE'] == 'memcached':session_interface = MemcachedSessionInterface(config['SESSION_MEMCACHED'], config['SESSION_KEY_PREFIX'],config['SESSION_USE_SIGNER'], config['SESSION_PERMANENT'])elif config['SESSION_TYPE'] == 'filesystem':session_interface = FileSystemSessionInterface(config['SESSION_FILE_DIR'], config['SESSION_FILE_THRESHOLD'],config['SESSION_FILE_MODE'], config['SESSION_KEY_PREFIX'],config['SESSION_USE_SIGNER'], config['SESSION_PERMANENT'])elif config['SESSION_TYPE'] == 'mongodb':session_interface = MongoDBSessionInterface(config['SESSION_MONGODB'], config['SESSION_MONGODB_DB'],config['SESSION_MONGODB_COLLECT'],config['SESSION_KEY_PREFIX'], config['SESSION_USE_SIGNER'],config['SESSION_PERMANENT'])elif config['SESSION_TYPE'] == 'sqlalchemy':session_interface = SqlAlchemySessionInterface(app, config['SESSION_SQLALCHEMY'],config['SESSION_SQLALCHEMY_TABLE'],config['SESSION_KEY_PREFIX'], config['SESSION_USE_SIGNER'],config['SESSION_PERMANENT'])else:session_interface = NullSessionInterface()return session_interface

看如下这几句代码,我们在项目中配置的

SESSION_TYPE = "redis"
SESSION_REDIS = Redis(host='192.168.0.94', port='6379')

会生成RedisSessionInterface实例对象,如下是代码

        if config['SESSION_TYPE'] == 'redis':session_interface = RedisSessionInterface(config['SESSION_REDIS'], config['SESSION_KEY_PREFIX'],config['SESSION_USE_SIGNER'], config['SESSION_PERMANENT'])

然后flask_session库构造了自己的方法,去open_sessionsave_session

   def open_session(self, app, request):sid = request.cookies.get(app.session_cookie_name)if not sid:sid = self._generate_sid()return self.session_class(sid=sid, permanent=self.permanent)if self.use_signer:signer = self._get_signer(app)if signer is None:return Nonetry:sid_as_bytes = signer.unsign(sid)sid = sid_as_bytes.decode()except BadSignature:sid = self._generate_sid()return self.session_class(sid=sid, permanent=self.permanent)if not PY2 and not isinstance(sid, text_type):sid = sid.decode('utf-8', 'strict')val = self.redis.get(self.key_prefix + sid)if val is not None:try:data = self.serializer.loads(val)return self.session_class(data, sid=sid)except:return self.session_class(sid=sid, permanent=self.permanent)return self.session_class(sid=sid, permanent=self.permanent)def save_session(self, app, session, response):domain = self.get_cookie_domain(app)path = self.get_cookie_path(app)if not session:if session.modified:self.redis.delete(self.key_prefix + session.sid)response.delete_cookie(app.session_cookie_name,domain=domain, path=path)returnhttponly = self.get_cookie_httponly(app)secure = self.get_cookie_secure(app)expires = self.get_expiration_time(app, session)val = self.serializer.dumps(dict(session))self.redis.setex(name=self.key_prefix + session.sid, value=val,time=total_seconds(app.permanent_session_lifetime))if self.use_signer:session_id = self._get_signer(app).sign(want_bytes(session.sid))else:session_id = session.sidresponse.set_cookie(app.session_cookie_name, session_id,expires=expires, httponly=httponly,domain=domain, path=path, secure=secure)

这篇关于Flask---session源码分析的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1125139

相关文章

性能分析之MySQL索引实战案例

文章目录 一、前言二、准备三、MySQL索引优化四、MySQL 索引知识回顾五、总结 一、前言 在上一讲性能工具之 JProfiler 简单登录案例分析实战中已经发现SQL没有建立索引问题,本文将一起从代码层去分析为什么没有建立索引? 开源ERP项目地址:https://gitee.com/jishenghua/JSH_ERP 二、准备 打开IDEA找到登录请求资源路径位置

JAVA智听未来一站式有声阅读平台听书系统小程序源码

智听未来,一站式有声阅读平台听书系统 🌟&nbsp;开篇:遇见未来,从“智听”开始 在这个快节奏的时代,你是否渴望在忙碌的间隙,找到一片属于自己的宁静角落?是否梦想着能随时随地,沉浸在知识的海洋,或是故事的奇幻世界里?今天,就让我带你一起探索“智听未来”——这一站式有声阅读平台听书系统,它正悄悄改变着我们的阅读方式,让未来触手可及! 📚&nbsp;第一站:海量资源,应有尽有 走进“智听

Java ArrayList扩容机制 (源码解读)

结论:初始长度为10,若所需长度小于1.5倍原长度,则按照1.5倍扩容。若不够用则按照所需长度扩容。 一. 明确类内部重要变量含义         1:数组默认长度         2:这是一个共享的空数组实例,用于明确创建长度为0时的ArrayList ,比如通过 new ArrayList<>(0),ArrayList 内部的数组 elementData 会指向这个 EMPTY_EL

如何在Visual Studio中调试.NET源码

今天偶然在看别人代码时,发现在他的代码里使用了Any判断List<T>是否为空。 我一般的做法是先判断是否为null,再判断Count。 看了一下Count的源码如下: 1 [__DynamicallyInvokable]2 public int Count3 {4 [__DynamicallyInvokable]5 get

SWAP作物生长模型安装教程、数据制备、敏感性分析、气候变化影响、R模型敏感性分析与贝叶斯优化、Fortran源代码分析、气候数据降尺度与变化影响分析

查看原文>>>全流程SWAP农业模型数据制备、敏感性分析及气候变化影响实践技术应用 SWAP模型是由荷兰瓦赫宁根大学开发的先进农作物模型,它综合考虑了土壤-水分-大气以及植被间的相互作用;是一种描述作物生长过程的一种机理性作物生长模型。它不但运用Richard方程,使其能够精确的模拟土壤中水分的运动,而且耦合了WOFOST作物模型使作物的生长描述更为科学。 本文让更多的科研人员和农业工作者

MOLE 2.5 分析分子通道和孔隙

软件介绍 生物大分子通道和孔隙在生物学中发挥着重要作用,例如在分子识别和酶底物特异性方面。 我们介绍了一种名为 MOLE 2.5 的高级软件工具,该工具旨在分析分子通道和孔隙。 与其他可用软件工具的基准测试表明,MOLE 2.5 相比更快、更强大、功能更丰富。作为一项新功能,MOLE 2.5 可以估算已识别通道的物理化学性质。 软件下载 https://pan.quark.cn/s/57

工厂ERP管理系统实现源码(JAVA)

工厂进销存管理系统是一个集采购管理、仓库管理、生产管理和销售管理于一体的综合解决方案。该系统旨在帮助企业优化流程、提高效率、降低成本,并实时掌握各环节的运营状况。 在采购管理方面,系统能够处理采购订单、供应商管理和采购入库等流程,确保采购过程的透明和高效。仓库管理方面,实现库存的精准管理,包括入库、出库、盘点等操作,确保库存数据的准确性和实时性。 生产管理模块则涵盖了生产计划制定、物料需求计划、

衡石分析平台使用手册-单机安装及启动

单机安装及启动​ 本文讲述如何在单机环境下进行 HENGSHI SENSE 安装的操作过程。 在安装前请确认网络环境,如果是隔离环境,无法连接互联网时,请先按照 离线环境安装依赖的指导进行依赖包的安装,然后按照本文的指导继续操作。如果网络环境可以连接互联网,请直接按照本文的指导进行安装。 准备工作​ 请参考安装环境文档准备安装环境。 配置用户与安装目录。 在操作前请检查您是否有 sud

线性因子模型 - 独立分量分析(ICA)篇

序言 线性因子模型是数据分析与机器学习中的一类重要模型,它们通过引入潜变量( latent variables \text{latent variables} latent variables)来更好地表征数据。其中,独立分量分析( ICA \text{ICA} ICA)作为线性因子模型的一种,以其独特的视角和广泛的应用领域而备受关注。 ICA \text{ICA} ICA旨在将观察到的复杂信号

Spring 源码解读:自定义实现Bean定义的注册与解析

引言 在Spring框架中,Bean的注册与解析是整个依赖注入流程的核心步骤。通过Bean定义,Spring容器知道如何创建、配置和管理每个Bean实例。本篇文章将通过实现一个简化版的Bean定义注册与解析机制,帮助你理解Spring框架背后的设计逻辑。我们还将对比Spring中的BeanDefinition和BeanDefinitionRegistry,以全面掌握Bean注册和解析的核心原理。