深入Memcache的Session数据的多服务器共享详解

/**
 *=---------------------------------------------------------------------------=
 *                         memcachesession.class.php
 *=---------------------------------------------------------------------------=
 *
 * 实现基于memcache存储的 session 功能
 *  (模拟session机制，只是利用memcache将存储媒介换成共享服务器的内存)
 *
 * 缺点：暂时没有引入不同主域的session共享机制的实现策略。即只支持同主域下的实现。
 *
 * copyright(c) 2008 by guigui. all rights reserved.
 * @author guigui <evan_gui@163.com>
 * @version $id: memcachesession.class.php, v 1.0 2008/12/22 $
 * @package systen
 * @link http://www.guigui8.com
 */

 
/**
 * class memcachesession
 *
 * 1. 设置客户端的cookie来保存sessionid
 * 2. 把用户的数据保存在服务器端，通过cookie中的session id来确定一个数据是否是用户的
 */
class memcachesession
{
   // {{{ 类成员属性定义
   public  $memobject          = null;      //memcache操作对象句柄
   private $_sessid            = '';
   private $_sesskeyprefix     = 'sess_';
   private $_sessexpiretime    = 86400;  
   private $_cookiedomain      = '.guigui8.com';   //全域cookie域名
   private $_cookiename        = '_project_memcache_sess';
   private $_cookieexpiretime  = '';   

   private $_memservers        = array('192.168.0.3' => 11211, '192.168.0.4' => 11211);
   private $_sesscontainer     = array();     //当前用户的session信息
   private static $_instance   = null;      //本类单例对象
   // }}}

 
   /**
    * 单例对象获取的静态方法。
 * (可以顺便提供memcache信息存储的服务器参数)
    *
    * @param string $host   - memcache数据存储的服务器ip
    * @param integer $port  - memcache数据存储的服务器端口号
    * @param bool $isinit   - 是否实例化对象的时候启动session
    */
   public static function getinstance($host='', $port=11211, $isinit = true) {
     if (null === self::$_instance) {
      self::$_instance = new self($host, $port, $isinit);
     }
     return self::$_instance;
   }

   /**
    * 构造函数
    *
    * @param bool $isinit - 是否实例化对象的时候启动session
    */
   private function __construct($host='', $port=11211, $isinit = false){
       !empty($host) && $this->_memservers = array(trim($host) => $port);
       $isinit && $this->start();
   }

   /**
  *=-----------------------------------------------------------------------=
  *=-----------------------------------------------------------------------=
 *      public methods
  *=-----------------------------------------------------------------------=
  *=-----------------------------------------------------------------------=
  */

   /**
    * 启动session操作
    *
    * @param int $expiretime - session失效时间,缺省是0,当浏览器关闭的时候失效, 该值单位是秒
    */
   public function start($expiretime = 0){
       $_sessid = $_cookie[$this->_cookiename];
       if (!$_sessid){
           $this->_sessid = $this->_getid();
           $this->_cookieexpiretime = ($expiretime > 0) ? time() + $expiretime : 0;
           setcookie($this->_cookiename, $this->_sessid, $this->_cookieexpiretime, "/", $this->_cookiedomain);
           $this->_initmemcacheobj();

           $this->_sesscontainer = array();
           $this->_savesession();
       } else {
           $this->_sessid = $_sessid;
           $this->_sesscontainer = $this->_getsession($_sessid);
       }       
   }

   /**
    * setsessid
    *
    * 自定义的session id，通常没有必要经过cookie操作处理的（所以省略了cookie记录session_id）
    *
    * @param string $sess_id
    * @return boolean
    */
   public function setsessid($sess_id){
       $_sessid = trim($sess_id);
       if (!$_sessid){
           return false;
       } else {
           $this->_sessid = $_sessid;
           $this->_sesscontainer = $this->_getsession($_sessid);
       }       
   }

   /**
    * 判断某个session变量是否注册
    *
    * @param string $varname -
    * @return bool 存在返回true, 不存在返回false
    */
   public function isregistered($varname){
       if (!isset($this->_sesscontainer[$varname])){
           return false;
       }
       return true;
   }   

   /**
    * 注册一个session变量
    *
    * @param string $varname - 需要注册成session的变量名
    * @param mixed $varvalue - 注册成session变量的值
    * @return bool - 该变量名已经存在返回false, 注册成功返回true
    */
   public function set($varname, $varvalue){
       $this->_sesscontainer[$varname] = $varvalue;
       $this->_savesession();
       return true;
   }

   /**
    * 获取一个已注册的session变量值
    *
    * @param string $varname - session变量的名称
    * @return mixed - 不存在的变量返回false, 存在变量返回变量值
    */
   public function get($varname){
       if (!isset($this->_sesscontainer[$varname])){
           return false;
       }
       return $this->_sesscontainer[$varname];
   }   

   /**
    * 销毁一个已注册的session变量
    *
    * @param string $varname - 需要销毁的session变量名
    * @return bool 销毁成功返回true
    */
   public function delete($varname){
       unset($this->_sesscontainer[$varname]);
       $this->_savesession();
       return true;
   }

