In-depth analysis of the caching function in PHP's Yii framework. The yii framework

Data caching refers to storing some PHP variables in the cache and retrieving them from the cache when used. It is also the basis for more advanced caching features, such as query caching and content caching.

The following code is a typical data cache usage pattern. Where $cache points to the cache component:

// 嘗試從緩存中取回 $data 
$data = $cache->get($key);

if ($data === false) {

  // $data 在緩存中沒有找到，則重新計算它的值

  // 將 $data 存放到緩存供下次使用
  $cache->set($key, $data);
}

// 這兒 $data 可以使用了。

Cache component

Data caching requires support from the cache component, which represents various cache memories, such as memory, files, and databases.

Cache components are usually registered as application components so that they can be configured and accessed globally. The following code demonstrates how to configure the application component cache to use two memcached servers:

'components' => [
  'cache' => [
    'class' => 'yii\caching\MemCache',
    'servers' => [
      [
        'host' => 'server1',
        'port' => 11211,
        'weight' => 100,
      ],
      [
        'host' => 'server2',
        'port' => 11211,
        'weight' => 50,
      ],
    ],
  ],
],

Then you can access the above cache component through Yii::$app->cache.

Since all cache components support the same series of APIs, there is no need to modify the business code that uses the cache to directly replace it with other underlying cache components. It only needs to be reconfigured in the application configuration. For example, you can modify the above configuration to use yiicachingApcCache:

'components' => [
  'cache' => [
    'class' => 'yii\caching\ApcCache',
  ],
],

Tip: You can register multiple cache components. Many classes that rely on cache call the component named cache by default (such as yiiwebUrlManager).
Supported Cache Memory

Yii supports a range of cache memories, as summarized below:

• yiicachingApcCache: Use PHP APC extension. This option can be considered the fastest caching solution in a centralized application environment (e.g. single server, no separate load balancer, etc.).
• yiicachingDbCache: Use a database table to store cached data. To use this cache, you must create a table corresponding to yiicachingDbCache::cacheTable.
• yiicachingDummyCache: only serves as a cache placeholder and does not implement any real caching function. The purpose of this component is to simplify code that needs to query cache validity. For example, in development if the server does not have actual caching support, use it to configure a caching component. After a real cache service is enabled, you can switch to use the corresponding cache component. In both cases you can use the same code Yii::$app->cache->get($key) to try to retrieve the data from the cache without worrying that Yii::$app->cache may be null .
• yiicachingFileCache: Use standard files to store cache data. This is particularly useful for caching large chunks of data, such as an entire page of content.
• yiicachingMemCache: Use PHP memcache and memcached extensions. This option is considered the fastest caching solution in distributed application environments (e.g. multiple servers, load balancing, etc.).
• yiiredisCache: Implements a cache component based on Redis key-value storage (requires the support of redis 2.6.12 and above).
• yiicachingWinCache: Use PHP WinCache (see also) extension.
• yiicachingXCache: Use PHP XCache extension.
• yiicachingZendDataCache: Use Zend Data Cache as the underlying caching medium.
• Tip: You can use different cache memories in the same application. A common strategy is to use a memory-based cache for small, frequently used data (e.g., statistics) and a file- or database-based cache for larger, less frequently used data (e.g., web page content).

Caching API

All caching components have the same base class yiicachingCache, so they all support the following API:

• yiicachingCache::get(): Retrieve a piece of data from the cache through a specified key. If the data does not exist in the cache or has expired/invalidated, the value false is returned.
• yiicachingCache::set(): Specify a key for a piece of data and store it in the cache.
• yiicachingCache::add(): If the key is not found in the cache, the specified data will be stored in the cache.
• yiicachingCache::mget(): Retrieve multiple items of data from the cache by specifying multiple keys.
• yiicachingCache::mset(): Store multiple items of data in the cache, each item of data corresponds to a key.
• yiicachingCache::madd(): Store multiple items of data in the cache, each item of data corresponds to a key. If a key already exists in the cache, the data will be skipped.
• yiicachingCache::exists(): Returns a value indicating whether a key exists in the cache.
• yiicachingCache::delete(): Delete the corresponding value in the cache through a key.
• yiicachingCache::flush(): Delete all data in the cache.
• Some cache memories such as MemCache and APC support retrieving cached values ??in batch mode, which can save the cost of retrieving cached data. The yiicachingCache::mget() and yiicachingCache::madd() APIs provide support for this feature. If the underlying cache memory does not support this feature, Yii will also emulate the implementation.

Since yiicachingCache implements the PHP ArrayAccess interface, the cache component can also be used like an array. Here are a few examples:

$cache['var1'] = $value1; // 等價于： $cache->set('var1', $value1);
$value2 = $cache['var2']; // 等價于： $value2 = $cache->get('var2');

