Detailed explanation of cache usage in YII Framework framework tutorial

The example in this article describes the usage of YII Framework framework cache. Share it with everyone for your reference, the details are as follows:

The reasons for caching are well known. Therefore, as an efficient and easy-to-use framework, YII cannot but support caching. Therefore, YII provides interfaces for various popular caches, and you can use different caches according to your needs.

1.Introduction to caching in YII

The cache in YII is defined through components, specifically in the following directory

/yii_dev/yii/framework/caching# tree
.
├── CApcCache.php
├── CCache.php
├── CDbCache.php
├── CDummyCache.php
├── CEAcceleratorCache.php
├── CFileCache.php
├── CMemCache.php
├── CWinCache.php
├── CXCache.php
├── CZendDataCache.php
└── dependencies
├── CCacheDependency.php
├── CCacheDependency.php
├── CDbCacheDependency.php
├── CDirectoryCacheDependency.php
├── CExpressionDependency.php
├ ── CFileCacheDependency.php
└── CGlobalStateCacheDependency.php

1 directory, 17 files

The official original text is explained as follows:

Yii provides different caching components, Cache data can be stored on different media. For example, the CMemCache component encapsulates PHP's memcache extension and uses memory as the cache storage medium. The CApcCache component encapsulates the PHP APC extension; and the CDbCache component stores cached data in the database. Here is a list of available caching components:

CMemCache: Uses the PHP memcache extension.

CApcCache: Uses the PHP APC extension.

CXCache: Uses the PHP XCache extension. Note that this is supported starting from version 1.0.1.

CEAcceleratorCache: Use PHP EAccelerator extension.

CDbCache: Use a data table to store cache data. By default, it will create and use a SQLite3 database in the runtime directory. You can also specify a database for it to use by setting its connectionID property.

CZendDataCache: Use Zend Data Cache as the backend caching medium. Note that this is supported starting from version 1.0.4.

CFileCache: Use files to store cache data. This is particularly useful for storing large chunks of data (such as pages). Note that this is supported starting from version 1.0.6.

CDummyCache: Currently dummy cache does not implement caching function. The purpose of this component is to simplify code that needs to check cache availability. For example, we can use this caching component during the development phase or when the server does not yet support actual caching functionality. When actual caching support is enabled, we can switch to using the corresponding caching component. In both cases, we can use the same code Yii::app()->cache->get($key) to get the data fragment without worrying that Yii::app()->cache may is null. This component is supported since version 1.0.5.

Tip: Since all these caching components inherit from the same base class CCache, you can switch to using another caching method without changing the code that uses the cache.

Caching can be used at different levels. At the lowest level, we use caches to store individual pieces of data, such as variables. We call this data caching. At the next level, we store in the cache a page fragment generated as part of the view script. And in the highest level, we store the entire page in cache and retrieve it when needed.

In the next few sections, we will explain in detail how to use caching at these levels.

Note: By definition, a cache is an unstable storage medium. Even if there is no timeout, it does not ensure that the cached data will exist. Therefore, do not use cache as persistent storage. (For example, do not use cache to store Session data).

2. Cache configuration and calling method

The cache in yii is mainly implemented through components. The specific configuration method can be configured through the cache class description.

Usually the class that specifies the cache component

For example, apc

'cache'=>array(
  'class'=>'system.caching.CApcCache'
),

The configuration method of memcache may be

* array(
*   'components'=>array(
*     'cache'=>array(
*       'class'=>'CMemCache',
*       'servers'=>array(
*         array(
*           'host'=>'server1',
*           'port'=>11211,
*           'weight'=>60,
*         ),
*         array(
*           'host'=>'server2',
*           'port'=>11211,
*           'weight'=>40,
*         ),
*       ),
*     ),
*   ),
* )

Usage method:

Yii encapsulates methods for different cache operations, mainly focusing on CCache. CCache is the base class for all Cache classes. Therefore, the calling method after configuring the cache is very simple:

