PHP 預設把 session 存在本機檔案系統,在單機環境沒問題,但一旦多台伺服器共用、或是需要更好的讀寫效能,就會顯得吃力。把 session 改放到 Redis 是很常見的解法,本文示範如何自訂儲存處理器。
<?php class Session_custom { private $redis; // redis實例 private $prefix = 'sess_'; // session_id前綴 // 會話開始時,會執行該方法,連接redis服務器 public function open($path, $name) { $this->redis = new Redis(); return $this->redis->connect("127.0.0.1",6379); } // 會話結束時,調用該方法,關閉redis連接 public function close() { $this->redis->close(); return true; } // 會話保存數據時調用該方法,在腳本執行完或session_write_close方法調用之後調用 public function write($session_id, $data) { return $this->redis->hMSet($this->prefix.$session_id, array('expires' => time(), 'data' => $data)); } // 在自動開始會話或者通過調用 session_start() 函數手動開始會話之後,PHP 內部調用 read 回調函數來獲取會話數據。 public function read($session_id) { if($this->redis->exists($this->prefix.$session_id)) { return $this->redis->hGet($this->prefix.$session_id, 'data'); } return ''; } // 清除會話中的數據,當調用session_destroy()函數,或者調用 session_regenerate_id()函數並且設置 destroy 參數為 TRUE 時,會調用此回調函數。 public function destroy($session_id) { if($this->redis->exists($this->prefix.$session_id)) { return $this->redis->del($this->prefix.$session_id) > 0 ? true : false; } return true; } // 垃圾回收函數,調用周期由 session.gc_probability 和 session.gc_divisor 參數控制 public function gc($maxlifetime) { $allKeys = $this->redis->keys("{$this->prefix}*"); foreach($allKeys as $key) { if($this->redis->exists($key) && $this->redis->hGet($key, 'expires') + $maxlifetime < time()) { $this->redis->del($key); } } return true; } } // 調用自定義的session處理方法 $handler = new Session_custom(); session_set_save_handler( array($handler, 'open'), array($handler, 'close'), array($handler, 'read'), array($handler, 'write'), array($handler, 'destroy'), array($handler, 'gc') ); // 下面這行代碼可以防止使用對象作為會話保存管理器時可能引發的非預期行為 register_shutdown_function('session_write_close'); session_start(); // 可以使用session了
open 與 close 負責連線的建立與釋放;read 在 session_start() 後被呼叫,用來取回資料;write 在腳本結束或呼叫 session_write_close() 時寫入;destroy 對應 session_destroy();gc 則是舊資料的清理。
這裡刻意用 hash 結構而非字串,把 data 與 expires 分開存,方便後續擴充(例如記錄登入時間、IP)。register_shutdown_function('session_write_close') 這行不可省,用物件作為保存管理器時,若不主動關寫,資料有可能來不及落盤。
第一,gc 裡用了 keys()。這個指令在 Redis 中是 O(N) 且會阻斷服務,正式環境應改用 scan 迭代,或乾脆利用 Redis 的 EXPIRE 讓它自動過期,把 gc 簡化成空實作。
第二,connect 建議加上 timeout 與 persistent 的考量;若 Redis 有設密碼,也要記得呼叫 auth()。
補充一個設定上的知識:php.ini 裡的 session.gc_probability 與 session.gc_divisor 共同決定 gc 被觸發的機率,預設值為 1 與 1000,也就是每次請求只有千分之一的机会執行。改用 Redis 後,這個機率的意義就沒那麼重要了。
如果不想自己寫,也可以直接透過 session.save_handler = redis 與 session.save_path = "tcp://127.0.0.1:6379" 兩個設定完成,程式碼完全不用動。