HK's Technical Note

トップ

管理人のブログ
HKの技術メモ

ホームサーバー構築
ウェブサーバーメール環境セキュリティ運用管理等々

プログラミング
Java Perl C データベース等々

電子工作
PICマイコン楽器用エフェクター等々

管理人の部屋
おいでませ

Last modified: Mon Oct 23 20:19:56 JST 2006

[メニューに戻る]

Catalystを使ったアプリケーションの作成

以降各種機能の拡張を予定してます

[先頭に戻る]

1. はじめに

最近、Ruby on Railsを始めとして各種プログラミング言語におけるWebアプリケーションのフレームワークに関する話題がホットです。種々のプロダクトがある中で、Java におけるStruts の様に定番の地位を不動のものにしたものがある一方で、PHPのように乱立状態の様相を呈しているものもあります。そんな中でPerlでは昨年（2006年9月現在）あたりから、高い拡張性、既存のCPANモジュールとの親和性を「ウリ」としたCatalystがMVCフレームワークとして注目されてきています。ただ新しいこともあってか、日本語情報が少ないのが現状です。
そんなCatalystですが、まずは論より証拠、自分自身で試用してみることにしました。

[先頭に戻る]

2. 例題〜掲示板〜

仕様

さしあたって例題としては簡単な掲示板を作ってみました。スレッド式のもので、オリジナルメッセージにコメントを追記できるようなものです。ただし目的はあくまでCatalystの試用なので、~~実用性に欠ける次のような制約ありますが~~ 、細かな作り込みや完全な機能を持っていませんが、とりあえず作ってみます。

~~スレッドは全て1ページに表示。1ページあたりの表示スレッドは固定ではなく無限。~~
Class::DBI::Pagerを利用した機能拡張により、ページ機能が追加されました。 (10/22追記)
~~スレッドの並び方は書き込みが古いものから（笑）~~
これは解決しました。書き込みは新しいものから表示されるように改良。詳細は後述。(10/15追記)

というわけで、即使えるものではないので、これらは後日、Catalystの拡張編としての題材としてとっておきたいと思います。

前提プロダクト

本掲示板では記事の永続化方式にはRDBMSのPostgreSQLを使用します。ただしPostgreSQLに特有な機能は利用していないのでMySQLへの移植などは容易でしょう。この他、Catalystは多くのCPANモジュールを必要とします。が、これは Catalyst本体のインストール時に自動的に入るものもありますし、あとから手で入れる必要があるものもあります。詳細はインストールの項目で説明します。 Webサーバは実サービス時にはApacheなどが必要となりますが、開発段階ではCatalystで用意されている専用ミニサーバーが利用できます。このミニサーバーはデバッグ用情報が十分に出力されるなど、なかなか便利なものです。
本記事で利用した環境は以下のとおりです。

OS: FreeBSD 5.4-RELEASE
PostgreSQL: ver.7.4.7
Perl: 5.8.6
Catalyst: ver.5.6902

インストール・動作確認

インストール

Catalystは相当数の他モジュールに依存しています。ですからモジュールをひとつひとつ手作業でインストールすることは現実的ではありません。そこで、 CatalystではCPANから"Task::Catalyst"というモジュールをインストールすることで連鎖的に必要なモジュールが自動的にインストールされる様になっています。ただインストール中、[y/n]でオプションを選択させられる場面が多々ある上、モジュール数もインストール前の環境に依存しますが、相当数（私の場合30 あまり）ですので、所要時間はそれなりにかかります。インストールには次のコマンドをroot権限で実行します。ただしこの方法ではインストールされるモジュールがrootのホームディレクトリに全て展開されることに注意してください。また"-MCPAN"オプション（CPANサイトからモジュールを取得してインストールまでを自動化するオプション）を初めて使用する場合には、対話式にモジュールの展開場所を訊かれますので、そこで"/usr/local/src"等、適当な場所に変えておくのも一つの方法です。

$ su
Password:
# perl -MCPAN -e 'install Task::Catalyst'
#

