名前

Cache::Cache -- Cacheインターフェース

説明

Cacheモジュールは、指定された期間データを永続化させることで開発者を助けるように設計されています。このモジュールは、リモート・マシンやデータベースへの繰り返され、冗長で高価な呼び出しを節約するためにデータをローカルに格納するためにWebアプリケーションで、よく使われます。また人々はCache::Cacheがわかりやすいインターフェースをアプリケーションの実行やCGIスタイルのスクリプトの呼び出しを、またがってデータを共有する時の、わかりやすいインタフェースのために使ったり、単純にファイルシステムや共有メモリの抽象化を簡単に利用することを知っています。

Cache::Cacheインターフェースはget, set, remove, size, purge, そしてclear インスタンス・メソッドと、メソッドの呼び出しを越えてデータを永続化するための、それらに対応する静的メソッドサポートをサポートしているクラスによって実装されます。

利用方法

最初に、あなたの必要にとって一番よいキャッシュの実装を選択してください。最も単純なキャッシュはMemoryCacheです。これは複数の連続したリクエストをサービスし、冗長で高価な問い合わせを行うことを避けたい、データベースにアクセスするApache/mod_perlアプリケーションのようなアプリケーションに適しています。プロセス間でデータを共有したいのであれば、おそらくSharedMemoryCacheが適しているでしょう。しかしシステムによって違いのあるベースとなるIPCメカニズムに強く結び付けられ、大きなオブジェクトや多くのオブジェクトには向いていません。SharedMemoryCacheが受け入れられないときには、FileCacheが同じ機能を、同じくらいのパフォーマンスで提供します。しかもオブジェクトの数やそれらの大きさによって制限されません。もしキャッシュのベースとなるファイル・システムの大きさを厳密に制限したいのであればSizeAwareFileCacheで実現できます。同様にSizeAwareMemoryCacheと SizeAwareSharedMemoryCacheは大きさ管理機能を、それぞれ MemoryCacheとSharedMemoryCacheに追加します。

キャッシュの使い方は簡単です。以下のサンプル・コードはファイルシステムをベースとしてキャッシュのインスタンスを作り、利用しています。

  use Cache::FileCache;

  my $cache = new Cache::FileCache( );

  my $customer = $cache->get( $name );

  if ( not defined $customer )
  {
    $customer = get_customer_from_db( $name );
    $cache->set( $name, $customer, "10 minutes" );
  }

  return $customer;

定数

$EXPIRES_NEVER
設定されたキャッシュの中の要素は、決して期限切れになりません。
$EXPIRES_NOW
設定されたキャッシュの中の要素は、即、期限切れになります。

メソッド

Clear( )
このタイプの全てのキャッシュから全てのオブジェクトを削除します。
Purge( )
このタイプの全てのキャッシュから期限切れになっている全てのオブジェクトを削除します。
Size( )
このタイプの全てのキャッシュでの全てのオブジェクトの大きさの合計を返します。
new( $options_hash_ref )
Cache::Cacheの新しいインスタンスを組み立てます。$options_hash_refは構成オプションが入ったハッシュへのリファレンスです;下記のオプションのセクションをご覧ください。
clear( )
このキャッシュ・インスタンスに関連付けられた名前空間から、全てのオブエジェクトを削除します。
get( $key )
$keyに関連付けられたデータを返します。
get_object( $key )
$keyに関連付けられたキャッシュされたデータを格納するために使われている、ベースになっているCache::Objectオブジェクトを返します。そのオブジェクトが期限切れであったとしても、キャッシュされたオブジェクトの削除を引き起こしません。
purge( )
名前空間から、このキャッシュ・インスタンスに関連付けられている、期限が切れている全てのオブジェクトを削除します。
remove( $key )
キャッシュから$keyに関連付けられているデータを削除します。
set( $key, $data, [$expires_in] )
キャッシュの中で$dataを$keyに関連付けます。$expires_inはデータが削除されるまでの時間を秒数で、あるいは定数$EXPIRES_NOWや $EXPIRES_NEVERで示します。デフォルトは$EXPIRES_NEVERになります。この変数は"[number] [unit]"、例えば"10 minutes"という拡張された書式にすることもできます。適切な単位はs, second, seconds, sec, m, minute, minutes, min, h, hour, hours, w, week, weeks, M, month, months, y, year, そして yearsです。さらに$EXPIRES_NOWは"now"で、$EXPIRES_NEVERは"never"で表すこともできます。
set_object( $key, $object )
$keyをCache::Object $objectに関連付けます。set_objectを使うことは（setとは逆である）期限の切れたオブジェクトの自動的な削除は引き起こしません。
size( )
このキャッシュ・インスタンスに関連付けられた名前空間でのすべてのオブジェクトの大きさの合計を返します。
get_namespaces( )
このタイプのキャッシュに関連付けられた全ての名前空間を返します。

オプション

以下のいずれかのキーを持っているハッシュへのリファレンスで渡されることによりオプションが設定されます:

namespace
このキャッシュに関連付けられる名前空間。明示的に指定されなければデフォルトは"Default"です。
default_expires_in
キャッシュに置かれたオブジェクトのデフォルトの期限切れ時間。明示的に設定されなければデフォルトは$EXPIRES_NEVERです。
auto_purge_interval
自動削除の間隔を設定します。（expires_inと同じ書式で）このオプションに特定の時間が設定されると、間隔を越えた最初のsetのとき、purge( )ルーチンが呼び出されます。そして間隔はリセットされます。
auto_purge_on_set
もしこのオプションがtrueであれば、自動削除間隔ルーチンがsetの度にチェックされます。
auto_purge_on_get
もしこのオプションがtrueであれば、自動削除間隔ルーチンがgetの度にチェックされます。

プロパティ

(get|set)_namespace( )
このキャッシュ・インスタンスの名前空間
get_default_expires_in( )
このキャッシュ・インスタンに置かれたオブジェクトのデフォルトの期限切れ時間
get_keys( )
このキャッシュ・インスタンスに関連付けられた名前空間でのオブジェクトを指定するキーのリスト
get_identifiers( )
このメソッドではなく、get_keys( )を使うようにしてください。
(get|set)_auto_purge_interval( )
自動削除間隔にアクセスします。このオプションが（expires_inと同じ書式で）特定の時間に設定されていれば、その間隔の後の最初のgetのとき、 purge( )ルーチンが呼び出されます。そして間隔はリセットされます。
(get|set)_auto_purge_on_set( )
このプロパティがtrueであれば、自動削除間隔ルーチンがsetの度にチェックされます。
(get|set)_auto_purge_on_get( )
このプロパティがtrueであれば、自動削除間隔ルーチンがgetの度にチェックされます。

参考資料

Cache::Object, Cache::MemoryCache, Cache::FileCache, Cache::SharedMemoryCache, and Cache::SizeAwareFileCache

作者

Original author: DeWitt Clinton <dewitt@unto.net>

Last author: $Author: hippo2000 $