數據緩存是指將一些 PHP 變量存儲到緩存中,使用時再從緩存中取回。它也是更高級緩存特性的基礎,例如查詢緩存和內容緩存。
如下代碼是一個典型的數據緩存使用模式。其中 $cache 指向緩存組件:
// 嘗試從緩存中取回 $data $data = $cache->get($key); if ($data === false) { // $data 在緩存中沒有找到,則重新計算它的值 // 將 $data 存放到緩存供下次使用 $cache->set($key, $data); } // 這兒 $data 可以使用了。
緩存組件
數據緩存需要緩存組件提供支持,它代表各種緩存存儲器,例如內存,文件,數據庫。
緩存組件通常注冊為應用程序組件,這樣它們就可以在全局進行配置與訪問。如下代碼演示了如何配置應用程序組件 cache 使用兩個 memcached 服務器:
'components' => [ 'cache' => [ 'class' => 'yii\caching\MemCache', 'servers' => [ [ 'host' => 'server1', 'port' => 11211, 'weight' => 100, ], [ 'host' => 'server2', 'port' => 11211, 'weight' => 50, ], ], ], ],
然後就可以通過 Yii::$app->cache 訪問上面的緩存組件了。
由於所有緩存組件都支持同樣的一系列 API ,並不需要修改使用緩存的業務代碼就能直接替換為其他底層緩存組件,只需在應用配置中重新配置一下就可以。例如,你可以將上述配置修改為使用 yii\caching\ApcCache:
'components' => [ 'cache' => [ 'class' => 'yii\caching\ApcCache', ], ],
Tip: 你可以注冊多個緩存組件,很多依賴緩存的類默認調用名為 cache 的組件(例如 yii\web\UrlManager)。
支持的緩存存儲器
Yii 支持一系列緩存存儲器,概況如下:
緩存 API
所有緩存組件都有同樣的基類 yii\caching\Cache ,因此都支持如下 API:
由於 yii\caching\Cache 實現了 PHP ArrayAccess 接口,緩存組件也可以像數組那樣使用,下面是幾個例子:
$cache['var1'] = $value1; // 等價於: $cache->set('var1', $value1); $value2 = $cache['var2']; // 等價於: $value2 = $cache->get('var2');
緩存鍵
存儲在緩存中的每項數據都通過鍵作唯一識別。當你在緩存中存儲一項數據時,必須為它指定一個鍵,稍後從緩存中取回數據時,也需要提供相應的鍵。
你可以使用一個字符串或者任意值作為一個緩存鍵。當鍵不是一個字符串時,它將會自動被序列化為一個字符串。
定義一個緩存鍵常見的一個策略就是在一個數組中包含所有的決定性因素。例如,yii\db\Schema 使用如下鍵存儲一個數據表的結構信息。
[ __CLASS__, // 結構類名 $this->db->dsn, // 數據源名稱 $this->db->username, // 數據庫登錄用戶名 $name, // 表名 ];
如你所見,該鍵包含了可唯一指定一個數據庫表所需的所有必要信息。
當同一個緩存存儲器被用於多個不同的應用時,應該為每個應用指定一個唯一的緩存鍵前綴以避免緩存鍵沖突。可以通過配置 yii\caching\Cache::keyPrefix 屬性實現。例如,在應用配置中可以編寫如下代碼:
'components' => [ 'cache' => [ 'class' => 'yii\caching\ApcCache', 'keyPrefix' => 'myapp', // 唯一鍵前綴 ], ],
為了確保互通性,此處只能使用字母和數字。
緩存過期
默認情況下,緩存中的數據會永久存留,除非它被某些緩存策略強制移除(例如:緩存空間已滿,最老的數據會被移除)。要改變此特性,你可以在調用 yii\caching\Cache::set() 存儲一項數據時提供一個過期時間參數。該參數代表這項數據在緩存中可保持有效多少秒。當你調用 yii\caching\Cache::get() 取回數據時,如果它已經過了超時時間,該方法將返回 false,表明在緩存中找不到這項數據。例如:
// 將數據在緩存中保留 45 秒 $cache->set($key, $data, 45); sleep(50); $data = $cache->get($key); if ($data === false) { // $data 已過期,或者在緩存中找不到 }
緩存依賴
除了超時設置,緩存數據還可能受到緩存依賴的影響而失效。例如,yii\caching\FileDependency 代表對一個文件修改時間的依賴。這個依賴條件發生變化也就意味著相應的文件已經被修改。因此,緩存中任何過期的文件內容都應該被置為失效狀態,對 yii\caching\Cache::get() 的調用都應該返回 false。
緩存依賴用 yii\caching\Dependency 的派生類所表示。當調用 yii\caching\Cache::set() 在緩存中存儲一項數據時,可以同時傳遞一個關聯的緩存依賴對象。例如:
// 創建一個對 example.txt 文件修改時間的緩存依賴 $dependency = new \yii\caching\FileDependency(['fileName' => 'example.txt']); // 緩存數據將在30秒後超時 // 如果 example.txt 被修改,它也可能被更早地置為失效狀態。 $cache->set($key, $data, 30, $dependency); // 緩存會檢查數據是否已超時。 // 它還會檢查關聯的依賴是否已變化。 // 符合任何一個條件時都會返回 false。 $data = $cache->get($key);
下面是可用的緩存依賴的概況:
查詢緩存
查詢緩存是一個建立在數據緩存之上的特殊緩存特性。它用於緩存數據庫查詢的結果。
查詢緩存需要一個 yii\db\Connection 和一個有效的 cache 應用組件。查詢緩存的基本用法如下,假設 $db 是一個 yii\db\Connection 實例:
$duration = 60; // 緩存查詢結果60秒 $dependency = ...; // 可選的緩存依賴 $db->beginCache($duration, $dependency); // ...這兒執行數據庫查詢... $db->endCache();
如你所見,beginCache() 和 endCache() 中間的任何查詢結果都會被緩存起來。如果緩存中找到了同樣查詢的結果,則查詢會被跳過,直接從緩存中提取結果。
查詢緩存可以用於 ActiveRecord 和 DAO。
Info: 有些 DBMS (例如:MySQL)也支持數據庫服務器端的查詢緩存。你可以選擇使用任一查詢緩存機制。上文所述的查詢緩存的好處在於你可以指定更靈活的緩存依賴因此可能更加高效。
配置
查詢緩存有兩個通過 yii\db\Connection 設置的配置項:
yii\db\Connection::queryCacheDuration: 查詢結果在緩存中的有效期,以秒表示。如果在調用 yii\db\Connection::beginCache() 時傳遞了一個顯式的時值參數,則配置中的有效期時值會被覆蓋。
yii\db\Connection::queryCache: 緩存應用組件的 ID。默認為 'cache'。只有在設置了一個有效的緩存應用組件時,查詢緩存才會有效。
限制條件
當查詢結果中含有資源句柄時,查詢緩存無法使用。例如,在有些 DBMS 中使用了 BLOB 列的時候,緩存結果會為該數據列返回一個資源句柄。
有些緩存存儲器有大小限制。例如,memcache 限制每條數據最大為 1MB。因此,如果查詢結果的大小超出了該限制,則會導致緩存失敗。
片段緩存
片段緩存指的是緩存頁面內容中的某個片段。例如,一個頁面顯示了逐年銷售額的摘要表格,可以把表格緩存下來,以消除每次請求都要重新生成表格的耗時。片段緩存是基於數據緩存實現的。
在視圖中使用以下結構啟用片段緩存:
if ($this->beginCache($id)) { // ... 在此生成內容 ... $this->endCache(); }
調用 yii\base\View::beginCache() 和 yii\base\View::endCache() 方法包裹內容生成邏輯。如果緩存中存在該內容,yii\base\View::beginCache() 方法將渲染內容並返回 false,因此將跳過內容生成邏輯。否則,內容生成邏輯被執行,一直執行到 yii\base\View::endCache() 時,生成的內容將被捕獲並存儲在緩存中。
和[數據緩存]一樣,每個片段緩存也需要全局唯一的 $id 標記。
緩存選項
如果要為片段緩存指定額外配置項,請通過向 yii\base\View::beginCache() 方法第二個參數傳遞配置數組。在框架內部,該數組將被用來配置一個 yii\widget\FragmentCache 小部件用以實現片段緩存功能。
過期時間(duration)
或許片段緩存中最常用的一個配置選項就是 yii\widgets\FragmentCache::duration 了。它指定了內容被緩存的秒數。以下代碼緩存內容最多一小時:
if ($this->beginCache($id, ['duration' => 3600])) { // ... 在此生成內容 ... $this->endCache(); }
如果該選項未設置,則默認為 0,永不過期。
依賴
和[數據緩存]一樣,片段緩存的內容一樣可以設置緩存依賴。例如一段被緩存的文章,是否重新緩存取決於它是否被修改過。
通過設置 yii\widgets\FragmentCache::dependency 選項來指定依賴,該選項的值可以是一個 yii\caching\Dependency 類的派生類,也可以是創建緩存對象的配置數組。以下代碼指定了一個片段緩存,它依賴於 update_at 字段是否被更改過的。
$dependency = [ 'class' => 'yii\caching\DbDependency', 'sql' => 'SELECT MAX(updated_at) FROM post', ]; if ($this->beginCache($id, ['dependency' => $dependency])) { // ... 在此生成內容 ... $this->endCache(); }
變化
緩存的內容可能需要根據一些參數的更改而變化。例如一個 Web 應用支持多語言,同一段視圖代碼也許需要生成多個語言的內容。因此可以設置緩存根據應用當前語言而變化。
通過設置 yii\widgets\FragmentCache::variations 選項來指定變化,該選項的值應該是一個標量,每個標量代表不同的變化系數。例如設置緩存根據當前語言而變化可以用以下代碼:
if ($this->beginCache($id, ['variations' => [Yii::$app->language]])) { // ... 在此生成內容 ... $this->endCache(); }
開關
有時你可能只想在特定條件下開啟片段緩存。例如,一個顯示表單的頁面,可能只需要在初次請求時緩存表單(通過 GET 請求)。隨後請求所顯示(通過 POST 請求)的表單不該使用緩存,因為此時表單中可能包含用戶輸入內容。鑒於此種情況,可以使用 yii\widgets\FragmentCache::enabled 選項來指定緩存開關,如下所示:
if ($this->beginCache($id, ['enabled' => Yii::$app->request->isGet])) { // ... 在此生成內容 ... $this->endCache(); }
緩存嵌套
片段緩存可以被嵌套使用。一個片段緩存可以被另一個包裹。例如,評論被緩存在裡層,同時整個評論的片段又被緩存在外層的文章中。以下代碼展示了片段緩存的嵌套使用:
if ($this->beginCache($id1)) { // ...在此生成內容... if ($this->beginCache($id2, $options2)) { // ...在此生成內容... $this->endCache(); } // ...在此生成內容... $this->endCache(); }
可以為嵌套的緩存設置不同的配置項。例如,內層緩存和外層緩存使用不同的過期時間。甚至當外層緩存的數據過期失效了,內層緩存仍然可能提供有效的片段緩存數據。但是,反之則不然。如果外層片段緩存沒有過期而被視為有效,此時即使內層片段緩存已經失效,它也將繼續提供同樣的緩存副本。因此,你必須謹慎處理緩存嵌套中的過期時間和依賴,否則外層的片段很有可能返回的是不符合你預期的失效數據。
譯注:外層的失效時間應該短於內層,外層的依賴條件應該低於內層,以確保最小的片段,返回的是最新的數據。
動態內容
使用片段緩存時,可能會遇到一大段較為靜態的內容中有少許動態內容的情況。例如,一個顯示著菜單欄和當前用戶名的頁面頭部。還有一種可能是緩存的內容可能包含每次請求都需要執行的 PHP 代碼(例如注冊資源包的代碼)。這兩個問題都可以使用動態內容功能解決。
動態內容的意思是這部分輸出的內容不該被緩存,即便是它被包裹在片段緩存中。為了使內容保持動態,每次請求都執行 PHP 代碼生成,即使這些代碼已經被緩存了。
可以在片段緩存中調用 yii\base\View::renderDynamic() 去插入動態內容,如下所示:
if ($this->beginCache($id1)) { // ...在此生成內容... echo $this->renderDynamic('return Yii::$app->user->identity->name;'); // ...在此生成內容... $this->endCache(); }
yii\base\View::renderDynamic() 方法接受一段 PHP 代碼作為參數。代碼的返回值被看作是動態內容。這段代碼將在每次請求時都執行,無論其外層的片段緩存是否被存儲。