アクションメソッドの引数値の解決

アクションメソッドが引数を持つ場合、引数に@org.seasar.ymir.scope.annotation.Resolveアノテーションを付与することでスコープからオブジェクトを取り出して引数の値とすることができます。これを「メソッド引数値の解決（resolution）」と呼びます。

引数にアノテーションが付与されていない場合はアクションメソッド毎に定義されているデフォルトの引数値が第1引数から順番に割り当てられます。それでも解決できない引数には引数の型に応じたデフォルト値が割り当てられます。

デフォルトの引数値は以下のように定義されています。

例

標準のマッピングでは、例えばリクエストパスが/path.htmlである場合、アプリケーションのルートパッケージ名をcom.example.appとしてcom.example.app.web.PathPageクラスがPageクラスとなります。

今HTTPメソッドがPOSTであるようなリクエストが/path.htmlに対してなされた場合の処理の流れは以下のようになります。

リクエストパラメータのインジェクト

リクエストパラメータはユーザが自由に外部から指定することができるため、リクエストパラメータをGetter/Setterメソッドを使って自動的にPageオブジェクトに設定できるようにしてしまうとアプリケーション設計者の意図しないGetter/Setterメソッドを使って外部からPageオブジェクトに値がセットされてしまう危険性があります。

この危険を回避するために、Ymirではリクエストパラメータスコープから値をインジェクトまたはポピュレートするようなアノテーションをGetter/Setterメソッドに明示的に付与するポリシーになっています。このアノテーションが付与されていないGetter/Setterはリクエストパラメータは代入されません。

ある名前のリクエストパラメータを代入したい場合は例えば以下のように記述して下さい:

@In(scopeClass = RequestParameterScope.class, name = "parameter")
public void setParameter(String parameter) {
    this.parameter = parameter;
}

Setterに対応するプロパティ名と代入したいパラメータの名前が同じ場合はもう少し簡単に記述できます:

@In(RequestParameterScope.class)
public void setParameter(String parameter) {
    this.parameter = parameter;
}

さらにこれはエイリアスアノテーションを使って以下のように書けます:

@RequestParameter
public void setParameter(String parameter) {
    this.parameter = parameter;
}

ネストした形式のパラメータをオブジェクトグラフにマッピングするような形で代入したい場合は@Inアノテーションの代わりに@Populateアノテーションを使います。例えばuser.nameというパラメータの値をPage#getUser().setName()を使って代入したい場合は以下のように記述して下さい:

@Populate(RequestParameterScope.class)
public User getUser() {
    return user;
}

実は@RequestParameterは@Populate(RequestParameterScope.class)のエイリアスです。そのためSetterに@RequestParameterと@Inの両方のアノテーションが付与されている場合、@RequestParameterの評価順序は@Inよりも後になります。

フェーズ毎のカスタムメソッド呼び出し

Pageコンポーネントに関する処理フェーズ毎に特定のメソッドを呼ぶようにすることができます。

ある処理フェーズの時点で呼び出したいメソッドにはorg.seasar.ymir.annotation.Invokeアノテーションを付与します。アノテーションのプロパティとして、フェーズを表すEnum（org.seasar.ymir.Phase）を指定します。以下に例を示します:

@Invoke(Phase.PAGECOMPONENT_CREATED)
public void initialize() {
    ...
}

フェーズには以下のものがあります。

Invokeアノテーションが付与されたメソッドが引数を持つ場合はアクションメソッドと同様に引数値の解決が行なわれます。デフォルトの引数値はありません。

[Ymir-1.0.2以降] Invokeアノテーションが付与されたメソッドが返り値を返した場合、その返り値に従って画面遷移が行なわれます。