小粋空間  -  a cheap joke and a play on words site

Movable Typeオブジェクトのcache_propertyについて

Movable Typeオブジェクトのcache_propertyメソッドについて紹介します。

１．概要

cache_propertyはMT::Objectに定義されているメソッドで、実行結果やデータのキャッシュを行いたい場合に利用します。キャッシュは1回のリクエスト内でのみ有効です。用途としては次の2パターンがあるようです。

1. データベースへのアクセスを減らしたい
2. データをリクエスト内で持ちまわりたい

２．cache_propertyへの設定

1つめの利用方法では次のように設定します。1つめのパラメータがキー、2つめのパラメータにはコードリファレンスを設定します。実行結果がキャッシュされていればキャッシュを返却し、そうでない場合はコードを実行しないという機能をもっています。

$obj->cache_property( $key, $code );

MT::Comment::parentでは次のように使われています。

sub parent {
    my $comment = shift;
    $comment->cache_property(
        'parent',
        sub {
            if ( $comment->parent_id ) {
                return MT::Comment->load( $comment->parent_id );
            }
        }
    );
}

2つめの利用方法では次のように設定します。例はMT::CMS::Entry::saveで、カテゴリデータを$objに保存する場合です。

$obj->cache_property( 'category', undef, $cat );

３．cache_propertyからの取得

取得は、いずれの場合もキーを設定します。

$obj->cache_property( $key );

前述のカテゴリデータの取得は次のように行います。

my $cat = $obj->cache_property( 'category' );

４．キャッシュのクリア

キャッシュをすべてクリアしたい場合は、clear_cacheを実行します。

$obj->clear_cache();

５．注意事項

コードを実行するパターンでは試していませんが、データの保存時にcache_propertyが使えるのは、プライマリキーが存在する場合のみのようです。言い換えると、データベース保存前の$objには一意のIDが付与されていないので、その状態でcache_propertyを実行するとエラーになるようです。

以上です。こういう記事を書いたときは何かの伏線と思われることが多いのですが、そのとおりです（笑）。