概述
从以前的文章Yii源码阅读笔记 - 路由解析 及Yii源码阅读笔记 - Model层实现能够看到Yii框架对于解析好的路由规则及数据表的schema都会根据条件尝试读写缓存 来提升应用性能。html
但缓存组件并不是核心组件，须要额外的配置，默认ID为cache，若是不使用该ID，那么就得注意同时配置好框架中使用缓存的组件。git
恰当地使用缓存组件，能明显地提升应用的性能。github
针对不一样的缓存后端（backend），Yii框架提供了多种缓存组件，如文件缓存（CFileCache）、Memcached缓存（CMemCache）、Redis缓存（CRedisCache）等。这些缓存组件（除CDummyCache外，CDummyCache并非一个有效的缓存组件）均直接继承自抽象类CCache（见文件yii/framework/caching/CCache.php）。算法
下面以使用Memcached缓存为例，分析Yii框架缓存组件的实现。sql
分析
类CMemcache所在的整个继承树（CMemcache -> CCache -> CApplicationComponent -> CComponent）上的类都没有构造方法。数据库
CMemcache的init方法实现以下：后端
public function init()
{ // 调用父类CCache的init方法 parent::init(); // 获取配置的Memcached服务器列表 $servers=$this->getServers(); // 获取一个Memcache或Memcached对象 $cache=$this->getMemCache(); if(count($servers)) { // 将配置的Memcached服务器加到池中 foreach($servers as $server) { // 可选择使用memcached php扩展，但最好别这样，由于memcached扩展不支持一些有用的配置选项，从addServer方法的参数列表就能够看出 // memcached扩展默认使用余数分步哈希算法，但可配置使用一致性哈希算法 // 应使用memcache扩展 if($this->useMemcached) $cache->addServer($server->host,$server->port,$server->weight); else $cache->addServer($server->host,$server->port,$server->persistent,$server->weight,$server->timeout,$server->retryInterval,$server->status); } } // 若是没有配置服务器列表，则默认使用localhost:11211 else $cache->addServer('localhost',11211); }
其中调用的父类的init方法实现以下：缓存
public function init()
{ parent::init(); // 能够为整个应用的缓存的key加一个统一的前缀，这是为了不在同一个缓存池中，不一样应用的key冲突 if($this->keyPrefix===null) // 若是没有配置keyPrefix，则以应用的id做为keyPrefix，这个key，能够配置，若是未配置，则`sprintf('%x',crc32($this->getBasePath().$this->name))`这样生成， // 其中name表示应用的名称，可配置，默认为“My Application” // getId方法定义于抽象类CApplication中 $this->keyPrefix=Yii::app()->getId(); }
CMemcache的init方法中调用的方法getServers和getMemcache，实现以下所示：服务器
public function getMemCache()
{ // 单例 if($this->_cache!==null) return $this->_cache; else { // 仍是用memcache吧 $extension=$this->useMemcached ? 'memcached' : 'memcache'; // 检测一下是否记载了所需扩展 if(!extension_loaded($extension)) throw new CException(Yii::t('yii',"CMemCache requires PHP {extension} extension to be loaded.", array('{extension}'=>$extension))); // 实例化 return $this->_cache=$this->useMemcached ? new Memcached : new Memcache; } } public function getServers() { return $this->_servers; }
与getServers对应的有方法setServers，若是须要配置缓存服务器列表，则应该为缓存组件配置servers一项，基本形式为：
'servers'=>array(
array( 'host'=>'127.0.0.1', 'port'=>11211, ), ),
setServers方法实现以下：
public function setServers($config)
{ foreach($config as $c) $this->_servers[]=new CMemCacheServerConfiguration($c); }
其中实例化的类CMemCacheServerConfiguration也定义于文件yii/framework/caching/CMemCache.php中，其构造方法实现以下：
public function __construct($config)
{ if(is_array($config)) { foreach($config as $key=>$value) $this->$key=$value; if($this->host===null) throw new CException(Yii::t('yii','CMemCache server configuration must have "host" value.')); } else throw new CException(Yii::t('yii','CMemCache server configuration must be an array.')); }
从该构造方法能够看到该类的做用就是将一个Memcached缓存服务器的配置信息封装成一个配置类对象。该类有以下public的属性：
/**
* @var string memcache server hostname or IP address */ public $host; /** * @var integer memcache server port */ public $port=11211; /** * @var boolean whether to use a persistent connection */ public $persistent=true; /** * @var integer probability of using this server among all servers. */ public $weight=1; /** * @var integer value in seconds which will be used for connecting to the server */ public $timeout=15; /** * @var integer how often a failed server will be retried (in seconds) */ public $retryInterval=15; /** * @var boolean if the server should be flagged as online upon a failure */ public $status=true;
这些属性也便是每台缓存服务器的可配置项，固然若是用的是memcached扩展，某些配置项就用不上了。
类CCache定义了访问控制类型public的方法get、mget、set、add、delete、flush，对应Yii框架缓存组件提供的几个操做，即开发者可使用这些方法来操做缓存。
// 根据单个key，获取对应的value
public function get($id) { // generateUniqueKey是根据$id来生成一个惟一的key，也即真正存到缓存的key并非get方法的$id参数值 $value = $this->getValue($this->generateUniqueKey($id)); // 若是设置为不进行序列化，则直接返回取得的值 if($value===false || $this->serializer===false) return $value; // 若是未设置serializer，则说明存储时使用的是默认的序列化方法，取到数据后对应地须要使用默认的方法进行反序列化 if($this->serializer===null) $value=unserialize($value); else // 不然，使用指定的方法进行反序列化 $value=call_user_func($this->serializer[1], $value); // 依赖检查，若是依赖没有变，则说明缓存有效， // 不然，返回false，表示缓存无效 // 咦，不要清掉无效的缓存项么？ if(is_array($value) && (!$value[1] instanceof ICacheDependency || !$value[1]->getHasChanged())) { Yii::trace('Serving "'.$id.'" from cache','system.caching.'.get_class($this)); return $value[0]; } else return false; } // 根据多个key值（$ids），获取多个value public function mget($ids) { $uids = array(); foreach ($ids as $id) $uids[$id] = $this->generateUniqueKey($id); $values = $this->getValues($uids); $results = array(); if($this->serializer === false) { foreach ($uids as $id => $uid) $results[$id] = isset($values[$uid]) ? $values[$uid] : false; } else { foreach($uids as $id => $uid) { $results[$id] = false; if(isset($values[$uid])) { $value = $this->serializer === null ? unserialize($values[$uid]) : call_user_func($this->serializer[1], $values[$uid]); if(is_array($value) && (!$value[1] instanceof ICacheDependency || !$value[1]->getHasChanged())) { Yii::trace('Serving "'.$id.'" from cache','system.caching.'.get_class($this)); $results[$id] = $value[0]; } } } } return $results; } // 向$id存储一个元素值为 $value public function set($id,$value,$expire=0,$dependency=null) { Yii::trace('Saving "'.$id.'" to cache','system.caching.'.get_class($this)); if ($dependency !== null && $this->serializer !== false) // 获取依赖值 $dependency->evaluateDependency(); // 连同依赖一块儿序列化而后缓存起来 // 下次获取缓存后，检查一下依赖是否发生变动，是则说明缓存已经失效 if ($this->serializer === null) $value = serialize(array($value,$dependency)); elseif ($this->serializer !== false) $value = call_user_func($this->serializer[0], array($value,$dependency)); return $this->setValue($this->generateUniqueKey($id), $value, $expire); } // 在缓存服务器以前不存在$id时， 以id做为key存储一个变量$value到缓存服务器 public function add($id,$value,$expire=0,$dependency=null) { Yii::trace('Adding "'.$id.'" to cache','system.caching.'.get_class($this)); if ($dependency !== null && $this->serializer !== false) $dependency->evaluateDependency(); if ($this->serializer === null) $value = serialize(array($value,$dependency)); elseif ($this->serializer !== false) $value = call_user_func($this->serializer[0], array($value,$dependency)); return $this->addValue($this->generateUniqueKey($id), $value, $expire); } // 根据id删除缓存项 public function delete($id) { Yii::trace('Deleting "'.$id.'" from cache','system.caching.'.get_class($this)); return $this->deleteValue($this->generateUniqueKey($id)); } // 清空缓存 public function flush() { Yii::trace('Flushing cache','system.caching.'.get_class($this)); return $this->flushValues(); }
从上述代码中能够看到，每种操做方法实际上都是调用另外一个方法来完成操做：
- get -> getValue
- mget -> getValues
- set -> setValue
- add -> addValue
- delete -> deleteValue
- flush -> flushValues
但抽象类CCache中对于后面的这些方法并无真正实现操做逻辑（除了getValues，其实现是循环调用getValue，也许并非开发者想要的实现，CMemCache类重写了这个方法），须要在继承类中实现。CMemCache类中对这些方法实现以下：
protected function getValue($key)
{ return $this->_cache->get($key); } protected function getValues($keys) { return $this->useMemcached ? $this->_cache->getMulti($keys) : $this->_cache->get($keys); } protected function setValue($key,$value,$expire) { // 注意：这个地方对于开发者来讲也许是个坑 // 该方法的参数$expire并非一个时间点，而是一个时间间隔 // $expire = 0表示不会超时失效 if($expire>0) $expire+=time(); else $expire=0; // 使用memcache扩展时，add方法的那个额外参数值0，对应参数flag，表示是否对数据使用zlib进行压缩 return $this->useMemcached ? $this->_cache->set($key,$value,$expire) : $this->_cache->set($key,$value,0,$expire); } protected function addValue($key,$value,$expire) { if($expire>0) $expire+=time(); else $expire=0; return $this->useMemcached ? $this->_cache->add($key,$value,$expire) : $this->_cache->add($key,$value,0,$expire); } protected function deleteValue($key) { return $this->_cache->delete($key, 0); } protected function flushValues() { return $this->_cache->flush(); }
方法get、mget、set、add、delete、flush的实现有两点须要注意：
- 实际存储的key并非方法调用时提供的key，而是通过方法
generateUniqueKey处理的 - 实际存储的value多是通过序列化的，并且可能还包含依赖值
关于第一点，generateUniqueKey方法在抽象类CCache中实现以下所示：
/**
* @param string $key a key identifying a value to be cached * @return string a key generated from the provided key which ensures the uniqueness across applications */ protected function generateUniqueKey($key) { return $this->hashKey ? md5($this->keyPrefix.$key) : $this->keyPrefix.$key; }
将本来的$key拼接上统一的前缀，若是须要，还进行md5哈希，这样能保证不一样的应用之间不会有key冲突。属性hashKey默认值为true。
关于第二点，缓存依赖的概念简单来讲就是在取到一个缓存项后，判断该缓存项是否失效的一个条件。 以页面缓存为例，也许应用中在页面模板渲染后并无直接将结果响应给用户，而是先缓存起来，但页面可能涉及一些动态内容，这些动态内容是从数据库中某些数据生成的，为了保证正确性，下次读取页面缓存后，还得去数据库里读一下某些相关数据看是否有变动，，若是有变动，则须要从新渲染页面模板，若是没有变动，则直接将缓存的结果返回给用户。这样对于某些变动频率不高的动态内容，在请求处理时就能够避免没必要要的页面模板渲染过程。
判断缓存依赖是否有变动的逻辑是：在写缓存时，将当时缓存依赖的结果一并存入缓存，读缓存的时候，再将最新缓存依赖的结果与以前存入缓存的依赖结果作对比，不相同，则说明有变动。
缓存依赖类须要实现接口ICacheDependency，该接口声明了两个方法evaluateDependency和getHasChanged。
以缓存依赖类CDbCacheDependency为例（见文件yii/framework/caching/dependencies/CDbCacheDependency.php）， 该类直接继承自类CCacheDependency。类CDbCacheDependency的做用就是根据一条SQL语句从数据库查询数据，而后根据查询结果来判断缓存是否有效。
父类CCacheDependency中实现方法evaluateDependency和getHasChanged，以下所示：
/**
* Evaluates the dependency by generating and saving the data related with dependency. * This method is invoked by cache before writing data into it. */ public function evaluateDependency() { // 判断是否复用缓存依赖结果 // 默认为false，可在实例化缓存依赖类时设置 // 另外对于PHP来讲，这个“复用”也只能是一次请求处理过程当中的复用 if ($this->reuseDependentData) { // hash方法：求当前对象序列化结果的sha1哈希值 $hash=$this->getHash(); if(!isset(self::$_reusableData[$hash]['dependentData'])) // 若是没有结果可复用，则得从新生成 self::$_reusableData[$hash]['dependentData']=$this->generateDependentData(); $this->_data=self::$_reusableData[$hash]['dependentData']; } else $this->_data=$this->generateDependentData(); } /** * @return boolean whether the dependency has changed. */ // 这个方法实际上是读缓存时，从缓存数据中取出缓存依赖的部分反序列化后获得一个依赖对象，由该依赖对象调用它的这个方法来判断缓存依赖是否有变动， // 因此它的_data属性是写缓存时的缓存依赖数据 public function getHasChanged() { if ($this->reuseDependentData) { $hash=$this->getHash(); if(!isset(self::$_reusableData[$hash]['dependentData'])) self::$_reusableData[$hash]['dependentData']=$this->generateDependentData(); // 不相等，则说明发生了变动 return self::$_reusableData[$hash]['dependentData']!=$this->_data; } else return $this->generateDependentData()!=$this->_data; }
但父类CCacheDependency并未有效实现上述两个方法中调用的generateDependentData方法，在类CDbCacheDependency中实现以下：
protected function generateDependentData()
{ if($this->sql!==null) { // 获取数据库链接组件对象 $db=$this->getDbConnection(); // 准备SQL执行，其中sql属性在构造方法中赋值 $command=$db->createCommand($this->sql); if(is_array($this->params)) { // 绑定参数 foreach($this->params as $name=>$value) $command->bindValue($name,$value); } // 避免从缓存中读取数据库查询结果 if($db->queryCachingDuration>0) { // temporarily disable and re-enable query caching $duration=$db->queryCachingDuration; $db->queryCachingDuration=0; $result=$command->queryRow(); $db->queryCachingDuration=$duration; } else $result=$command->queryRow(); return $result; } else throw new CException(Yii::t('yii','CDbCacheDependency.sql cannot be empty.')); }