PythonのTornadoフレームワークでsessionがサポートする実装コードを分析する

9187 ワード

tornadoにはセッションはありませんか?いいえ、もちろんあります.githubには必ず誰かが私に~O(∩∩)O~を書いてくれたことを知っています.そこで、次のプロジェクトを見つけて、memcachedでtornadoのsessionを実現します.使うだけじゃだめだよ.どうやって書いたか見てみよう.
プロジェクトアドレス:tornado-memcached-sessionsまずdemoから見てみましょう....
      app.py中:まず、tornadoに継承する新しいApplicationクラスが定義されていることに注意してください.web.アプリケーションは、このクラスの初期化方法で、適用パラメータsettingsを設定した後、親クラスとsession_を初期化します.manager.(これは何ですか?しばらくは気にしないで...)

class Application(tornado.web.Application): 
  def __init__(self): 
    settings = dict( 
      #    cookie_secret,    secure_cookie 
      cookie_secret = "e446976943b4e8442f099fed1f3fea28462d5832f483a0ed9a3d5d3859f==78d", 
      #    session_secret      session_id 
      session_secret = "3cdcb1f00803b6e78ab50b466a40b9977db396840c28307f428b25e2277f1bcc", 
      # memcached    
      memcached_address = ["127.0.0.1:11211"], 
      # session      
      session_timeout = 60, 
      template_path = os.path.join(os.path.dirname(__file__), "templates"), 
      static_path = os.path.join(os.path.dirname(__file__), "static"), 
      xsrf_cookies = True, 
      login_url = "/login", 
    ) 
 
    handlers = [ 
      (r"/", MainHandler), 
      (r"/login", LoginHandler) 
    ] 
 
    #       tornado.web.Application 
    tornado.web.Application.__init__(self, handlers, **settings) 
    #        session_manager 
    self.session_manager = session.SessionManager(settings["session_secret"], settings["memcached_address"], settings["session_timeout"]) 

次のLoginHandlerではsessionの使用を見ることができます.

class LoginHandler(BaseHandler): 
  def get(self): 
    self.render("login.html") 
 
  def post(self): 
    #             
    self.session["user_name"] = self.get_argument("name") 
    #        session   save,          ... 
    self.session.save() 
    self.redirect("/") 

使用から見ると非常に簡潔ではっきりしているのではないでしょうか.では、注意深いあなたは今のhandlerがtornadoに受け継がれていないことに気づいたのではないでしょうか.web.RequestHandler?強い探求(zuo)索(si)精神を持ってbaseを開いた.py.ああ、短い...△ああ、どこへ行ったんですか.BaseHandlerの方法は初期化してget_を書き直しただけですcurrent_userのユーザーログイン検証のための方法.

class BaseHandler(tornado.web.RequestHandler): 
  def __init__(self, *argc, **argkw): 
    super(BaseHandler, self).__init__(*argc, **argkw) 
    #    handler   session,   ,   HTTP   ,            Session    ,             
    self.session = session.Session(self.application.session_manager, self) 
 
  #      ?      ...  google    tornado.web.authenticated,      tornado         
  def get_current_user(self): 
    return self.session.get("user_name") 

ここを見て、満足していますか?ああ、やっと理解できました!..もしもし、いい探索(zuo)索(si)精神は?重要なのはセッションだpy!君は茫然とした顔で振り向いた....
まず必要なライブラリを見てみましょう:pickleはシーケンス化の逆シーケンス化のためのライブラリです(分かりませんか?jsonと同じように使えばいいと思っています...)hmacおよびhashlibは、暗号化文字列uuidを生成し、一意のid memcache Pythonを生成するmemcacheクライアントを生成するために使用される.
この中には、SessionData SessionとSessionManagerの3つのクラスがあります.まず最も簡単なSessionDataを見てみましょう.SessionDataは、辞書の構造でsessionデータを格納するために使用され、辞書に継承されます.実際には、辞書より2つのメンバー変数しかありません.

#     ,   session          
class SessionData(dict): 
  #        session id   hmac_key 
  def __init__(self, session_id, hmac_key): 
    self.session_id = session_id 
    self.hmac_key = hmac_key 

そして本物のSessionクラスです.SessionクラスはSessionDataに継承されています.ただし、独自の初期化方法を書き換え、saveインタフェースを定義しています.修正されたsessionデータを保存するために使用されます.