もし"-MCPAN"オプションでCPANからのインストールをするのが初めてであれば、その際にもあれこれと質問をされます。基本的に全てデフォルトでよいと思いますが、先ほど説明したようにモジュールの展開場所を変えたい場合、該当個所を変えてください。
Catalystおよび関連モジュールのインストール時にも色々と質問をされますが、これも基本的にデフォルトで問題は無いと思います。しかし、後々開発作業をしている際によく以下の様な"Can't locate * in @INC"といった様なエラーが出てくることが時折あるかと思います。その際には該当モジュール（下記の例では Inflect.pm"）を手動で追加してください。

"Can't locate Lingua/EN/Inflect.pm in @INC (@INC contains: /home/hiraku/src/msgboard/MsgBoard/script/../lib /usr/local/lib/perl5/site_perl/5.8.6/mach /usr/local/lib/perl5/site_perl/5.8.6 /usr/local/lib/perl5/site_perl /usr/local/lib/perl5/5.8.6/BSDPAN /usr/local/lib/perl5/5.8.6/mach /usr/local/lib/perl5/5.8.6 .)

個々のモジュールの追加の場合でも以下の様にperlの"-MCPAN"オプションを使用することで逐一インストールすることができます。

$ su
Password:
# perl -MCPAN -e 'install Inflect'
#

動作確認

それでは動作確認をしてみましょう。今回の例題のアプリケーション名はMsgBoardとします。開発は以後ディレクトリ"~/src"以下で行うものとします。この例と環境が違う場合には適宜この部分を読み替えてください。コマンド"catalyst.pl MsgBoard"を実行します。するとアプリケーション開発に必要なディレクトリ構成が作成されます。

結果として次のようなディレクトリ構成がつくられます。

【ディレクトリ構成】

MsgBoard/
           +- Makefile.PL
           +- Changes
           +- README
           +- msgboard.yml
           +- lib/
           +- root/
           +- script/
           +- t/

各ディレクトリに収められる内容物は次の通りです。

ディレクトリ	内容
lib	下位でさらにController/Model/Viewのディレクトリに別れている。開発者が実装するコントローラ/モデル/ビューそれぞれのコードを配置する。この時点ではアプリケーションの設定を収める"lib/MsgBoard.pm"と、リクエストされたURLに応じて処理をディスパッチする"lib/MsgBoard/Controller/Root.pm"が予め生成されている。
root	ユーザーが実際に見る静的ページや動的ページのテンプレートを格納する。
t	テスト用コードを格納する。（詳細はまた時を改めて）
script	テスト用ミニサーバー、開発をサポートする各種スクリプトが格納されている。
msgboard.yml	このファイルにYAML形式でアプリケーションの構成情報、パラメータなどを設定する。
README, Changes	説明するまでもないですね。

このなかで"lib"および"root"ディレクトリ以下で開発を進めていきます。
さて、ではテスト動作をさせてみましょう。以下のコマンドを実行します。

$ ~/src/MsgBoard/script/msgboard_server.pl
....(略)....
[Sun Sep 17 18:15:34 2006] [catalyst] [info] MsgBoard powered by Catalyst 5.6902
You can connect to your server at http://astra.homeip.net:3000

上記のメッセージにあるように、TCP3000番にHTTPで接続できるとあります（ここで"astra.homeip.net"というのは作業しているPCのホスト名です）のでブラウザでアクセスしてみます。URLに"http://localhost:3000/"などと指定して右の画面が表示されればインストールはOKです。
このミニサーバーが起動しなかった場合、"Can't locate XXX.pm in @INC"（XXX の部分はいろいろ）などとエラーメッセージが出ていませんか？必要なモジュールがインストールされていないかもしれません。XXXで指摘されたモジュールをインストールしてください。
ミニサーバーを起動したターミナルの方ではデバッグ用のメッセージが出力されるようになります。フォームに入力した値などの他、各種の動作状況、エラーメッセージが出力されますので、逆スクロールできるターミナル、例えばEmacsの Shell modeなどの中で利用するのが良いと思います。
このミニサーバーを終了するときには起動したコンソールで^C(Ctrl+C)としてください。

[先頭に戻る]

3. 設計

モデル、ビュー用モジュールの選択

