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

相关文章

Springboot中分析SQL性能的两种方式详解

《Springboot中分析SQL性能的两种方式详解》文章介绍了SQL性能分析的两种方式:MyBatis-Plus性能分析插件和p6spy框架,MyBatis-Plus插件配置简单,适用于开发和测试环... 目录SQL性能分析的两种方式:功能介绍实现方式:实现步骤:SQL性能分析的两种方式:功能介绍记录

最长公共子序列问题的深度分析与Java实现方式

《最长公共子序列问题的深度分析与Java实现方式》本文详细介绍了最长公共子序列(LCS)问题,包括其概念、暴力解法、动态规划解法,并提供了Java代码实现,暴力解法虽然简单,但在大数据处理中效率较低,... 目录最长公共子序列问题概述问题理解与示例分析暴力解法思路与示例代码动态规划解法DP 表的构建与意义动

C#使用DeepSeek API实现自然语言处理,文本分类和情感分析

《C#使用DeepSeekAPI实现自然语言处理,文本分类和情感分析》在C#中使用DeepSeekAPI可以实现多种功能,例如自然语言处理、文本分类、情感分析等,本文主要为大家介绍了具体实现步骤,... 目录准备工作文本生成文本分类问答系统代码生成翻译功能文本摘要文本校对图像描述生成总结在C#中使用Deep

Go中sync.Once源码的深度讲解

《Go中sync.Once源码的深度讲解》sync.Once是Go语言标准库中的一个同步原语,用于确保某个操作只执行一次,本文将从源码出发为大家详细介绍一下sync.Once的具体使用,x希望对大家有... 目录概念简单示例源码解读总结概念sync.Once是Go语言标准库中的一个同步原语,用于确保某个操

Redis主从/哨兵机制原理分析

《Redis主从/哨兵机制原理分析》本文介绍了Redis的主从复制和哨兵机制,主从复制实现了数据的热备份和负载均衡,而哨兵机制可以监控Redis集群,实现自动故障转移,哨兵机制通过监控、下线、选举和故... 目录一、主从复制1.1 什么是主从复制1.2 主从复制的作用1.3 主从复制原理1.3.1 全量复制

Redis主从复制的原理分析

《Redis主从复制的原理分析》Redis主从复制通过将数据镜像到多个从节点,实现高可用性和扩展性,主从复制包括初次全量同步和增量同步两个阶段,为优化复制性能,可以采用AOF持久化、调整复制超时时间、... 目录Redis主从复制的原理主从复制概述配置主从复制数据同步过程复制一致性与延迟故障转移机制监控与维

Redis连接失败:客户端IP不在白名单中的问题分析与解决方案

《Redis连接失败:客户端IP不在白名单中的问题分析与解决方案》在现代分布式系统中,Redis作为一种高性能的内存数据库,被广泛应用于缓存、消息队列、会话存储等场景,然而,在实际使用过程中,我们可能... 目录一、问题背景二、错误分析1. 错误信息解读2. 根本原因三、解决方案1. 将客户端IP添加到Re

Java汇编源码如何查看环境搭建

《Java汇编源码如何查看环境搭建》:本文主要介绍如何在IntelliJIDEA开发环境中搭建字节码和汇编环境,以便更好地进行代码调优和JVM学习,首先,介绍了如何配置IntelliJIDEA以方... 目录一、简介二、在IDEA开发环境中搭建汇编环境2.1 在IDEA中搭建字节码查看环境2.1.1 搭建步

Redis主从复制实现原理分析

《Redis主从复制实现原理分析》Redis主从复制通过Sync和CommandPropagate阶段实现数据同步,2.8版本后引入Psync指令,根据复制偏移量进行全量或部分同步,优化了数据传输效率... 目录Redis主DodMIK从复制实现原理实现原理Psync: 2.8版本后总结Redis主从复制实

锐捷和腾达哪个好? 两个品牌路由器对比分析

《锐捷和腾达哪个好?两个品牌路由器对比分析》在选择路由器时,Tenda和锐捷都是备受关注的品牌,各自有独特的产品特点和市场定位,选择哪个品牌的路由器更合适,实际上取决于你的具体需求和使用场景,我们从... 在选购路由器时,锐捷和腾达都是市场上备受关注的品牌,但它们的定位和特点却有所不同。锐捷更偏向企业级和专