RouteOrganizer

継承:Organizer

RouteOrganizerはアプリケーションのルーティングに関する処理を担当します。例えばこのURLの場合には、特定の処理をするといった用途に利用します。

このオーガナイザを利用する場合、どのようなルートが存在するかを設定の”routes”セクションに設定します。このルート情報と現在のURLを元に現在のルートが決定されます。以下は設定例です。

"routes": [
  {
    "name": "list",
    "path": "/:resource/list/",
    "specName": "{{:resource}}",
  },
  {
    "name": "top",
    "path":　"/",
    "specName": "top",
  }
]

ルート情報配列の先頭から順番に、以下の条件が全て一致したものが、現在のルートとして採用されます。

1. （originの指定がある場合）originと一致する。
2. （pathの指定がある場合）URLとpathが正規表現で一致する

RouteOrganizerはルートを決定した後、そのルート固有の設定ファイルを追加で読み込むことができます。その追加で読み込む設定ファイルは、スペックファイル（Spec file）と呼ばれます。スペックファイルに記述される内容は、通常のコンポーネントの設定ファイルと同じです。

openRoute()メソッドを呼ぶことで、違うルート（URL）ヘ移動することができます。openRoute()は以下の流れで処理を行います。

1. options[“jump”]がTrue、または新しいルート情報が存在しない場合は、新しいURLヘ遷移します。
2. hitory.pushState()し、新しいURLを履歴に追加します。
3. 新しいルートが違うスペックファイルを要求する場合、updateRoute()メソッドを呼びます。（現在未実装）
4. URLの検証を行います。
5. アタッチされているコンポーネントのrefresh()メソッドを呼びます。
6. URLの正規化を行います。

なお、ページが遷移した場合、自動的に現在のURLに対してopenRoute()が呼び出されます。こうすることで、URLの検証以降の作業が行われます。

ブラウザの”戻る”、”進む”ボタンなどでpopstateイベントが発生した場合、RouteOrganizerがデフォルトの処理を行います。

イベント発生時には、その新しいルートに対するopenRoute()処理を行うことで、通常のロードと同じ流れの処理が行われます。またアタッチしているコンポーネントに対し、”beforePopstate”、”afterPopstate”イベントをトリガーするので、コンポーネント側でイベントハンドラを記述することで、popstateイベント時に独自の処理も行うことができます。

RouteOrganizerではURLの検証と修正の仕組みを持っています。ただし、RouteOrganizerでは具体的な作業は行わず、イベントをトリガーするのみです。そのイベントハンドラに検証や修正のロジックを記述します。

validateRoute()メソッドを呼び出すことでこの処理が行われますが、validateRoute()メソッドはopenRoute()メソッドの中で自動的に呼び出されます。

validateRoute()は以下の流れで処理を行います。

1. beforeValidateイベントをトリガーします。
2. doCheckValidityオーガナイザイベントをトリガーします。
3. 検証に失敗し、かつ“settings.autoFixURL”オプションがTrueなら、URLの自動修正を行います。
4. doValidateURLイベントをトリガーします。
5. afterValidateイベントをトリガーします。
6. 検証結果がNGなら、例外をスローします。

”routes”セクションからルーティング情報に関する設定を読み込み、現在保持しているルーティング情報に追加します。これらの処理は設定情報が読み込まれた直後の”beforeStart”と、スペックファイルが読み込まれた直後の”afterSpecLoad”のタイミングで行われます。

• routes

• beforeStart
• afterSpecLoad

{
    "system": {
        "specPath": <specPath>,
    }
}

型:String

スペックファイルのパスを指定します。

ルーティング情報は設定の“routes”セクションに記述します。“routes”セクションは配列となっており、複数のルート情報を設定できます。またいくつかの設定は、“settings”セクションに記述します。

{
    "settings": {
        "autoFixURL": <autoFixURL>,
        "validationName": <validationName>,
    },
    "routes": [{
        "name": <name>,
        "origin": <origin>,
        "path": <path>,
        "specName": <specName>,
    }],
}