<?php
/**
 * CCache is the base class for cache classes with different cache storage implementation.
 *
 * A data item can be stored in cache by calling {@link set} and be retrieved back
 * later by {@link get}. In both operations, a key identifying the data item is required.
 * An expiration time and/or a dependency can also be specified when calling {@link set}.
 * If the data item expires or the dependency changes, calling {@link get} will not
 * return back the data item.
 *
 * Note, by definition, cache does not ensure the existence of a value
 * even if it does not expire. Cache is not meant to be a persistent storage.
 *
 * CCache implements the interface {@link ICache} with the following methods:
 * <ul>
 * <li>{@link get} : retrieve the value with a key (if any) from cache</li>
 * <li>{@link set} : store the value with a key into cache</li>
 * <li>{@link add} : store the value only if cache does not have this key</li>
 * <li>{@link delete} : delete the value with the specified key from cache</li>
 * <li>{@link flush} : delete all values from cache</li>
 * </ul>
 *
 * Child classes must implement the following methods:
 * <ul>
 * <li>{@link getValue}</li>
 * <li>{@link setValue}</li>
 * <li>{@link addValue}</li>
 * <li>{@link deleteValue}</li>
 * <li>{@link flush} (optional)</li>
 * </ul>
 *
 * CCache also implements ArrayAccess so that it can be used like an array.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @version $Id: CCache.php 3001 2011-02-24 16:42:44Z alexander.makarow $
 * @package system.caching
 * @since 1.0
 */
