URLルーティング
MVCの肝の部分としてURLルーティングが挙げられます。今までASP.NETでは「.aspx」ファイルやフォルダがある場所のURLしか表示できませんでした。しかし、URLルーティングを利用することで、仮想的にURLマッピングを行うことができるようになります。
図2のソリューション構成の場合、通常ならばhttp://xxx/Views/Home/Index.aspxとなります。しかし、 URLルーティングを利用するとhttp://xxx/Home/IndexというURLになります。
図2のURLルーティングは以下のコードにより実装されています。
public class HomeController : Controller { //ActionResultメソッドで返るActionResultオブジェクトはそのままViewPageにルーティングされる public ActionResult Index() { // Titleキーを利用するとブラウザのタイトルとして表示される // この場合はHome Pageが表示 ViewData["Title"] = "Home Page"; // ViewDataにキーと値を格納 ViewData["Message"] = "Welcome to ASP.NET MVC!"; //ControllerクラスのViewメソッドで、ルーティング先のViewPage名を設定する // パラメタが指定されない場合はメソッド名と同名のViewPageに値を返す return View(); } }
アクションメソッドはActionResult
オブジェクトを戻り値としています。ActionResult
オブジェクトはView、ルーティングされるURLなどの結果を持ちます。このActionResult
オブジェクトを扱う最大のメリットは「単体テストの容易性」にあります。単体テスト内でアクションメソッドを呼び出して、単体テストを行っていきます。単体テストについては、後日公開予定の別稿で取り上げて解説します。
上記メソッドが呼び出されるとコメントに書いてあるURLマッピングが行われます。例えば、「XXX」という名前のフォルダや、「.aspx」ファイルがなくとも、URLマッピングが行えるのです。そして、マッピングには表示するのに必要なメソッド名、パラメタなどを使用するので、シンプルに分かりやすいURLを構築できます(URLルーティング)。
このURLルーティングにより開発者は本来必要だったフォルダやファイルの構築から解放され、自分が構築したかったURLを簡潔に素早く実装できるようになりました。
図2のURLルーティングは以下の流れです。
- ControllersフォルダのHomeと、Viewsフォルダ内のHomeフォルダがマッピングされる
- http://xxx/Home/Indexにアクセスされた時、Controllersフォルダ内の
HomeController
クラス内に記述されている「Index」Actionメソッド内の処理を実行。今回はパラメタが指定されていないのでIndex.aspxが表示される
なぜこのようなことができるようになったのでしょうか? ポイントはURLルーティングルールにあります。
URLルーティングルール
ASP.NET MVCプロジェクトを作成した時点で、ルーティングルールを「Global.asax」に自動生成します。
原理として、Webアプリケーション起動時に一度だけ呼び出されるGlobal.asaxのApplication_Start
メソッドからRegisterRoutes
メソッドを呼び出してルーティングルールをルートコレクションに追加しています。
ルーティングルールは、「リクエストにより利用するURLの雛形を定義する」ことと、「リクエスト時にパラメタが足りない場合の雛形の初期値の設定」を行います。
以下のコードは既定で作成されるルーティングルールです。
public class GlobalApplication : System.Web.HttpApplication { public static void RegisterRoutes(RouteCollection routes) { //IgnoreRouteメソッドはルート特定のURLパターンの処理を停止させる // ここでは.axdの処理を停止するよう指定 routes.IgnoreRoute("{resource}.axd/{*pathInfo}"); //MapRouteメソッドは新しいルーティングルールをルートコレクションに追加する // ここでは既定のルートとして"http://xxx/Home/Index"へとルーティングされる routes.MapRoute( "Default", // Route name(ルート名) "{controller}/{action}/{id}", // URL with parameters(URLとパラメータ名) new { controller = "Pubs", action = "Hello", id = "" } // Parameter defaults(既定のパラメータ値) ); } // Webアプリケーション起動時に一度だけ呼び出されるメソッド protected void Application_Start() { RegisterRoutes(RouteTable.Routes); } }
「{controller}/{action}/{id}」はhttp://ApplicationURL/の後ろに表示されるURLです。ASP.NET MVCではこのMapRouteで追加されたコレクションのURLしか表示されません。
定義 | 概要 |
{controller} | Controller名(例えばPubsControllerならPubs) |
{action} | Viewメソッドを呼び出すController内のメソッド名 |
{id} | Viewメソッドにパラメタが必要な場合に利用するパラメタ |
ルーティングルールは複数設定することができますが、リクエストによっては複数のルーティングルールに当てはまる場合があります。この時には、ルート名を指定することで、どのルートにパラメタを渡すか指定することができます。上記ルーティングルールに沿って以下の表のようなURLが生成されます。
URL | Controllerクラス | Actionメソッド | パラメタ |
/ | Home(既定で作成されるController) | Index(既定で作成されるAction) | なし |
/Home | Home | Index | なし |
/Pubs/Index | Pubs | Index | なし |
/Pubs/Create | Pubs | Create | なし |
/Pubs/Details/0736 | Pubs | Details | 0736 |
/Pubs/Edit/0877 | Pubs | Edit | 0877 |
URLルーティングはASP.NET MVCを扱う上で最低限必要なキモとなるので、実際に触れる前にポイントを押さえましょう。