緩存鍵

存儲在緩存中的每項數(shù)據(jù)都通過鍵作唯一識別。當你在緩存中存儲一項數(shù)據(jù)時，必須為它指定一個鍵，稍后從緩存中取回數(shù)據(jù)時，也需要提供相應的鍵。

你可以使用一個字符串或者任意值作為一個緩存鍵。當鍵不是一個字符串時，它將會自動被序列化為一個字符串。

定義一個緩存鍵常見的一個策略就是在一個數(shù)組中包含所有的決定性因素。例如，yii\db\Schema 使用如下鍵存儲一個數(shù)據(jù)表的結(jié)構(gòu)信息。

[
  __CLASS__,       // 結(jié)構(gòu)類名
  $this->db->dsn,     // 數(shù)據(jù)源名稱
  $this->db->username,  // 數(shù)據(jù)庫登錄用戶名
  $name,         // 表名
];

如你所見，該鍵包含了可唯一指定一個數(shù)據(jù)庫表所需的所有必要信息。

當同一個緩存存儲器被用于多個不同的應用時，應該為每個應用指定一個唯一的緩存鍵前綴以避免緩存鍵沖突?？梢酝ㄟ^配置 yii\caching\Cache::keyPrefix 屬性實現(xiàn)。例如，在應用配置中可以編寫如下代碼：

'components' => [
  'cache' => [
    'class' => 'yii\caching\ApcCache',
    'keyPrefix' => 'myapp',    // 唯一鍵前綴
  ],
],

為了確保互通性，此處只能使用字母和數(shù)字。

緩存過期

默認情況下，緩存中的數(shù)據(jù)會永久存留，除非它被某些緩存策略強制移除（例如：緩存空間已滿，最老的數(shù)據(jù)會被移除）。要改變此特性，你可以在調(diào)用 yii\caching\Cache::set() 存儲一項數(shù)據(jù)時提供一個過期時間參數(shù)。該參數(shù)代表這項數(shù)據(jù)在緩存中可保持有效多少秒。當你調(diào)用 yii\caching\Cache::get() 取回數(shù)據(jù)時，如果它已經(jīng)過了超時時間，該方法將返回 false，表明在緩存中找不到這項數(shù)據(jù)。例如：

// 將數(shù)據(jù)在緩存中保留 45 秒
$cache->set($key, $data, 45);

sleep(50);

$data = $cache->get($key);
if ($data === false) {
  // $data 已過期，或者在緩存中找不到
}

緩存依賴

除了超時設(shè)置，緩存數(shù)據(jù)還可能受到緩存依賴的影響而失效。例如，yii\caching\FileDependency 代表對一個文件修改時間的依賴。這個依賴條件發(fā)生變化也就意味著相應的文件已經(jīng)被修改。因此，緩存中任何過期的文件內(nèi)容都應該被置為失效狀態(tài)，對 yii\caching\Cache::get() 的調(diào)用都應該返回 false。

緩存依賴用 yii\caching\Dependency 的派生類所表示。當調(diào)用 yii\caching\Cache::set() 在緩存中存儲一項數(shù)據(jù)時，可以同時傳遞一個關(guān)聯(lián)的緩存依賴對象。例如：

// 創(chuàng)建一個對 example.txt 文件修改時間的緩存依賴
$dependency = new \yii\caching\FileDependency(['fileName' => 'example.txt']);

// 緩存數(shù)據(jù)將在30秒后超時
// 如果 example.txt 被修改，它也可能被更早地置為失效狀態(tài)。
$cache->set($key, $data, 30, $dependency);

// 緩存會檢查數(shù)據(jù)是否已超時。
// 它還會檢查關(guān)聯(lián)的依賴是否已變化。
// 符合任何一個條件時都會返回 false。
$data = $cache->get($key);

下面是可用的緩存依賴的概況：

• yii\caching\ChainedDependency：如果依賴鏈上任何一個依賴產(chǎn)生變化，則依賴改變。
• yii\caching\DbDependency：如果指定 SQL 語句的查詢結(jié)果發(fā)生了變化，則依賴改變。
• yii\caching\ExpressionDependency：如果指定的 PHP 表達式執(zhí)行結(jié)果發(fā)生變化，則依賴改變。
• yii\caching\FileDependency：如果文件的最后修改時間發(fā)生變化，則依賴改變。
• yii\caching\GroupDependency：將一項緩存數(shù)據(jù)標記到一個組名，你可以通過調(diào)用 yii\caching\GroupDependency::invalidate() 一次性將相同組名的緩存全部置為失效狀態(tài)。

查詢緩存

查詢緩存是一個建立在數(shù)據(jù)緩存之上的特殊緩存特性。它用于緩存數(shù)據(jù)庫查詢的結(jié)果。

