Zend Framework - Zend_Cache編

■ 概要

負荷の大きな処理や時間のかかる演算など、リクエストが来るたびに実行して導き出していては不利な部分が存在します。

ひとたび実行結果を導き出せたら、これを一定期間保持（キャッシュ）して、保持しているキャッシュデータを返し続けるようにすればかなりの負荷軽減になることが予想できます。

これを実現するのがZend_Cacheというわけです。

キャッシュ処理は「フロントエンド」と呼ばれる部分で行われ、
キャッシュデータの保存には「バックエンド」と呼ばれるアダプタが使われます。

「フロントエンド」の中核はCoreであり、他はこれを継承したクラスとなっています。

Core ..基本機能（Zend_Cache_Core）
Output ..出力を横取りするもの（Zend_Cache_Frontend_Output）
Function ..関数コールの結果（Zend_Cache_Frontend_Function）
Class ..オブジェクトや静的メソッドのコール（Zend_Cache_Frontend_Class）
File ..ファイル更新時間（Zend_Cache_Frontend_File）
Page ..ページ全体（Zend_Cache_Frontend_Page）

フロントエンド用のオプション設定として、キャッシュ期間や自動シリアライズ化（文字列データ以外でも文字列化して保存するための仕組み）などが用意されています。

「バックエンド」にはファイル、SQLiteデータベース、メモリがあります。

File ..ファイルに保存（Zend_Cache_Backend_File）
Sqlite ..SQLiteデータベース（Zend_Cache_Backend_Sqlite）
Memcached ..memcachedサーバ（Zend_Cache_Backend_Memcached）

バックエンド用のオプション設定として、キャッシュファイルの保存先ディレクトリ指定などがあります。

キャッシュ処理を行うには、キャッシュ処理を行うフロントエンドをインスタンス化することになります。
そのために静的メソッドfactory()に必要な設定を渡して組み立てます。

以上を踏まえて、実際にフロントエンドのオブジェクトを取得してみます。

<?php require_once 'Zend/Cache.php'; $frontend = array('lifetime' => 30); // フロントエンドのオプション指定 $backend = array('cache_dir' => './data'); // バックエンドのオプション指定 $cache = Zend_Cache::factory('Core', // フロントエンドのクラス指定 'File', // バックエンドのクラス指定 $frontend, $backend);

上記は基本機能を持つCoreクラスで30秒期限でキャッシュ処理を行い、キャッシュデータ保存を./data内にファイル作成して行うというものです。

実際に./dataディレクトリが存在していないと、「cache_dir must be a directory」の例外をZend_Cache_Exceptionがスローします。
そしてそれをcatchできなければ「Fatal error: Uncaught exception」になります。

■ 使用例

まず「どの処理部分」を「どれくらいの期間」キャッシュさせたいのかをはっきりさせる必要があります。

「処理Ａ」「処理Ｂ」「処理Ｃ」とあって、そのうちの時間のかかる処理Ｂがあったとすると処理Ｂをキャッシュさせることになるので、処理Ｂ全体をキャッシュされてるかどうかの判定文で囲むことになります。

