目次

• アクション
• アクションの定義
  • アクションクラス
  • アクションメソッド
  • リクエストパラメータのバインド
  • コンバータ
  • ActionResult
  • アノテーション
  • 事前処理・事後処理
  • リクエストからアクション実行までのフロー
• アクションのテスト

アクション

アクションとは特定の URI へのリクエストに対応する処理で、Cubby のユーザーが実装する部分です。
URI に対応するメソッドをアクションメソッド、アクションメソッドが定義されたクラスをアクションクラスといいます。

アクションの定義

                :
        @RequestParameter
        public Book book;
                :

package org.seasar.cubby.examples.other.web.converter;

import org.seasar.cubby.converter.ConversionHelper;
import org.seasar.cubby.converter.impl.AbstractConverter;

/**
 * ISDN を表す文字列と Book を相互変換するコンバータです。
 */
public class BookConverter extends AbstractConverter {

        public BookDao bookDao;

        /**
         * Book.class を返すことで、このコンバータが任意の値を Book へ変換できることを示します。
         */
        public Class<?> getObjectType() {
                return Book.class;
        }

        /**
         * リクエストパラメータ(ここではISBN)を Book へ変換します。
         */
        public Object convertToObject(Object value, Class<?> objectType,
                        ConversionHelper helper) {
                if (value == null) {
                        return null;
                }
                String isbn13 = value.toString();
                Book book = bookDao.findByIsbn13(isbn13);
                return book;
        }

        /**
         * Book から表示用の文字列(ISBN)へ変換します。
         */
        public String convertToString(Object value, ConversionHelper helper) {
                Book book = Book.class.cast(value);
                return book.getIsbn13();
        }

}

リクエストからアクション実行までのフロー

ブラウザのリクエストからアクション実行までのフローは以下のようになります。

リクエストからアクション実行までのフロー

アクションのテスト

アクションの単体テストは CubbyTestCase を使用します。 Seasar の S2Unit の機能を全て使用できるので SeasarのS2Unitのドキュメントも合わせてご覧ください。

1. CubbyTestCase を継承して、XXXXTest を作成します。
2. テスト対象のアクションをフィールドに用意します。これはアクション実行後に結果を取得するためです。
3. setUpメソッドで app.dicon を読み込み、 Seasar2 で管理されるコンポーネント(テスト対象のアクションを含む)を初期化します。
4. アクションのメソッドごとにテストメソッドを書きます。メソッド名は test から始めます。
5. リクエストパラメータのセットなど、テストに必要な初期化処理は各テストメソッド用のセットアップメソッドで行います。メソッド名は setup から始めます。
6. CubbyTestCase#processAction にリクエストのパスを指定して、アクションメソッドを実行します。CoolURI(パラメータ付きのURI)の場合、パスにパラメータを含んで実行します(TodoActionTest#)。
7. 戻り値をCubbyTestCase#processActionで結果の ActionResult の型とパスをチェックします。パスのチェックは Forward と Redirect の場合のみ行われます。
8. 必要に応じてアクションクラスのフィールドやリクエストやセッションの値をチェックします。

   HelloActionTest.java

   package org.seasar.cubby.examples.other.web.hello;
   
   import org.seasar.cubby.action.ActionResult;
   import org.seasar.cubby.action.Forward;
   import org.seasar.cubby.unit.CubbyTestCase;
   
   public class HelloActionTest extends CubbyTestCase {
   
           // 対象のアクション
           private HelloAction action;
           
           // 初期化処理
       protected void setUp() throws Exception {
           // diconファイルの読み込み
           include("app.dicon");
       }
       
           public void testIndex() throws Exception {
                   // アクションの実行
                   ActionResult result = processAction("/hello/");
                   // 結果のチェック
                   assertPathEquals(Forward.class, "input.jsp", result);
           }
   
           public void setupMessage() {
               // リクエストパラメータのセット
                   getRequest().addParameter("name", "name1");
           }
           
           public void testMessage() throws Exception {
                   // アクションの実行
                   ActionResult result = processAction("/hello/message");
                   // 結果のチェック
                   assertPathEquals(Forward.class, "result.jsp", result);
                   // 実行後のアクションの状態を確認
                   assertEquals("name1", action.name);
           }       
   }

   TodoActionTest.java

   package org.seasar.cubby.examples.todo.action;
   
   import org.seasar.cubby.action.ActionResult;
   import org.seasar.cubby.action.Forward;
   import org.seasar.cubby.action.Redirect;
   import org.seasar.cubby.examples.RunDdlServletRequestListener;
   import org.seasar.cubby.unit.CubbyTestCase;
   
   public class TodoActionTest extends CubbyTestCase {
   
           private TodoAction action;
           
       protected void setUp() throws Exception {
           include("app.dicon");
           RunDdlServletRequestListener listener = new RunDdlServletRequestListener();
           listener.requestInitialized(null);
       }
   
       @Override
       protected void setUpAfterBindFields() throws Throwable {
           super.setUpAfterBindFields();
                   getRequest().addParameter("userId", "test");
                   getRequest().addParameter("password", "test");
                   // 後続のテストを実行するためにログインアクションを実行
                   assertPathEquals(Redirect.class, "/todo/", processAction("/todo/login/process"));
       }
       
           public void testShow() throws Exception {
           this.readXlsAllReplaceDb("TodoActionTest_PREPARE.xls");
           // CoolURIの場合のテスト
                   ActionResult result = processAction("/todo/1");
                   assertPathEquals(Forward.class, "show.jsp", result);
                   assertEquals(new Integer(1), action.id);
                   assertEquals("todo1", action.text);
                   assertEquals("todo1 memo", action.memo);
                   assertEquals(new Integer(1), action.todoType.getId());
                   assertEquals("type1", action.todoType.getName());
                   assertEquals("2008-01-01", action.limitDate);
           }
   }