查詢緩存需要一個 yii\db\Connection 和一個有效的 cache 應用組件。查詢緩存的基本用法如下，假設(shè) $db 是一個 yii\db\Connection 實例：

$duration = 60;   // 緩存查詢結(jié)果60秒
$dependency = ...; // 可選的緩存依賴

$db->beginCache($duration, $dependency);

// ...這兒執(zhí)行數(shù)據(jù)庫查詢...

$db->endCache();

如你所見，beginCache() 和 endCache() 中間的任何查詢結(jié)果都會被緩存起來。如果緩存中找到了同樣查詢的結(jié)果，則查詢會被跳過，直接從緩存中提取結(jié)果。

查詢緩存可以用于 ActiveRecord 和 DAO。

Info: 有些 DBMS （例如：MySQL）也支持數(shù)據(jù)庫服務器端的查詢緩存。你可以選擇使用任一查詢緩存機制。上文所述的查詢緩存的好處在于你可以指定更靈活的緩存依賴因此可能更加高效。
配置

查詢緩存有兩個通過 yii\db\Connection 設(shè)置的配置項：

yii\db\Connection::queryCacheDuration: 查詢結(jié)果在緩存中的有效期，以秒表示。如果在調(diào)用 yii\db\Connection::beginCache() 時傳遞了一個顯式的時值參數(shù)，則配置中的有效期時值會被覆蓋。
yii\db\Connection::queryCache: 緩存應用組件的 ID。默認為 'cache'。只有在設(shè)置了一個有效的緩存應用組件時，查詢緩存才會有效。
限制條件

當查詢結(jié)果中含有資源句柄時，查詢緩存無法使用。例如，在有些 DBMS 中使用了 BLOB 列的時候，緩存結(jié)果會為該數(shù)據(jù)列返回一個資源句柄。

有些緩存存儲器有大小限制。例如，memcache 限制每條數(shù)據(jù)最大為 1MB。因此，如果查詢結(jié)果的大小超出了該限制，則會導致緩存失敗。

片段緩存

片段緩存指的是緩存頁面內(nèi)容中的某個片段。例如，一個頁面顯示了逐年銷售額的摘要表格，可以把表格緩存下來，以消除每次請求都要重新生成表格的耗時。片段緩存是基于數(shù)據(jù)緩存實現(xiàn)的。

在視圖中使用以下結(jié)構(gòu)啟用片段緩存：

if ($this->beginCache($id)) {

  // ... 在此生成內(nèi)容 ...

  $this->endCache();
}

調(diào)用 yii\base\View::beginCache() 和 yii\base\View::endCache() 方法包裹內(nèi)容生成邏輯。如果緩存中存在該內(nèi)容，yii\base\View::beginCache() 方法將渲染內(nèi)容并返回 false，因此將跳過內(nèi)容生成邏輯。否則，內(nèi)容生成邏輯被執(zhí)行，一直執(zhí)行到 yii\base\View::endCache() 時，生成的內(nèi)容將被捕獲并存儲在緩存中。

和[數(shù)據(jù)緩存]一樣，每個片段緩存也需要全局唯一的 $id 標記。

緩存選項

如果要為片段緩存指定額外配置項，請通過向 yii\base\View::beginCache() 方法第二個參數(shù)傳遞配置數(shù)組。在框架內(nèi)部，該數(shù)組將被用來配置一個 yii\widget\FragmentCache 小部件用以實現(xiàn)片段緩存功能。

過期時間（duration）

或許片段緩存中最常用的一個配置選項就是 yii\widgets\FragmentCache::duration 了。它指定了內(nèi)容被緩存的秒數(shù)。以下代碼緩存內(nèi)容最多一小時：

if ($this->beginCache($id, ['duration' => 3600])) {

  // ... 在此生成內(nèi)容 ...

  $this->endCache();
}

如果該選項未設(shè)置，則默認為 0，永不過期。

依賴

和[數(shù)據(jù)緩存]一樣，片段緩存的內(nèi)容一樣可以設(shè)置緩存依賴。例如一段被緩存的文章，是否重新緩存取決于它是否被修改過。

通過設(shè)置 yii\widgets\FragmentCache::dependency 選項來指定依賴，該選項的值可以是一個 yii\caching\Dependency 類的派生類，也可以是創(chuàng)建緩存對象的配置數(shù)組。以下代碼指定了一個片段緩存，它依賴于 update_at 字段是否被更改過的。

$dependency = [
  'class' => 'yii\caching\DbDependency',
  'sql' => 'SELECT MAX(updated_at) FROM post',
];

if ($this->beginCache($id, ['dependency' => $dependency])) {

  // ... 在此生成內(nèi)容 ...

  $this->endCache();
}

