Catalystを構成するモジュール
それでは、サンプルを動かしながらアプリケーションを構成するモジュールについて見ていきましょう。
本記事のサンプルコードは、すべてUTF-8で保存してください。また、サンプルの実行はすべて組み込みサーバで確認しています。記事中でWebブラウザからアクセスする場合には、「http://<ホスト名またはIPアドレス>:3000/アクション名」のように指定しています。
例えば、組み込みサーバを起動しているPCのIPアドレスが「192.168.123.69」でアクションのパス部分が「sample」の場合には、「http://192.168.123.69:3000/sample」というURLに置き換えて実行してください。
Catalyst::View::TTのインストール
今回のサンプルでは、ビューとしてCatalyst::View::TTを使用するため、最初にインストールしておきます。
Catalyst::View::TTは、出力のレンダリングにTemplate Toolkitを使用するCatalystのビューモジュールです。Template Toolkitの書式に従ったテンプレートにアクションで作成したデータを当てはめることでレスポンスを作成します。「Task::Catalyst」を最初にインストールしている場合は既に入っているのでこの作業は不要です。
CentOSなどCPANからインストールする場合には、次のコマンドをrootユーザーで実行します。
# perl -MCPAN -e 'install Catalyst::View::TT'
Windows上にActivePerlを使用してCatalystの環境を構築している場合には、「Perl Package Manager（PPM）」を使用してインストールします。PPMのメニューから［View］－［All Packages］を選択して、インストール可能なすべてのパッケージを表示させます。この中から「Catalyst-View-TT」を探して、インストールします。
サンプルアプリケーションのスケルトン作成
今回使用するサンプルアプリケーションのスケルトンを作成します。この例では「HelloWorld」という名前で作成します。
$ catalyst.pl HelloWorld
アプリケーションクラス
アプリケーションクラスとは、アプリケーションの設定や使用するプラグインの登録、そしてCatalystの拡張を行うことの出来るクラスです。アプリケーションクラスは、「lib」ディレクトリ以下にある「アプリケーション名.pm」ファイルが実体となります。サンプルの例であれば「lib/HelloWorld.pm」になります。
package HelloWorld;
use strict;
use warnings;
use Catalyst::Runtime 5.80;
# 省略
use parent qw/Catalyst/;
# （1）フラグとプラグインの設定
use Catalyst qw/-Debug
ConfigLoader
Static::Simple/;
our $VERSION = '0.01';
# 省略
# （2）アプリケーションの設定情報
__PACKAGE__->config( name => 'HelloWorld' );
古いバージョンのCatalystでは、アプリケーションクラスでグローバルアクションを定義することが出来ましたが、5.66以降のバージョンでは、グローバルアクションはRootコントローラに定義するように推奨されています。
アプリケーションクラスで設定できるフラグなどは次のようになります。
（1）フラグとプラグインの設定
フラグの設定や追加するプラグインを「use Catalyst qw/～/;」で定義します。
ここで設定可能なフラグには次のものがあります。
| フラグ | 説明 |
| -Debug | デバッグ出力を有効にする |
| -Engine | 使用するエンジンを強制的に設定する。Catalyst::Engine::CGIを設定する場合には次のように設定する「 use Catalyst qw/-Engine=CGI/;」 |
| -Home | ホームディレクトリを設定する。次のように設定する 「 use Catalyst qw/-Home=\/home\/test\/myapp/」（※注1） |
| -Log | ログレベルを設定する。出力するログレベルが複数ある場合には、次のようにコンマで区切って設定する 「 use Catalyst '-Log=warn,fatal,error';」 |
| -Stats | 統計情報の収集とレポートを有効または無効にする。有効にするには次のように1を設定する 「 use Catalyst qw/-Stats=1/」 |
qw演算子の区切り文字（この場合には「/」）と同じ文字を含む場合には「\」でエスケープします。また区切り文字には他の文字も使用できるため「use Catalyst qw[-Home=/home/test/myapp]」のように設定することもできます。
デフォルトで登録されているプラグインは、「Catalyst::Plugin::ConfigLoader」と「Catalyst::Plugin::Static::Simple」の2つです。Catalyst::Plugin::ConfigLoaderは、設定ファイルで定義された値を読み込むためのプラグインです。YAML形式の設定ファイルにも対応しています。
Catalyst::Plugin::Static::Simpleは、画像などの静的なファイルについてCatalystの処理を迂回して自動的に返すためのプラグインです。デフォルトではrootディレクトリ以下にある拡張子がtmpl、tt、tt2、html、xhtml以外のファイルを対象にします。
プラグインを登録する際には先頭の「Catalyst::Plugin::」が省略可能となっています。
デフォルトで読み込まれるプラグイン以外では、次のものがよく使われているようです。
| プラグイン名 | 説明 |
| Catalyst::Plugin::Session | セッション関連のプラグイン |
| Catalyst::Plugin::Authentication | 認証関連のプラグイン |
| Catalyst::Plugin::FillInForm | HTMLのフォームに自動的にデータを設定するプラグイン |
ただし、最近のCatalystでは内部操作が必要な場合などを除いて、プラグインの使用は非推奨となっています。古いプラグインの中にはサポートされなくなっているものもありますので、プラグインの使用には十分な注意が必要です。
Catalystの機能拡張については Catalyst::Manual::ExtendingCatalystなどが参考になります。
（2）アプリケーションの設定情報
Catalyst::Plugin::ConfigLoaderプラグインを使用する場合には、「helloworld.conf」などの外部設定ファイルで設定した値の方が優先されます。従って、アプリケーションクラスではデフォルト値を設定し、外部設定ファイルにはアプリケーションを配備する環境に依存する値を上書き設定できるようになります。
configメソッドの引数はハッシュとなり、キーと値の組を登録します。
__PACKAGE__->config( name => 'HelloWorld',
foo => { bar => 'baz'} );
上記の例では、キー「name」の値として「HelloWorld」が登録されており、さらにキー「foo」の値としてハッシュが登録されています。