型:Boolean

URLの検証が失敗したときに、自動的に修正するかを指定します。

型:String

ルートの名前を指定します。

型:String

ルートのオリジンを指定します。

型:String

ルートのパスを指定します。path-to-regexpで使用可能な正規表現を指定できます。パスの指定がない場合は、全てのURLが合致することになります。

型:String

ルートのスペックファイル名を指定します。合致したルートのこのファイル名のファイルが、追加で読み込まれます。

型:String

検証時にどのパターンを使うかの名称を指定します。

いくつかのコンポーネント設定はタグの属性に指定することもできます。タグ属性は他の設定より高い優先順位を持っています。

型:String

スペックファイルのパスを指定します。"system.specPath"と同じです。

doNormalizeURLイベントの後に発生します。

なし。

Popstateイベント時にルータによってopen()メソッドが呼ばれ、画面が再描画された後に発生します。

なし。

スペックファイルをロードした直後に発生します。

doValidateイベントの後に発生します。

なし。

normalizeURL()メソッドを呼び出した時に発生します。

なし。

Popstate処理時に、ルータによってopenRoute()メソッドが呼ばれ、画面が再描画される前に発生します。

validateRoute()メソッドが呼ばれたときに発生します。

なし。

beforeNormalizeURLの後に発生します。

なし。

自動修正が行われた後に、発生します。

なし。

型:Object Inject:component get

現在のルートに関する情報を保持するオブジェクトです。

型:Object Inject:component get

現在のルート固有の追加設定を保持するオブジェクトです。

型:undefined Inject:component

パラメータに渡されたルート情報を元に生成されたURLへ遷移します。ページロードを発生させます。

なし。

型:Object Inject:component

現在のURLのクエリーパラメータをもとにオブジェクトを生成します。例えばURLのクエリ部が”?limit=10&offset=30”の場合、以下のオブジェクトを返します。

{
  "limit": 10,
  "offset": 30
}

なし。

クエリーパラメータのオブジェクトです。

型:undefined 非同期 Inject:component

パラメータに渡されたURLを正規化します。このメソッドはイベントをトリガーするのみで、実際の正規化作業はトリガーされるイベントのイベントハンドラで行います。

なし。

• beforeNormalizeURL
• doNormalizeURL
• afterNormalizeURL

型:undefined 非同期 Inject:component

パラメータに渡されたルート情報に応じたルートへ遷移します。遷移先のルート情報と現在のルート情報をもとに、jumpRoute()、updateRoute()、refreshRoute()のいずれかが呼び出されます。

現在のルート情報と遷移先のルート情報の”name”が違う場合はjumpRoute()、”specName”が違う場合はupdateRoute()、いずれも同じ場合はrefreshRoute()が呼び出されます。

なし。

型:undefined 非同期 Inject:component

コンポーネントのrefresh()メソッドを呼び、現在のルートを再描画します。

なし。

型:undefined Inject:component

パラメータに渡されたルート情報に応じたルートへ上書きします。ブラウザの履歴を残すことなく、現在のURLを置き換えます。

なし。

型:undefined 非同期 Inject:component

別のスペックファイルを読み込み、それに切り替えます。

なし。

• system.specPath

型:undefined 非同期 Inject:component

パラメータに渡されたルート情報に応じたルートへ遷移します。ページロードを発生させずに、コンポーネントなどの読み込みなどを行います。

なし。

型:undefined 非同期 Inject:component

パラメータに渡されたURLを検証します。このメソッドはイベントをトリガーするのみで、実際の検証作業はトリガーされるイベントのイベントハンドラで行います。

イベントハンドラ内で検証を行い、検証が失敗した場合はthis.validationResult[“result”]にfalseを設定します。検証が失敗すると、“settings.autoFix”がTrueの場合は、自動修正を試みます。最終的に問題が解消されなければ、例外をスローします。

なし。

• beforeValidate
• doValidate
• afterValidate

• doCheckValidity

• settings.validationName
• settings.autoFixURL