變化

緩存的內(nèi)容可能需要根據(jù)一些參數(shù)的更改而變化。例如一個 Web 應用支持多語言，同一段視圖代碼也許需要生成多個語言的內(nèi)容。因此可以設(shè)置緩存根據(jù)應用當前語言而變化。

通過設(shè)置 yii\widgets\FragmentCache::variations 選項來指定變化，該選項的值應該是一個標量，每個標量代表不同的變化系數(shù)。例如設(shè)置緩存根據(jù)當前語言而變化可以用以下代碼：

if ($this->beginCache($id, ['variations' => [Yii::$app->language]])) {

  // ... 在此生成內(nèi)容 ...

  $this->endCache();
}

開關(guān)

有時你可能只想在特定條件下開啟片段緩存。例如，一個顯示表單的頁面，可能只需要在初次請求時緩存表單（通過 GET 請求）。隨后請求所顯示（通過 POST 請求）的表單不該使用緩存，因為此時表單中可能包含用戶輸入內(nèi)容。鑒于此種情況，可以使用 yii\widgets\FragmentCache::enabled 選項來指定緩存開關(guān)，如下所示：

if ($this->beginCache($id, ['enabled' => Yii::$app->request->isGet])) {

  // ... 在此生成內(nèi)容 ...

  $this->endCache();
}

緩存嵌套

片段緩存可以被嵌套使用。一個片段緩存可以被另一個包裹。例如，評論被緩存在里層，同時整個評論的片段又被緩存在外層的文章中。以下代碼展示了片段緩存的嵌套使用：

if ($this->beginCache($id1)) {

  // ...在此生成內(nèi)容...

  if ($this->beginCache($id2, $options2)) {

    // ...在此生成內(nèi)容...

    $this->endCache();
  }

  // ...在此生成內(nèi)容...

  $this->endCache();
}

可以為嵌套的緩存設(shè)置不同的配置項。例如，內(nèi)層緩存和外層緩存使用不同的過期時間。甚至當外層緩存的數(shù)據(jù)過期失效了，內(nèi)層緩存仍然可能提供有效的片段緩存數(shù)據(jù)。但是，反之則不然。如果外層片段緩存沒有過期而被視為有效，此時即使內(nèi)層片段緩存已經(jīng)失效，它也將繼續(xù)提供同樣的緩存副本。因此，你必須謹慎處理緩存嵌套中的過期時間和依賴，否則外層的片段很有可能返回的是不符合你預期的失效數(shù)據(jù)。

譯注：外層的失效時間應該短于內(nèi)層，外層的依賴條件應該低于內(nèi)層，以確保最小的片段，返回的是最新的數(shù)據(jù)。
動態(tài)內(nèi)容

使用片段緩存時，可能會遇到一大段較為靜態(tài)的內(nèi)容中有少許動態(tài)內(nèi)容的情況。例如，一個顯示著菜單欄和當前用戶名的頁面頭部。還有一種可能是緩存的內(nèi)容可能包含每次請求都需要執(zhí)行的 PHP 代碼（例如注冊資源包的代碼）。這兩個問題都可以使用動態(tài)內(nèi)容功能解決。

動態(tài)內(nèi)容的意思是這部分輸出的內(nèi)容不該被緩存，即便是它被包裹在片段緩存中。為了使內(nèi)容保持動態(tài)，每次請求都執(zhí)行 PHP 代碼生成，即使這些代碼已經(jīng)被緩存了。

可以在片段緩存中調(diào)用 yii\base\View::renderDynamic() 去插入動態(tài)內(nèi)容，如下所示：

if ($this->beginCache($id1)) {

  // ...在此生成內(nèi)容...

  echo $this->renderDynamic('return Yii::$app->user->identity->name;');

  // ...在此生成內(nèi)容...

  $this->endCache();
}

yii\base\View::renderDynamic() 方法接受一段 PHP 代碼作為參數(shù)。代碼的返回值被看作是動態(tài)內(nèi)容。這段代碼將在每次請求時都執(zhí)行，無論其外層的片段緩存是否被存儲。

Articles you may be interested in:

• Detailed explanation of the use of the front-end resource package that comes with PHP's Yii framework
• Introduction to some advanced usage of caching in PHP's Yii framework
• Advanced use of View in PHP's Yii framework
• Detailed explanation of the methods of creating and rendering views in PHP's Yii framework
• Model model in PHP's Yii framework Study tutorial
• Detailed explanation of the Controller controller in PHP's Yii framework
• How to remove the behavior bound to a component in PHP's Yii framework
• In PHP's Yii framework Explanation of behavior definition and binding methods
• In-depth explanation of properties (Properties) in PHP's Yii framework
• Detailed explanation of the installation and use of extensions in PHP's Yii framework