処理Ａ（軽い） if (($変数=キャッシュを取得(ID)) === false) { // キャッシュされてないまたは期限切れなら 処理Ｂ（重い） $変数 = 処理Ｂの結果結果の値 処理結果の値を保存(ID) } これ以降では、キャッシュの有無に関わらず$変数の値を利用できる 処理Ｃ（軽い）

これで指定した期間だけ、重い処理をスキップする流れになります。

キャッシュには一意なＩＤを付けます。他の部分で使われるキャッシュＩＤとカブらないように、その部分の処理にちなんだＩＤを付けるのが望ましいです。

一意なＩＤを付けることで、ファイルやSQLiteデータベースなどに保存したＩＤ名義のデータを引っ張り出してくることができます。

では実際のコードを書いてみます。

▼ 重い処理部分をキャッシュする <?php require_once 'Zend/Cache.php'; $frontend = array('lifetime' => 10); $backend = array('cache_dir' => './tmp'); $cache = Zend_Cache::factory('Core', 'File', $frontend, $backend); $A = '[処理Ａ]'; echo $A; // 処理Ａの結果 if (($B=$cache->load('SyoriB')) === false) { // キャッシュが存在しないまたは期限切れなら echo '重い処理を実行'; $B = '[処理Ｂ]'; // 処理結果の値を代入 $cache->save($B, 'SyoriB'); // 処理結果の値をキャッシュ } echo $B; // 処理Ｂの結果（キャッシュされた値なのかどうかはここでは判らないがとにかく使える） $C = '[処理Ｃ]'; echo $C; // 処理Ｃの結果

この結果は、最初にキャッシュが存在しないので

[処理Ａ]重い処理を実行[処理Ｂ][処理Ｃ]

という表示になり、その後の１０秒間は何度アクセスしても

[処理Ａ][処理Ｂ][処理Ｃ]

と表示されます。

つまり、キャッシュの条件文で囲った範囲の処理が、「実行されては１０秒間キャッシュ」を繰り返す流れになります。

次に、echoやprintなどで標準出力される処理をキャプチャします。
これにはフロントエンドにOutputクラスを使用します。

▼ 出力をキャプチャする <?php require_once 'Zend/Cache.php'; $frontend = array('lifetime' => 10); $backend = array('cache_dir' => './tmp'); $cache = Zend_Cache::factory('Output', 'File', $frontend, $backend); $A = '[処理Ａ]'; echo $A; // 処理Ａの結果 $message = 'if内が実行されてない'; if (!$cache->start('SyoriB')) { // キャッシュが存在しないまたは期限切れなら $message = 'if内が実行された'; echo '重い処理を実行'; $B = '[処理Ｂ]'; // 処理結果の値を代入 echo $B; // 処理Ｂの結果 $cache->end(); // このまでの範囲をキャプチャしてキャッシュ } echo $message; // 判別 $C = '[処理Ｃ]'; echo $C; // 処理Ｃの結果

今回は出力がキャプチャされるので前回のようにif文内に「echo '重い処理を実行';」と書いてもこれ自体がキャプチャされキャッシュされてしまうのでechoは使わずに変数への代入を行い判別します。

すると最初のアクセスでは以下の表示になり、

[処理Ａ][処理Ｂ]if内が実行された[処理Ｃ]

次の１０秒間は何度アクセスしても以下が表示される流れになります。

[処理Ａ][処理Ｂ]if内が実行されてない[処理Ｃ]

最後は究極、ページ全体のキャッシュを行ってみます。

これは指定期間キャッシュされたページをそのまま返し続けるので、さながら静的であるHTMLファイルをリクエストしてる形に近くなり、かなりの処理軽減が見込めます。

ページ丸ごとのキャッシュなので、ＩＤは自動的に$_SERVER['REQUEST_URI']に基づいて生成されます。
その他オプションとしてこれに$_GET, $_POST, $_SESSION, $_COOKIE, $_FILESの値を加味したＩＤを生成することもできます。

▼ ページ全体をキャッシュ <?php require_once 'Zend/Cache.php'; $frontend = array( 'lifetime' => 7200, 'debug_header' => true, ); $backend = array('cache_dir' => './tmp'); $cache = Zend_Cache::factory('Page', 'File', $frontend, $backend); $cache->start(); // これ以降の出力がキャッシュされる echo time(); $A = '[処理Ａ]'; echo $A; // 処理Ａの結果 $B = '[処理Ｂ]'; echo $B; // 処理Ｂの結果 $C = '[処理Ｃ]'; echo $C; // 処理Ｃの結果

これを実行すると以下の表示になります。

1290744684[処理Ａ][処理Ｂ][処理Ｃ]

その後２時間は何度リクエストしても以下の表示になります。

DEBUG HEADER : This is a cached page !1290744684[処理Ａ][処理Ｂ][処理Ｃ]

もしページ全体のキャッシュが効かない場合には、クッキーが送られてる可能性があります。

これを回避するには、cache_with_cookie_variablesキーの値をtrueにしてクッキー値に基づいたＩＤでキャッシュする方法があります。

フロントエンドのオプション $frontend = array( 'lifetime' => 7200, 'debug_header' => true, 'regexps' => array( '^/index.php' => array( 'cache' => true, 'cache_with_cookie_variables' => true, ) ) );

"regexps"キーの持つ値として、ページごとの設定を配列で追加指定することができます。リクエストＵＲＩの正規表現をキーとして、それにマッチしたリクエストに対する挙動を指定することができます。つまりページ単位でキャッシュを違う挙動にできるということになります。

先ほどcache_with_cookie_variablesを設定にした時には、make_id_with_cookie_variablesの値がデフォルトのtrueだったので省略していました。
なので、これをfalse指定にするとクッキー値がなんであろうと関係なくスルーする挙動になります。
つまり$_SERVER['REQUEST_URI']のみでＩＤが作成されることになります。

フロントエンドのオプション $frontend = array( 'lifetime' => 7200, 'debug_header' => true, 'regexps' => array( '^/index.php' => array( 'cache' => true, 'cache_with_cookie_variables' => true, 'make_id_with_cookie_variables' => false ) ) );