CodeZine(コードジン)

特集ページ一覧

初めてのCatalyst入門(2)
Catalystアプリはどのように作るのか?

Catalystでの処理の流れ、主要なコンポーネントを解説

  • LINEで送る
  • このエントリーをはてなブックマークに追加
2009/09/25 14:00
目次

コンテキスト

 コンテキストオブジェクトは、アプリケーション内のさまざまな場所からアクセス可能なオブジェクトで、またコンテキストを通じてコンポーネント(Model/View/Controller)などにアクセスすることもできます。

 コンテキストからアクセスできる重要なオブジェクトには次のものがあります。

コンテキストからアクセスできる重要なオブジェクト
オブジェクト/モジュール名 概要
Catalyst::Request クライアントからのリクエスト情報を管理するモジュール
Catalyst::Response クライアントへのレスポンス情報を管理するモジュール
config アプリケーションの設定情報が格納されるハッシュ
Catalyst::Log アプリケーションのログを管理するモジュール
stash コンポーネント間でデータを共有するために使用するハッシュ

Catalyst::Request

 Catalystのリクエストオブジェクトにはクライアントからのすべてのリクエスト情報が格納されており、「$c->request」または「$c->req」のようにアクセスできます。リクエストオブジェクトでアクセス可能なメソッドはCatalyst::Requestで確認できます。

 ここでは、User-Agentを表示する例を次に示します。

リスト05:User-Agentを表示するアクション
sub showuseragent :Local {
  my ( $self, $c ) = @_;
  # User-Agentを表示
  $c->response->body( $c->request->user_agent );
}

 「Root.pm」に「showuseragent」アクションを定義し、「$c->request->user_agent」を使用してWebブラウザのUser-Agentを取得します。

 組み込みサーバを起動し、Webブラウザから「http://<ホスト名またはIPアドレス>:3000/showuseragent」にアクセスすると、使用したWebブラウザの情報が表示されていると思います。

Catalyst::Response

 Catalystのレスポンスオブジェクトにはクライアントへ返すレスポンス情報が格納されており、「$c->response」または「$c->res」のようにアクセスできます。レスポンスオブジェクトでアクセス可能なメソッドはCatalyst::Responseで確認できます。

 レスポンスのサンプルとして、同じHTML文字列を返す場合に、Content-Typeの値がtext/plainとtext/htmlのそれぞれの値として返す例を次に示します。

リスト06:Content-Typeを切り替えて表示するアクション
# Content-Type:text/plainの場合
sub astext :Local {
  my ( $self, $c ) = @_;
  $c->response->content_type('text/plain;charset=utf-8');
  $c->res->body( '<html><body>Content-Typeによる表示テスト</body></html>' );
}

# Content-Type:text/htmlの場合
sub ashtml :Local {
  my ( $self, $c ) = @_;
  $c->response->content_type('text/html;charset=utf-8');
  $c->res->body( '<html><body>Content-Typeによる表示テスト</body></html>' );
}

 「Root.pm」にtext/plainで表示させるための「astext」アクションとtext/htmlで表示させるために「ashtml」アクションを定義し、「$c->response->content_type」を使用してWebブラウザに返すContent-Typeを変更します。

 組み込みサーバを起動し、Webブラウザから「http://<ホスト名またはIPアドレス>:3000/astext」を実行すると、次のようにHTMLのタグまで表示されます。

図3:「astext」アクションの実行結果
図3:「astext」アクションの実行結果

 次に「http://<ホスト名またはIPアドレス>:3000/ashtml」にアクセスすると、同じ文字列を設定したにもかかわらず「Content-Typeによる表示テスト」という文字だけが表示されます。

図4:「ashtml」アクションの実行結果
図4:「ashtml」アクションの実行結果

config

 アプリケーションクラスや設定ファイルに記述した値が格納されているハッシュです。configへは「$c->config」のようにアクセスできます。

 アプリケーション名を表示する例を次に示します。

リスト07:設定情報から「name」を取得して表示するアクション
sub showname :Local {
  my ( $self, $c ) = @_;
  # アプリケーション名を表示
  $c->response->body( $c->config->{name} );
}

 「Root.pm」に「showname」アクションを定義し、「$c->config->{name}」で設定情報からアプリケーション名「name」の値を取得しています。

 組み込みサーバを起動し、Webブラウザから「http://<ホスト名またはIPアドレス>:3000/showname」にアクセスすると、「HelloWorld」が表示されていると思います。

Catalyst::Log

 Catalystのログオブジェクトには、「$c->log」のようにアクセスできます。ログの種類には、debug/info/warn/error/fatalがあり、それぞれのメソッドに値を渡すことで重要度に応じたログ出力を行います。ログの出力先は標準エラー出力になります。

 ログ情報を出力する例を次に示します。

リスト08:ログを出力するアクション
sub outputlog :Local {
  my ( $self, $c ) = @_;
  # ログ情報の出力
  $c->log->debug('Debug');
  $c->log->info('Info');
  $c->log->warn('Warn');
  $c->log->error('Error');
  $c->log->fatal('Fatal');

  $c->response->body( 'Output log' );
}

 「Root.pm」に「outputlog」アクションを定義し、「$c->log」を使用してログを出力します。組み込みサーバを起動し、Webブラウザから「http://<ホスト名またはIPアドレス>:3000/outputlog」にアクセスすると、組み込みサーバのコンソールに次のようなログが出力されていると思います。

リスト09:ログ出力結果の一部
[debug] Debug
[info] Info
[warn] Warn
[error] Error
[fatal] Fatal

  • LINEで送る
  • このエントリーをはてなブックマークに追加

バックナンバー

連載:Webアプリケーションフレームワーク「Catalyst」入門

もっと読む

著者プロフィール

  • 山田 祥寛(ヤマダ ヨシヒロ)

    静岡県榛原町生まれ。一橋大学経済学部卒業後、NECにてシステム企画業務に携わるが、2003年4月に念願かなってフリーライターに転身。Microsoft MVP for ASP/ASP.NET。執筆コミュニティ「WINGSプロジェクト」代表。 主な著書に「入門シリーズ(サーバサイドAjax/XM...

  • WINGSプロジェクト 花田 善仁(ハナダ ヨシヒト)

    <WINGSプロジェクトについて> 有限会社 WINGSプロジェクトが運営する、テクニカル執筆コミュニティ(代表 山田祥寛)。主にWeb開発分野の書籍/記事執筆、翻訳、講演等を幅広く手がける。2018年11月時点での登録メンバは55名で、現在も執筆メンバを募集中。興味のある方は、どしどし応募頂...

あなたにオススメ

All contents copyright © 2005-2021 Shoeisha Co., Ltd. All rights reserved. ver.1.5