一·、什麼是session？
在解析 session 的實現之前，我們先介紹一下 session 怎麼使用。session 可以看做是在不同的請求之間保存數據的方法，因爲 HTTP 是無狀態的協議，但是在業務應用上我們希望知道不同請求是否是同一個人發起的。比如張三，王二都在自己的手機上用淘寶購物，將想購買的商品放入購物車中，當王二，張三結賬時，不能將他倆的購物車混淆了，服務器區分和保存購物車數據的方法就是session。
flask的session是基於cookie的會話保持。簡單的原理即：
當客戶端進行第一次請求時，客戶端的HTTP request（cookie爲空）到服務端，服務端創建session，視圖函數根據form表單填寫session，請求結束時，session內容填寫入response的cookie中並返回給客戶端，客戶端的cookie中便保存了用戶的數據。
當同一客戶端再次請求時， 客戶端的HTTP request中cookie已經攜帶數據，視圖函數根據cookie中值做相應操作（如已經攜帶用戶名和密碼就可以直接登陸）。
在 flask 中使用 session 也很簡單，只要使用 from flask import session 導入這個變量，在代碼中就能直接通過讀寫它和 session 交互。
from flask import Flask, session, escape, request
app = Flask(__name__)
app.secret_key = 'please-generate-a-random-secret_key'
@app.route("/")
def index():
if 'username' in session:
return 'hello, {}\n'.format(escape(session['username']))
return 'hello, stranger\n'
@app.route("/login", methods=['POST'])
def login():
session['username'] = request.form['username']
return 'login success'
if __name__ == '__main__':
app.run(host='0.0.0.0', port=5000, debug=True)
上面這段代碼模擬了一個非常簡單的登陸邏輯，用戶訪問 POST /login 來登陸，後面訪問頁面的時候 GET /，會返回該用戶的名字。
flask中session使用非常簡單，但是實現原理卻沒那麼簡單，下面我們通過幾個問題來弄清楚session是如何實現的。
二、請求第一次來時，session是什麼時候生成的？存放在哪裏？
在flask學習筆記--請求上下文和應用上下文中已經知道session是一個LocalProxy()對象：
current_app = LocalProxy(_find_app)
request = LocalProxy(partial(_lookup_req_object, 'request'))
session = LocalProxy(partial(_lookup_req_object, 'session'))
g = LocalProxy(partial(_lookup_app_object, 'g'))
客戶端的請求進來時，會調用app.wsgi_app():
def wsgi_app(self, environ, start_response):
ctx = self.request_context(environ)
error = None
try:
try:
ctx.push()
# 尋找視圖函數，並執行
# 獲取返回值 response
response = self.full_dispatch_request()
此時，會生成一個ctx，其本質是一個RequestContext對象：
class RequestContext(object):
def __init__(self, app, environ, request=None):
self.app = app
if request is None:
request = app.request_class(environ)
self.request = request
self.url_adapter = app.create_url_adapter(self.request)
self.flashes = None
self.session = None
在RequestContext 對象中定義了session，且初值爲None。
接着繼續看wsgi_app函數中，ctx.push()函數：
def push(self):
app_ctx = _app_ctx_stack.top
if app_ctx is None or app_ctx.app != self.app:
app_ctx = self.app.app_context()
app_ctx.push()
self._implicit_app_ctx_stack.append(app_ctx)
else:
self._implicit_app_ctx_stack.append(None)
if hasattr(sys, 'exc_clear'):
sys.exc_clear()
_request_ctx_stack.push(self)
if self.session is None:
session_interface = self.app.session_interface
self.session = session_interface.open_session(
self.app, self.request
)
if self.session is None:
self.session = session_interface.make_null_session(self.app)
前半部分代碼已經在之前的文章中講到，主要看後半部分代碼。判斷session是否爲空，我在RequestContext 中看到session初值爲空.
在 Flask 中，所有和 session 有關的調用，都是轉發到 self.session_interface 的方法調用上（這樣用戶就能用自定義的 session_interface 來控制 session 的使用）。而默認的 session_inerface 有默認值：
session_interface = SecureCookieSessionInterface()
執行SecureCookieSessionInterface.open_session()來生成默認session對象：
def open_session(self, app, request):
獲取session簽名的算法
s = self.get_signing_serializer(app)
如果爲空 直接返回None
if s is None:
return None
val = request.cookies.get(app.session_cookie_name)
# 如果val爲空，即request.cookies爲空
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()
請求第一次來時，request.cookies爲空，即返回self.session_class():
session_class = SecureCookieSession
看SecureCookieSession：
class SecureCookieSession(CallbackDict, SessionMixin):
modified = False
accessed = False
def __init__(self, initial=None):
def on_update(self):
self.modified = True
self.accessed = True
super(SecureCookieSession, self).__init__(initial, on_update)
def __getitem__(self, key):
self.accessed = True
return super(SecureCookieSession, self).__getitem__(key)
def get(self, key, default=None):
self.accessed = True
return super(SecureCookieSession, self).get(key, default)
def setdefault(self, key, default=None):
self.accessed = True
return super(SecureCookieSession, self).setdefault(key, default)
看其繼承關係，其實就是一個特殊的字典。到此我們知道了session就是一個特殊的字典，調用SecureCookieSessionInterface類的open_session()創建，並保存在ctx中，即RequestContext對象中。但最終由session = LocalProxy(..., 'session')對象代爲管理，到此，在視圖函數中就可以導入session並使用了。
三、當請求第二次來時，session生成的是什麼？
當請求第二次到來時，與第一次的不同就在open_session()那個val判斷處，此時cookies不爲空, 獲取cookie的有效時長，如果cookie依然有效，通過與寫入時同樣的簽名算法將cookie中的值解密出來並寫入字典並返回中，若cookie已經失效，則仍然返回'空字典'。
四、特殊的SecureCookieSession字典有那些功能？如何實現的？
默認的 session 對象是 SecureCookieSession，這個類就是一個基本的字典，外加一些特殊的屬性，比如 permanent（flask 插件會用到這個變量）、modified（表明實例是否被更新過，如果更新過就要重新計算並設置 cookie，因爲計算過程比較貴，所以如果對象沒有被修改，就直接跳過）。
怎麼知道實例的數據被更新過呢？ SecureCookieSession 是基於 werkzeug/datastructures:CallbackDict 實現的，這個類可以指定一個函數作爲 on_update 參數，每次有字典操作的時候（__setitem__、__delitem__、clear、popitem、update、pop、setdefault）會調用這個函數。
SecureCookieSession：
class SecureCookieSession(CallbackDict, SessionMixin):
modified = False
accessed = False
def __init__(self, initial=None):
def on_update(self):
self.modified = True
self.accessed = True
#將on_update()傳遞給CallbackDict
super(SecureCookieSession, self).__init__(initial, on_update)
def __getitem__(self, key):
self.accessed = True
return super(SecureCookieSession, self).__getitem__(key)
def get(self, key, default=None):
self.accessed = True
return super(SecureCookieSession, self).get(key, default)
def setdefault(self, key, default=None):
self.accessed = True
return super(SecureCookieSession, self).setdefault(key, default)
繼承的 CallbackDict：
class CallbackDict(UpdateDictMixin, dict):
def __init__(self, initial=None, on_update=None):
dict.__init__(self, initial or ())
self.on_update = on_update
def __repr__(self):
return '<%s %s>' % (
self.__class__.__name__,
dict.__repr__(self)
)
CallbackDict又繼承UpdateDictMixin:
class UpdateDictMixin(object):
on_update = None
def calls_update(name):
def oncall(self, *args, **kw):
rv = getattr(super(UpdateDictMixin, self), name)(*args, **kw)
if self.on_update is not None:
self.on_update(self)
return rv
oncall.__name__ = name
return oncall
def setdefault(self, key, default=None):
modified = key not in self
rv = super(UpdateDictMixin, self).setdefault(key, default)
if modified and self.on_update is not None:
self.on_update(self)
return rv
def pop(self, key, default=_missing):
modified = key in self
if default is _missing:
rv = super(UpdateDictMixin, self).pop(key)
else:
rv = super(UpdateDictMixin, self).pop(key, default)
if modified and self.on_update is not None:
self.on_update(self)
return rv
__setitem__ = calls_update('__setitem__')
__delitem__ = calls_update('__delitem__')
clear = calls_update('clear')
popitem = calls_update('popitem')
update = calls_update('update')
del calls_update
由UpdateDictMixin()可知，對session進行改動會調用pop, __setitem__等方法，同時就會調用on_update()方法，從而修改
modify，security的值。
五、簽名算法：
都獲取 cookie 數據的過程中，最核心的幾句話是：
s = self.get_signing_serializer(app)
val = request.cookies.get(app.session_cookie_name)
data = s.loads(val, max_age=max_age)
return self.session_class(data)
其中兩句都和 s 有關，signing_serializer 保證了 cookie 和 session 的轉換過程中的安全問題。如果 flask 發現請求的 cookie 被篡改了，它會直接放棄使用。
我們繼續看 get_signing_serializer 方法：
def get_signing_serializer(self, app):
if not app.secret_key:
return None
signer_kwargs = dict(
key_derivation=self.key_derivation,
digest_method=self.digest_method
)
return URLSafeTimedSerializer(app.secret_key,
salt=self.salt,
serializer=self.serializer,
signer_kwargs=signer_kwargs)
我們看到這裏需要用到很多參數：
-
secret_key：密鑰。這個是必須的，如果沒有配置secret_key就直接使用session會報錯 -
salt：爲了增強安全性而設置一個 salt 字符串（可以自行搜索“安全加鹽”瞭解對應的原理） -
serializer：序列算法 -
signer_kwargs：其他參數，包括摘要/hash算法（默認是sha1）和 簽名算法（默認是hmac）
URLSafeTimedSerializer 是 itsdangerous 庫的類，主要用來進行數據驗證，增加網絡中數據的安全性。itsdangerours提供了多種 Serializer，可以方便地進行類似 json 處理的數據序列化和反序列的操作。至於具體的實現，因爲篇幅限制，就不解釋了。
六、session什麼時候寫入cookie中？session的生命週期？
前面的幾個問題實際上都發生在wsgi_app()前兩句函數中，主要就是ctx.push()函數中，下面看看wsgi_app()後面幹了嘛：
def wsgi_app(self, environ, start_response):
ctx = self.request_context(environ)
error = None
try:
try:
# ctx.push函數是前半部分最重要的一個函數
# 生成request和session並將二者保存到RequestContext()對象ctxz中
# 最後將ctx,push到LocalStack()對象_request_ctx_stack中
ctx.push()
# 尋找視圖函數，並執行
response = self.full_dispatch_request()
except Exception as e:
error = e
response = self.handle_exception(e)
except:
error = sys.exc_info()[1]
raise
return response(environ, start_response)
finally:
if self.should_ignore_error(error):
error = None
# 最後， 將自己請求在local中的數據清除
ctx.auto_pop(error)
看full_dispatch_request：
def full_dispatch_request(self):
#執行before_first_request
self.try_trigger_before_first_request_functions()
try:
# 觸發request_started 信號
request_started.send(self)
# 調用before_request
rv = self.preprocess_request()
if rv is None:
#執行視圖函數
rv = self.dispatch_request()
except Exception as e:
rv = self.handle_user_exception(e)
return self.finalize_request(rv)
前半部分就在執行flask鉤子，before_first_request, before_request以及信號，接着執行視圖函數生成rv，我們主要看finalize_request(rv)：
def finalize_request(self, rv, from_error_handler=False):
response = self.make_response(rv)
try:
response = self.process_response(response)
request_finished.send(self, response=response)
except Exception:
if not from_error_handler:
raise
self.logger.exception('Request finalizing failed with an '
'error while handling an error')
return response
首先根據rv生成response。再執行process_response:
def process_response(self, response):
ctx = _request_ctx_stack.top
bp = ctx.request.blueprint
funcs = ctx._after_request_functions
if bp is not None and bp in self.after_request_funcs:
funcs = chain(funcs, reversed(self.after_request_funcs[bp]))
if None in self.after_request_funcs:
funcs = chain(funcs, reversed(self.after_request_funcs[None]))
for handler in funcs:
response = handler(response)
if not self.session_interface.is_null_session(ctx.session):
self.session_interface.save_session(self, ctx.session, response)
return response
前半部分主要執行flask的鉤子，看後面，判斷，session是否爲空，如果不爲空，則執行save_session():
def save_session(self, app, session, response):
domain = self.get_cookie_domain(app)
path = self.get_cookie_path(app)
# If the session is modified to be empty, remove the cookie.
# If the session is empty, return without setting the cookie.
if not session:
if session.modified:
response.delete_cookie(
app.session_cookie_name,
domain=domain,
path=path
)
return
# Add a "Vary: Cookie" header if the session was accessed at all.
if session.accessed:
response.vary.add('Cookie')
if not self.should_set_cookie(app, session):
return
httponly = self.get_cookie_httponly(app)
secure = self.get_cookie_secure(app)
samesite = self.get_cookie_samesite(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,
samesite=samesite
)
save_session()比較簡單，且有註釋，便不再講解，主要就是將session寫入response.set_cookie中。這樣便完成session的寫入response工作，並由response返回至客戶端。
再請求結束時會執行wsgi_app()的finally：ctx.auto_pop(error)函數，將與對應請求相關的request，session清除，session生命週期便結束。
總結：
至此，flask內置session的機制便講解完畢，session的實現是依賴與flask的上下文管理，因此先弄清楚flask上下文，再來看session就比較容易理解。其主要的就是SecureCookieSessionInterface對象的open_session()與save_session() 。open_session在請求剛進來時執行，完成session對象的創建（就是一特殊字典），在視圖函數中完成對session的賦值操作，save_session()在視圖函數執行完後，生成response後執行，將session寫入response的cookie中。
當然，flask內置session無法滿足生產需求。因爲將session數據全部保存在cookie中不安全且cookie存儲數據量有限，但flask-session組件幫我們實現了將數據保存在服務器''數據庫''中而只將sessionID保存在cookie中，下一節便會講解flask-session組建的原理。
參考：http://python.jobbole.com/87450/