#    SessionData   
class Session(SessionData): 
  #    ,   session_manager   tornado     handler 
  def __init__(self, session_manager, request_handler): 
    self.session_manager = session_manager 
    self.request_handler = request_handler 
 
    try: 
      #        session      ,  SessionData       
      current_session = session_manager.get(request_handler) 
    except InvalidSessionException: 
      #              ,              SessionData   ,      ,        
      # session_id   hmac_key 
      current_session = session_manager.get() 
 
    #    current_session     ,            
    for key, data in current_session.iteritems(): 
      self[key] = data 
 
    #     session_id 
    self.session_id = current_session.session_id 
    #       hmac_key 
    self.hmac_key = current_session.hmac_key 
 
  #    save   ,   session       ,     session_manager   set    
  def save(self): 
    self.session_manager.set(self.request_handler, self) 

           __init__ 方法は分かりにくいですが、基本的な流れは自分のsessionを定義することです.managerとhandlerはオブジェクトを処理します.そしてセッションを通してmanagerは既存のセッションデータを取得し、これらのデータでアクセスしたユーザーのセッションを初期化します.ユーザーが初めてアクセスした場合、彼は新しいセッションデータオブジェクトを取得します.新しいユーザーである可能性があるので、ここではセッション_idとhmac_key(何の鬼)が賦課する.一方saveメソッドは、sessionデータを変更した保存インタフェースを提供し、実際にsession_を呼び出す.managerのsetメソッドは,具体的な実装はまず考慮しない.
この2つのクラスを見ると、セッションの仕事を基本的に理解し、ユーザーがアクセスするプロセスから考えることができます.BaseHandlerというエントリに注意してください.各ユーザーのアクセスはHTTPリクエストです.ユーザの最初のアクセスまたは前回のセッションが期限切れになった場合、tornadoは、BaseHandlerに継承されるhandlerオブジェクトを確立し、初期化時に新しいアクセスであるため、現在セッションにはデータがありません.その後キー/値ペアでセッションを読み書きし(セッションに辞書があるすべての操作を忘れないで)、修正後saveメソッドでセッションを保存します.ユーザが新規アクセスでない場合も上記の手順に従いますが、セッション初期化時に前のデータを取り出してこのインスタンスに保存します.ユーザーがアクセスを終了すると、HTTPは接続を切断し、handlerインスタンスは破棄され、sessionインスタンスは破棄されます(インスタンスは破棄され、データは破棄されません).
次はSessionManagerについてお話ししますね~1つ1つの関数を見てみましょう~
まず初期化,鍵の設定,memcacheアドレス,sessionタイムアウト時間である.

#           session     secret, memcache   , session       
def __init__(self, secret, memcached_address, session_timeout): 
  self.secret = secret 
  self.memcached_address = memcached_address 
  self.session_timeout = session_timeout 

次は_fetchメソッド、session_idはキーとしてmemcachedからデータを取り出し、pickleで解析データを逆シーケンス化する.

#      session_id   memcache       
def _fetch(self, session_id): 
  try: 
    #    memcache     
    mc = memcache.Client(self.memcached_address, debug=0) 
    #      
    session_data = raw_data = mc.get(session_id) 
    if raw_data != None: 
      #        timeout 
      mc.replace(session_id, raw_data, self.session_timeout, 0) 
      #      
      session_data = pickle.loads(raw_data) 
    #             ,      
    if type(session_data) == type({}): 
      return session_data 
    else: 
      return {} 
  except IOError: 
    return {} 

getセキュリティチェック後、sessionDataとしてmemcachedのデータを返す(呼び出した_fetch)メソッド.

def get(self, request_handler = None): 
 
  #       session_id   hmac_key 
  if (request_handler == None): 
    session_id = None 
    hmac_key = None 
  else: 
    # session        cookie 
    session_id = request_handler.get_secure_cookie("session_id") 
    hmac_key = request_handler.get_secure_cookie("verification") 
 
  # session_id               session_id   hmac_key 
  if session_id == None: 
    session_exists = False 
    session_id = self._generate_id() 
    hmac_key = self._generate_hmac(session_id) 
  else: 
    session_exists = True 
 
  #    hmac_key 
  check_hmac = self._generate_hmac(session_id) 
  #          
  if hmac_key != check_hmac: 
    raise InvalidSessionException() 
 
  #    SessionData    
  session = SessionData(session_id, hmac_key) 
 
  if session_exists: 
    #    _fetch      memcache    session       
    session_data = self._fetch(session_id) 
    for key, data in session_data.iteritems(): 
      session[key] = data 
 
  return session 

setメソッドについてはmemcachedのデータを更新するためです.

#      session,     handler   cookie   memcache     
def set(self, request_handler, session): 
  #        cookie 
  request_handler.set_secure_cookie("session_id", session.session_id) 
  request_handler.set_secure_cookie("verification", session.hmac_key) 
  #   pickle       
  session_data = pickle.dumps(dict(session.items()), pickle.HIGHEST_PROTOCOL) 
  #    memcache     
  mc = memcache.Client(self.memcached_address, debug=0) 
  #    memcache 
  mc.set(session.session_id, session_data, self.session_timeout, 0) 

最後の2つの関数、1つはsession_を生成することです.id、もう一つはsession_idは鍵と暗号化された後、検証のために暗号化文字列を生成する.

#    session_id 
def _generate_id(self): 
  new_id = hashlib.sha256(self.secret + str(uuid.uuid4())) 
  return new_id.hexdigest() 
 
#    hmac_key 
def _generate_hmac(self, session_id): 
  return hmac.new(session_id, self.secret, hashlib.sha256).hexdigest() 

どこでSessionManagerを初期化しましたか?最初のアプリを覚えていますか?ああ...早く帰ってひっくり返しなさい.