Catalystのコアの部分そのものは、主としてコントローラ部分を担っており、ビュー、モデルの部分は別途作成しなければなりません。しかしCatalystの特徴のひとつである、他のモジュールとの親和性がここで生かされます。例えば、ビューの部分はCPANモジュールである、HTML::Template、Template-Toolkitなどを自由に選択することもできますし、今回の様にデータの永続化にデータベースを利用するのであれば、同じくCPANモジュールである。Class::DBIなどをを利用することができます。
今回はビューにTemplate-Toolkit、モデルにClass::DBIを利用することとします。というわけで、以下のCPANモジュールを新たにインストールしました。

Class-DBI-v3.0.14
Catalyst-Model-CDBI-0.11.tar.gz
Class-DBI-Pg-0.09.tar.gz

データベース設計

今回利用するデータベースは前述のようにPostgreSQL(ver.7.4.7)です。ただしバージョン依存があるような機能は特に利用していませんので、ver.8.0以上などでも問題はないはずです。
データベースのスキーマは今回【リスト1】に示した様な1つのテーブルにまとめた形式とします。本来ならオリジナルのメッセージとそれに対するコメント文とを別テーブルにするところなのかもしれませんが、今回は実装例の説明なので、コンパクトにまとまるようにしました。

【リスト1】データベースのスキーマ


create table message (
        id      integer primary key default nextval('sequence_message'),
        title   text,
        author  text not null,
        item    text not null,
        date    timestamp (0) default current_timestamp,
        ref     integer default 0
);

各属性の意味は次表のとおりです。

属性名	役割
id	プライマリーキーです。メッセージ、コメントのIDを示します。投稿時に自動的に採番されていくように、PostgreSQLのシーケンス機能を使って値を挿入します。その為、上記のスキーマをデータベースに登録する前に、「シーケンス」を作成しておく必要があります。
title	元メッセージ（スレッドの先頭のメッセージ）につく記事のタイトル。コメントの場合は必要ないので"not null"制約は不要とします。
author	元メッセージ、コメントの投稿者の名前。必須なので"not null"制約を付与します。
date	メッセージ、コメントが投稿された日時。投稿された日時に自動的に現在時刻が入るようにDefault値をcurrent_timestampに設定します。 (0)の意味は1秒以下の精度を指定する意味です。(10/15追記)
item	メッセージ、コメントの文章本体です。必須なので"not null"制約を付与します。
ref	元メッセージの場合は、この値は0になります。コメントの場合は、対象となる元メッセージのidが入り関連づけがなされます。

画面設計

画面は以下の二つのみです。

メイン画面: 元メッセージ、コメントの一覧表示と新規投稿のフォームが入ります。
コメント投稿画面: メイン画面中、各スレッドに関連づけられている「コメント」ボタンを押すとこの画面に遷移します。この画面では元メッセージとコメント投稿用のフォームが表示されます。

データ構造

スクリプト中でのデータ構造は【リスト2】の様に設計します。画面上の構造をそのまま表現した形ですが、多少構造が複雑なのはご容赦ください。これをコントローラの中で作成してビューコンポーネントに引き渡す様にします。

【リスト2】データ構造

my @page = (    # ページ全体を保持
            (
             origmsg => {    # スレッドの元メッセージ
                      title  => '最初のスレッドのタイトル',
                      date   => '投稿の日時',
                      author => '投稿者の名前',
                      text   => '本文',
                      },
             comment => [
                         {   # 1番目のコメント
                             date   => '投稿の日時',
                             author => '投稿者の名前',
                             text   => '本文',
                         },
                         {   # 2番目のコメント
                             date   => '投稿の日時',
                             author => '投稿者の名前',
                             text   => '本文',
                         },
                        ] 
                   
             ),

             (
                ##.... 二番目のスレッド ....
             ),
            );

[次ページへ]

[先頭に戻る]

参考リンク・文献

インプレスコミュニケーションズ：まるごとPerl!Vol1

技術評論社：WEB+DB PRESS vol.32(2006/4)「Perlフレームワークの大本命Catalyst入門」

Catalyst::Manual::Intro(日本語訳)
Catalyst::Manual::Cookbook(日本語訳)