(3)
(0)
(6)
(0)
Total: 9 CakePHP1.2 Behaviorでモデルのメソッドキャッシュを行う
CakePHP1.2から新たにBehavior（振る舞い）クラスが実装され、モデルに共通の処理を定義することが可能になりました。
今回はBehaviorを使ってモデルの各メソッドの結果を自動的にキャッシュするクラス（CacheBehavior）を検討してみました。
CakePHPでは標準でビューキャッシュをサポートしていますが、Cacheクラスを利用することで簡単にキャッシュ機能を組み込むことができます。
ソースコードは少し長いので、一番最後に記述することにします。
CacheBehaviorの目的
CakePHPでの開発では、
・まず動作するアプリケーションを構築する
・パフォーマンス上ボトルネックになっている部分のチューニングを行う
という手法が一般的だと思います。
そこで、CacheBehaviorはチューニング時に実装していくことを想定し、構築時のソースコードになるべく影響を与えないようにキャッシュ機能が実装できることを目指します。
CacheBehaviorの機能
１．モデル内の任意のメソッドの結果をキャッシュする
（コントローラーなどの呼び出し側を修正することなく実現したい）
２．キャッシュ有効期限を指定しない場合は、変数にキャッシュする（同一のリクエスト内で有効）
３．モデルのデータ内容に変化（追加・更新・削除）があった場合には自動的にキャッシュをクリアする
４．コントローラーからモデルのメソッドを呼び出す際にキャッシュを実装可能にする
（とはいえ、コントローラーからも制御したい）
実装準備：Behaviorの登録
CacheBehavior(cache.php)を
/app/models/behaviors/cache.php
に配置。
キャッシュ機能を実装したいモデルの宣言部分にCacheBehaviorを追加。
-
<?php
-
class SampleModel extends Model{
-
：
実装例１：モデル内の任意のメソッドをキャッシュする
仮に以下のようなメソッドがモデルに登録されているとします。
このメソッドを常にキャッシュする場合は、処理の先頭に以下の4行の記述を追加します。
-
// 引数で渡されたカラムでソートを行い全件を返す
-
function getAll($order_by = 'id') {
-
if ($this->Behaviors->attached('Cache')) {
-
if($this->cacheEnabled()) return $this->cacheMethod('600', __FUNCTION__, $args);
-
}
-
-
return $data;
-
}
先頭のIF文はこのモデルにCacheBehaviorが登録されているかをチェックしています。
CakePHP1.2のモデルの機能で各Behaviorは、
$Model->Behaviors->attach('登録したいBehavior');
$Model->Behaviors->detach('解除したいBehavior');
とすることで、動的に登録/解除が可能になっています。
その為、処理の途中でCacheBehaviorが解除されている可能性も考慮し登録を確認しています。
実際にキャシュ機能を実装している部分は
-
if($this->cacheEnabled()) return $this->cacheMethod('600', __FUNCTION__, $args);
この部分で、まずCacheBehaviorが利用可能かどうかを、$this->cacheEnabled() で確認し可能であれば、
return $this->cacheMethod('600', __FUNCTION__, $args);
で処理結果を返します。
（キャッシュが無い場合は自身のメソッドを再実行することになりますが、再帰呼び出しをされた場合にこのcacheEnabled()はFALSEを返します）
cacheMethod（）の第１引数はキャッシュ時間（上記例では600秒）でCakePHPのCacheクラスのdurationパラメータになります。
この値が空文字か0の場合は変数キャッシュとなり、CakeコアのCacheEngineは使わずにリクエスト内のみで有効な変数にキャッシュします。
第２引数はキャッシュしたいメソッド名、第３引数はメソッドに渡す引数配列となります。
先に追加した４行のキャッシュを行うソースコードにはメソッド名や引数は全てPHPの別関数やエイリアスで置き換えてますので、全く同じものを他のメソッドにコピーすれば、そのメソッドはキャッシュが有効になります。
実装例２：モデルのfindメソッドをキャッシュする
モデルを利用している全てのfindメソッドに対してキャッシュを利用したい場合は以下のようにfindメソッドをオーバーライドする形式で記述します。
-
// findメソッド全てにキャッシュ（600秒）を利用にする
-
function find() {
-
if ($this->Behaviors->attached('Cache')) {
-
if($this->cacheEnabled()) return $this->cacheMethod('600', __FUNCTION__, $args);
-
}
-
-
}
実装例３：コントローラーなどから利用する
コントローラーなどで特定の条件の場合のみキャシュを利用したい場合は、仮に元のソースが以下だったとすると、
以下のようにfindメソッドをcacheMethod経由で呼び出すように記述します。
注意事項
・CacheBehaviorのcacheMethodはクラス名＋メソッド名＋引数のシリアライズ値によってキャッシュのキーを生成しています。よって、引数のパターン分だけキャッシュファイルが生成されます。
・コアクラスのCacheEngineを利用していますので、キャッシュ方法やパスなどのパラメータはconfigの値が適用されます。
・CacheBehaviorがattachされている状態でモデルのsave（）・delete()メソッドが実行されるとキャッシュを自動的に削除します。削除する必要が無い場合は事前に上述のdetach()でBehaviorを解除する必要があります。
ソースコード
/app/models/behaviors/cache.php
-
<?php
-
class CacheBehavior extends ModelBehavior {
-
var $enabled = true;
-
-
-
/**
-
* メソッドキャッシュ
-
*/
-
$this->enabled = false;
-
// キャッシュキー
-
-
// 変数キャッシュの場合
-
if(!$expire){
-
$this->enabled = true;
-
return $this->cacheData[$cachekey];
-
}
-
$this->enabled = true;
-
$this->cacheData[$cachekey] = $ret;
-
return $ret;
-
}
-
-
// サーバーキャッシュの場合
-
$ret = Cache::read($cachekey);
-
$this->enabled = true;
-
return $ret;
-
}
-
$this->enabled = true;
-
Cache::write($cachekey, $ret, $expire);
-
-
// クリア用にモデル毎のキャッシュキーリストを作成
-
$list = Cache::read($cacheListKey);
-
$list[$cachekey] = 1;
-
Cache::write($cacheListKey, $list);
-
return $ret;
-
}
-
-
/**
-
* 再帰防止判定用
-
*/
-
function cacheEnabled(&$model){
-
return $this->enabled;
-
}
-
-
/**
-
* キャッシュクリア
-
*/
-
function cacheDelete(&$model){
-
$list = Cache::read($cacheListKey);
-
foreach($list as $key => $tmp){
-
Cache::delete($key);
-
}
-
Cache::delete($cacheListKey);
-
}
-
-
/**
-
* 追加・変更・削除時にはキャッシュをクリア
-
*/
-
function afterSave(&$model, $created) {
-
$this->cacheDelete($model);
-
}
-
function afterDelete(&$model) {
-
$this->cacheDelete($model);
-
}
-
-
}
関連するその他の記事
Comments
Leave a Reply