• 追加された行はこの色です。
  • 削除された行はこの色です。
* Chainedアクション [#w68f61cd]

** 何のためにあるのか? [#tee1e78a]
Catalystは原則的にコントローラークラスのクラス名やメソッド名がURLの素になる。逆に言うと、URLによって、クラス名やメソッド名が決まってしまう。その関係を断ち切るためにある。

** 使い方 [#h4df2f41]
以下の3つのアトリビュートをメソッドに指定する。

: Chained | ここで指定されたメソッドを実行後、このメソッドを実行する
: PathPart | URLの一部分になる
: CaptureArgs/Args | 引数をどうとるか
下の例にあるように、コントローラクラスのアクションメソッドで、3つのアトリビュート(Chaind, PathPart, CaptureArgs/Args)を指定する。

 sub doFoo : Chained('doBar') PathPart('foo') CaptureArgs(0) { }

** 具体例 [#u46bb72a]
以下がサンプルのコントローラクラス。
以下がサンプルのコントローラクラス。このサンプルはhttp://localhost/A/B/Cでリクエスト出来る。

 package MyApp::Controller::Test;
 
 use base 'Catalyst::Controller';
 
 sub a : Chained('/') PathPart('A') CaptureArgs(0) { }
 sub b : Chained('a') PathPart('B') CaptureArgs(0) { }
 sub c : Chained('b') PathPart('C') Args(0) { }
 
 1;

*** Chained [#u63249fa]
この場合、http://localhost/A/B/Cでアクセス可能になる。sub cでChained('b')としているbは、sub bのbに相当する。sub bのChained('a')のaはsub aのaに相当する。sub aはChained('/')になっているが、これはこれ以上チェーンがない事を意味する。従って、どのような構成のURLであろうと、(メソッドを遡って)最後にはChained('/')が必要。このチェーン構成によって、リクエストを受けると、Catalystはsub a、sub b、sub cの順番で実行することになる。
メソッドの実行順番を決める。Catalystでは、あるメソッドは、Chainedで指定したメソッドを実行した後に、実行される。サンプルでは、

- sub cのChained('b')のbはsub bのbに相当する。
- sub bのChained('a')のaはsub aのaに相当する。
- sub aでChained('/')になっているが、これはこれ以上チェーンがない事を意味する。
- (すなわち、どのような構成のURLであろうと、(メソッドを遡って)最後にはChained('/')が必要。)

以上のようなわけで、このサンプルではリクエストを受けると、Catalystはsub a→sub b→sub cの順番でメソッドを実行する。

*** PathPart [#m60452e5]
PathPartで、A B Cで指定しているので、URLとしては、A B Cが採用される。メソッド名であるa b cおよびクラス名であるTestはURLとは関係が断ち切られる。PathPart('B')を('X')に変えれば、URLはhttp://localhost/A/X/Cになる。
URLの表記を決める。

- Chainedによってsub a→sub b→sub cでメソッドが実行されるが、
- 対応するPathPartはA→B→C、
- 従って、URLはhttp://localhost/A/B/Cになる。
- もしPathPart('B')を('X')に変えれば、URLはhttp://localhost/A/X/Cになる。

このようにChainedアクションを使うと、メソッド名(a,b,c)およびクラス名(Test)はURLと関係が断ち切られる。

*** CaptureArgs/Args [#acf90282]
CaptureArgs/Argsについてはすべて(0)を指定しているので、引数は取らない。もしsub bをCaptureArgs(1)にしたら、URLはhttp://localhost/A/B/*/Cになる。なお、URLの最後の部分(ここではPathPart('C'))のメソッド(ここではsub c)はCaptureArgsではなく、Argsを使わなければ行けない。
しかし、URLの先頭(ここではPathPart('A'))や途中(ここではPathPart('B'))のメソッド(ここではsub aとsub b)はCaptureArgsでもArgsでも良い。というのも、sub bを Args(0)にすると、http://localhost/A/B/Cに加えてhttp://localhost/A/BというURLも有効になるので。
引数をどう取るか決める。このサンプルではすべて(0)を指定しているので、引数は取らない。
もしsub bをCaptureArgs(1)すると、URLはhttp://localhost/A/B/*/Cになる。

*** CaptureArgsとArgsの違い [#c39098fd]
- URLの最後の部分(PathPart('C'))のメソッド(sub c)はCaptureArgsではなくArgsを使わなければ行けない。
- しかし、URLの先頭(PathPart('A'))や途中(PathPart('B'))のメソッド(sub a及びsub b)はCaptureArgsでもArgsでも良い。
- もしsub bをArgs(0)にすると、http://localhost/A/B/Cに加え、http://localhost/A/BというURLでもリクエスト出来るようになる。

** 最後に [#hb79d1f3]
以上の通りだけれど、慣れるまで分かりづらいので(例えば、PathPartやArgsの()を省略すると挙動が変わる)、catalyst.pl MyAppして、上のようなサンプルクラスを作り、myapp_server.plで画面に出力される"Loaded Chained actions:"の内容をよく見ると、挙動がつかめると思う。
以上の通りだけれど、慣れるまで分かりづらいので(例えば、PathPartやArgsの()を省略すると挙動が変わる)、Catalystをインストールしたマシンで、
 catalyst.pl MyApp
を実行して、MyApp/lib/MyApp/Controller/Test.pmとして上のサンプルクラスを作り、
 ./myapp_server.pl -r
を実行し、ブラウザでhttp://localhost:3000/A/B/Cにアクセスしてみる。そこで、デバッグコンソールに出力される"Loaded Chained actions:"の内容をよく見ると、挙動がつかめると思う。

** 参考 [#ad05caf0]
http://gihyo.jp/dev/serial/01/modern-perl/0007?page=1



トップ   新規 一覧 検索 最終更新   ヘルプ   最終更新のRSS