abstract class CCache extends CApplicationComponent implements ICache, ArrayAccess
{

According to the CCache class description, it can be seen that the common cache operation methods get, set, add, delete, flush

/**
 * Retrieves a value from cache with a specified key.
 * @param string $id a key identifying the cached value
 * @return mixed the value stored in cache, false if the value is not in the cache, expired or the dependency has changed.
 */
public function get($id)
{
  if(($value=$this->getValue($this->generateUniqueKey($id)))!==false)
  {
    $data=unserialize($value);
    if(!is_array($data))
      return false;
    if(!($data[1] instanceof ICacheDependency) || !$data[1]->getHasChanged())
    {
      Yii::trace('Serving "'.$id.'" from cache','system.caching.'.get_class($this));
      return $data[0];
    }
  }
  return false;
}
/**
 * Retrieves multiple values from cache with the specified keys.
 * Some caches (such as memcache, apc) allow retrieving multiple cached values at one time,
 * which may improve the performance since it reduces the communication cost.
 * In case a cache doesn't support this feature natively, it will be simulated by this method.
 * @param array $ids list of keys identifying the cached values
 * @return array list of cached values corresponding to the specified keys. The array
 * is returned in terms of (key,value) pairs.
 * If a value is not cached or expired, the corresponding array value will be false.
 * @since 1.0.8
 */
public function mget($ids)
{
  $uniqueIDs=array();
  $results=array();
  foreach($ids as $id)
  {
    $uniqueIDs[$id]=$this->generateUniqueKey($id);
    $results[$id]=false;
  }
  $values=$this->getValues($uniqueIDs);
  foreach($uniqueIDs as $id=>$uniqueID)
  {
    if(!isset($values[$uniqueID]))
      continue;
    $data=unserialize($values[$uniqueID]);
    if(is_array($data) && (!($data[1] instanceof ICacheDependency) || !$data[1]->getHasChanged()))
    {
      Yii::trace('Serving "'.$id.'" from cache','system.caching.'.get_class($this));
      $results[$id]=$data[0];
    }
  }
  return $results;
}
/**
 * Stores a value identified by a key into cache.
 * If the cache already contains such a key, the existing value and
 * expiration time will be replaced with the new ones.
 *
 * @param string $id the key identifying the value to be cached
 * @param mixed $value the value to be cached
 * @param integer $expire the number of seconds in which the cached value will expire. 0 means never expire.
 * @param ICacheDependency $dependency dependency of the cached item. If the dependency changes, the item is labeled invalid.
 * @return boolean true if the value is successfully stored into cache, false otherwise
 */
public function set($id,$value,$expire=0,$dependency=null)
{
  Yii::trace('Saving "'.$id.'" to cache','system.caching.'.get_class($this));
  if($dependency!==null)
    $dependency->evaluateDependency();
  $data=array($value,$dependency);
  return $this->setValue($this->generateUniqueKey($id),serialize($data),$expire);
}
/**
 * Stores a value identified by a key into cache if the cache does not contain this key.
 * Nothing will be done if the cache already contains the key.
 * @param string $id the key identifying the value to be cached
 * @param mixed $value the value to be cached
 * @param integer $expire the number of seconds in which the cached value will expire. 0 means never expire.
 * @param ICacheDependency $dependency dependency of the cached item. If the dependency changes, the item is labeled invalid.
 * @return boolean true if the value is successfully stored into cache, false otherwise
 */
public function add($id,$value,$expire=0,$dependency=null)
{
  Yii::trace('Adding "'.$id.'" to cache','system.caching.'.get_class($this));
  if($dependency!==null)
    $dependency->evaluateDependency();
  $data=array($value,$dependency);
  return $this->addValue($this->generateUniqueKey($id),serialize($data),$expire);
}
/**
 * Deletes a value with the specified key from cache
 * @param string $id the key of the value to be deleted
 * @return boolean if no error happens during deletion
 */
public function delete($id)
{
  Yii::trace('Deleting "'.$id.'" from cache','system.caching.'.get_class($this));
  return $this->deleteValue($this->generateUniqueKey($id));
}
/**
 * Deletes all values from cache.
 * Be careful of performing this operation if the cache is shared by multiple applications.
 * @return boolean whether the flush operation was successful.
 */
public function flush()
{
  Yii::trace('Flushing cache','system.caching.'.get_class($this));
  return $this->flushValues();
}

are:

Yii::app()->cache->xxx

xxx corresponds to the specific method.

For example:

$id = 'key1';
$value = 'cache value';
Yii::app()->cache->add($id, $value);
var_dump(Yii::app()->cache->get($id));

The following are the instructions for using several caching methods officially given by Yii. It is insensitive and copied here

3. Cache usage: data caching

Data caching

Data caching stores some PHP variables in the cache and then retrieves them from the cache later. For this purpose, the cache component's base class CCache provides the two most commonly used methods: set() and get().

To store a variable $value in the cache, we choose a unique ID and call set() to store it:

Yii::app()->cache->set($id, $value);

缓存的数据将一直留在缓存中，除非它由于某些缓存策略（例如缓存空间已满，旧的数据被删除）而被清除。 要改变这种行为，我们可以在调用 set() 的同时提供一个过期参数，这样在设定的时间段之后，缓存数据将被清除：

// 值$value 在缓存中最多保留30秒
Yii::app()->cache->set($id, $value, 30);

稍后当我们需要访问此变量时（在同一个或不同的 Web 请求中），就可以通过 ID 调用 get() 从缓存中将其取回。 如果返回的是 false，表示此值在缓存中不可用，我们应该重新生成它。

$value=Yii::app()->cache->get($id);
if($value===false)
{
  // 因为在缓存中没找到 $value ，重新生成它 ，
  // 并将它存入缓存以备以后使用：
  // Yii::app()->cache->set($id,$value);
}

为要存入缓存的变量选择 ID 时，要确保此 ID 对应用中所有其他存入缓存的变量是唯一的。 而在不同的应用之间，这个 ID 不需要是唯一的。缓存组件具有足够的智慧区分不同应用中的 ID。

一些缓存存储器，例如 MemCache, APC, 支持以批量模式获取多个缓存值。这可以减少获取缓存数据时带来的开销。 从版本 1.0.8 起，Yii 提供了一个新的名为 mget() 的方法。它可以利用此功能。如果底层缓存存储器不支持此功能，mget() 依然可以模拟实现它。

要从缓存中清除一个缓存值，调用 delete(); 要清楚缓存中的所有数据，调用 flush()。 当调用 flush() 时一定要小心，因为它会同时清除其他应用中的缓存。

提示: 由于 CCache 实现了 ArrayAccess，缓存组件也可以像一个数组一样使用。下面是几个例子：

$cache=Yii::app()->cache;
$cache['var1']=$value1; // 相当于: $cache->set('var1',$value1);
$value2=$cache['var2']; // 相当于: $value2=$cache->get('var2');

1. 缓存依赖

除了过期设置，缓存数据也可能会因为依赖条件发生变化而失效。例如，如果我们缓存了某些文件的内容，而这些文件发生了改变，我们就应该让缓存的数据失效， 并从文件中读取最新内容而不是从缓存中读取。

我们将一个依赖关系表现为一个 CCacheDependency 或其子类的实例。 当调用 set() 时，我们连同要缓存的数据将其一同传入。

// 此值将在30秒后失效
// 也可能因依赖的文件发生了变化而更快失效
Yii::app()->cache->set($id, $value, 30, new CFileCacheDependency('FileName'));

现在如果我们通过调用get() 从缓存中获取 $value ，依赖关系将被检查，如果发生改变，我们将会得到一个 false 值，表示数据需要被重新生成。

如下是可用的缓存依赖的简要说明：

CFileCacheDependency: 如果文件的最后修改时间发生改变，则依赖改变。
CDirectoryCacheDependency: 如果目录和其子目录中的文件发生改变，则依赖改变。
CDbCacheDependency: 如果指定 SQL 语句的查询结果发生改变，则依赖改变。
CGlobalStateCacheDependency: 如果指定的全局状态发生改变，则依赖改变。全局状态是应用中的一个跨请求，跨会话的变量。它是通过 CApplication::setGlobalState() 定义的。
CChainedCacheDependency: 如果链中的任何依赖发生改变，则此依赖改变。
CExpressionDependency: 如果指定的 PHP 表达式的结果发生改变，则依赖改变。此类从版本 1.0.4 起可用。

4.缓存的使用:片段缓存

片段缓存(Fragment Caching)

片段缓存指缓存网页某片段。例如，如果一个页面在表中显示每年的销售摘要，我们可以存储此表在缓存中，减少每次请求需要重新产生的时间。

要使用片段缓存，在控制器视图脚本中调用CController::beginCache() 和CController::endCache() 。这两种方法开始和结束包括的页面内容将被缓存。类似data caching ，我们需要一个编号，识别被缓存的片段。

...别的HTML内容...
<?php if($this->beginCache($id)) { ?>
...被缓存的内容...
<?php $this->endCache(); } ?>
...别的HTML内容...

如果我们不设定期限，它将默认为60 ，这意味着60秒后缓存内容将无效。

依赖(Dependency)

像data caching ，内容片段被缓存也可以有依赖。例如，文章的内容被显示取决于文章是否被修改。

要指定一个依赖，我们建立了dependency选项，可以是一个实现[ICacheDependency]的对象或可用于生成依赖对象的配置数组。下面的代码指定片段内容取决于lastModified 列的值是否变化：

...其他HTML内容...
<?php if($this->beginCache($id, array(&#39;dependency&#39;=>array(
    &#39;class&#39;=>&#39;system.caching.dependencies.CDbCacheDependency&#39;,
    &#39;sql&#39;=>&#39;SELECT MAX(lastModified) FROM Post&#39;)))) { ?>
...被缓存的内容...
<?php $this->endCache(); } ?>
...其他HTML内容...

变化(Variation)

缓存的内容可根据一些参数变化。例如，每个人的档案都不一样。缓存的档案内容将根据每个人ID变化。这意味着，当调用beginCache()时将用不同的ID。

COutputCache内置了这一特征，程序员不需要编写根据ID变动内容的模式。以下是摘要。

varyByRoute: 设置此选项为true ，缓存的内容将根据route变化。因此，每个控制器和行动的组合将有一个单独的缓存内容。
varyBySession: 设置此选项为true ，缓存的内容将根据session ID变化。因此，每个用户会话可能会看到由缓存提供的不同内容。
varyByParam: 设置此选项的数组里的名字，缓存的内容将根据GET参数的值变动。例如，如果一个页面显示文章的内容根据id的GET参数，我们可以指定varyByParam为array('id')，以使我们能够缓存每篇文章内容。如果没有这样的变化，我们只能能够缓存某一文章。

varyByExpression: by setting this option to a PHP expression, we can make the cached content to be variated according to the result of this PHP expression. This option has been available since version 1.0.4.
Request Types

有时候，我们希望片段缓存只对某些类型的请求启用。例如，对于某张网页上显示表单，我们只想要缓存initially requested表单(通过GET请求)。任何随后显示（通过POST请求）的表单将不被缓存，因为表单可能包含用户输入。要做到这一点，我们可以指定requestTypes 选项：

...其他HTML内容...
<?php if($this->beginCache($id, array(&#39;requestTypes&#39;=>array(&#39;GET&#39;)))) { ?>
...被缓存的内容...
<?php $this->endCache(); } ?>
...其他HTML内容...

2. 嵌套缓存(Nested Caching)

片段缓存可以嵌套。就是说一个缓存片段附在一个更大的片段缓存里。例如，意见缓存在内部片段缓存，而且它们一起在外部缓存中在文章内容里缓存。

...其他HTML内容...
<?php if($this->beginCache($id1)) { ?>
...外部被缓存内容...
  <?php if($this->beginCache($id2)) { ?>
  ...内部被缓存内容...
  <?php $this->endCache(); } ?>
...外部被缓存内容...
<?php $this->endCache(); } ?>
...其他HTML内容...

嵌套缓存可以设定不同的缓存选项。例如， 在上面的例子中内部缓存和外部缓存可以设置时间长短不同的持续值。当数据存储在外部缓存无效，内部缓存仍然可以提供有效的内部片段。 然而，反之就不行了。如果外部缓存包含有效的数据， 它会永远保持缓存副本，即使内容中的内部缓存已经过期。

5.缓存的使用:页面缓存

页面缓存

页面缓存指的是缓存整个页面的内容。页面缓存可以发生在不同的地方。 例如，通过选择适当的页面头，客户端的浏览器可能会缓存网页浏览有限时间。 Web应用程序本身也可以在缓存中存储网页内容。 在本节中，我们侧重于后一种办法。

页面缓存可以被看作是 片段缓存一个特殊情况 。 由于网页内容是往往通过应用布局来生成，如果我们只是简单的在布局中调用beginCache() 和endCache()，将无法正常工作。 这是因为布局在CController::render()方法里的加载是在页面内容产生之后。

如果想要缓存整个页面，我们应该跳过产生网页内容的动作执行。我们可以使用COutputCache作为动作 过滤器来完成这一任务。下面的代码演示如何配置缓存过滤器：

public function filters()
{
  return array(
    array(
      'COutputCache',
      'duration'=>100,
      'varyByParam'=>array('id'),
    ),
  );
}

上述过滤器配置会使过滤器适用于控制器中的所有行动。 我们可能会限制它在一个或几个行动通过使用插件操作器。 更多的细节中可以看过滤器。

Tip: 我们可以使用COutputCache作为一个过滤器，因为它从CFilterWidget继承过来， 这意味着它是一个工具(widget)和一个过滤器。事实上，widget的工作方式和过滤器非常相似： 工具widget (过滤器filter)是在action动作里的内容执行前执行，在执行后结束。

6.缓存的使用:动态内容

动态内容(Dynamic Content)

当使用fragment caching或page caching，我们常常遇到的这样的情况 整个部分的输出除了个别地方都是静态的。例如，帮助页可能会显示静态的帮助 信息，而用户名称显示的是当前用户的。

解决这个问题，我们可以根据用户名匹配缓存内容，但是这将是我们宝贵空间一个巨大的浪费，因为缓存除了用户名其他大部分内容是相同的。我们还可以把网页切成几个片段并分别缓存，但这种情况会使页面和代码变得非常复杂。更好的方法是使用由[ CController ]提供的动态内容dynamic content功能 。

动态内容是指片段输出即使是在片段缓存包括的内容中也不会被缓存。即使是包括的内容是从缓存中取出，为了使动态内容在所有时间是动态的，每次都得重新生成。出于这个原因，我们要求 动态内容通过一些方法或函数生成。

调用CController::renderDynamic()在你想的地方插入动态内容。

...别的HTML内容...
<?php if($this->beginCache($id)) { ?>
...被缓存的片段内容...
  <?php $this->renderDynamic($callback); ?>
...被缓存的片段内容...
<?php $this->endCache(); } ?>
...别的HTML内容...

在上面的， $callback指的是有效的PHP回调。它可以是指向当前控制器类的方法或者全局函数的字符串名。它也可以是一个数组名指向一个类的方法。其他任何的参数，将传递到renderDynamic()方法中。回调将返回动态内容而不是仅仅显示它。

希望本文所述对大家基于Yii框架的PHP程序设计有所帮助。

更多YII Framework框架教程之缓存用法详解相关文章请关注PHP中文网！