   /**
    * 销毁所有已经注册的session变量
    *
    * @return 销毁成功返回true
    */
   public function destroy(){
       $this->_sesscontainer = array();
       $this->_savesession();
       return true;   
   }

 
   /**
    * 获取所有session变量
    *
    * @return array - 返回所有已注册的session变量值
    */
   public function getall(){
       return $this->_sesscontainer;
   }

   /**
    * 获取当前的session id
    *
    * @return string 获取的sessionid
    */
   public function getsid(){
       return $this->_sessid;
   }

   /**
    * 获取memcache的服务器信息
    *
    * @return array memcache配置数组信息
    */
   public function getmemservers(){
       return $this->_memservers;
   }

   /**
    * 设置memcache的服务器信息
    *
    * @param string $host - memcache服务器的ip
    * @param int $port - memcache服务器的端口
    */
   public function setmemservers($arr){
       $this->_memservers = $arr;
   }   

   /**
    * 添加memcache服务器
    *
    * @param string $host - memcache服务器的ip
    * @param int $port - memcache服务器的端口
    */
   public function addmemserver($host, $port){
       $this->_memservers[trim($host)] = trim($port);
       $this->memobject->addserver($host, $port);
   }  

   /**
    * 移除memcache服务器(注意，这个只是移除配置，并不能实际从memcached的连接池移除)
    *
    * @param string $host - memcache服务器的ip
    * @param int $port - memcache服务器的端口
    */
   public function removememserver($host){
  unset($this->_memservers[trim($host)]);
   }  

   /**
  *=-----------------------------------------------------------------------=
  *=-----------------------------------------------------------------------=
 *      private methods
  *=-----------------------------------------------------------------------=
  *=-----------------------------------------------------------------------=
  */

   /**
    * 生成一个session id
    *
    * @return string 返回一个32位的session id
    */
   private function _getid(){
       return md5(uniqid(microtime()));
   }

   /**
    * 获取一个保存在memcache的session key
    *
    * @param string $_sessid - 是否指定session id
    * @return string 获取到的session key
    */
   private function _getsesskey($_sessid = ''){
       $sesskey = ($_sessid == '') ? $this->_sesskeyprefix.$this->_sessid : $this->_sesskeyprefix.$_sessid;
       return $sesskey;
   }   
   /**
    * 检查保存session数据的路径是否存在
    *
    * @return bool 成功返回true
    */
   private function _initmemcacheobj(){
       if (!class_exists('memcache') || !function_exists('memcache_connect')){
           $this->_showmessage('failed: memcache extension not install, please from http://pecl.php.net download and install');
       }       
       if ($this->memobject && is_object($this->memobject)){
           return true;
       }
       $this->memobject = new memcache;
       if (!empty($this->_memservers)) {
          foreach ($this->_memservers as $_host => $_port) {
            $this->memobject->addserver($_host, $_port);
        }
       }

       return true;
   }

   /**
    * 获取session文件中的数据
    *
    * @param string $_sessid - 需要获取session数据的sessionid
    * @return unknown
    */
   private function _getsession($_sessid = ''){
       $this->_initmemcacheobj();
       $sesskey = $this->_getsesskey($_sessid);
       $sessdata = $this->memobject->get($sesskey);
       if (!is_array($sessdata) || empty($sessdata)){
         //this must be $_cookie['__sesshandler'] error!
         return array();
       }
       return $sessdata;
   }

   /**
    * 把当前的session数据保存到memcache
    *
    * @param string $_sessid - session id
    * @return 成功返回true
    */
   private function _savesession($_sessid = ''){
       $this->_initmemcacheobj();
       $sesskey = $this->_getsesskey($_sessid);

       if (empty($this->_sesscontainer)){
           $ret = @$this->memobject->set($sesskey, $this->_sesscontainer, false, $this->_sessexpiretime);
       }else{
           $ret = @$this->memobject->replace($sesskey, $this->_sesscontainer, false, $this->_sessexpiretime);
       }

       if (!$ret){
           $this->_showmessage('failed: save sessiont data failed, please check memcache server');
       }
       return true;
   }

   /**
    * 显示提示信息
    *
    * @param string $strmessage - 需要显示的信息内容
    * @param bool $isfailed - 是否是失败信息, 缺省是true
    */
   private function _showmessage($strmessage, $isfailed = true){
     return;
       if ($isfailed){
           echo ($strmessage);
       }
       echo $strmessage;
   }   

session_start();
$_session['file_session_info']= '本地文件保存的session信息'; //本地文件保存的session

$mem= memcachesession::getinstance('192.168.0.4', 11211);
$mem->addmemserver('192.168.0.4',11211);
$mem->addmemserver('192.168.0.5',11211);
//如果cookie功能不可用，则根据其他参数传递的唯一信息，设置映射为session_id
if(1) {
$sn= '838ece1033bf7c7468e873e79ba2a3ec';
$mem->setsessid($sn);
}
$mem->set('name','guigui');  //多台memcache服务器共享的session
$mem->set('addr','wuhan');  //多台memcache服务器共享的session
//$mem->destroy();

$addr= $mem->get('addr');
$_mem_session= $mem->getall();
echo"<hr>localhost file session:";
var_dump($_session);
echo"<hr>memcache session:";
var_dump($_mem_session);
//$res= $mem->delete('name');