CodeZine(コードジン)

特集ページ一覧

ASP.NET MVCフレームワークの概要を理解する

ASP.NET MVCフレームワーク 正式版 入門(1)

  • LINEで送る
  • このエントリーをはてなブックマークに追加
2009/06/02 14:00
目次

URLルーティング

 MVCの肝の部分としてURLルーティングが挙げられます。今までASP.NETでは「.aspx」ファイルやフォルダがある場所のURLしか表示できませんでした。しかし、URLルーティングを利用することで、仮想的にURLマッピングを行うことができるようになります。

 図2のソリューション構成の場合、通常ならばhttp://xxx/Views/Home/Index.aspxとなります。しかし、 URLルーティングを利用するとhttp://xxx/Home/IndexというURLになります。

図2 ASP.NET MVCのURLルーティング例
図2 ASP.NET MVCのURLルーティング例

 図2のURLルーティングは以下のコードにより実装されています。

PubsController.cs 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ルーティングは以下の流れです。

  1. ControllersフォルダのHomeと、Viewsフォルダ内のHomeフォルダがマッピングされる
  2. http://xxx/Home/Indexにアクセスされた時、Controllersフォルダ内のHomeControllerクラス内に記述されている「Index」Actionメソッド内の処理を実行。今回はパラメタが指定されていないのでIndex.aspxが表示される

 なぜこのようなことができるようになったのでしょうか? ポイントはURLルーティングルールにあります。

URLルーティングルール

 ASP.NET MVCプロジェクトを作成した時点で、ルーティングルールを「Global.asax」に自動生成します。

 原理として、Webアプリケーション起動時に一度だけ呼び出されるGlobal.asaxのApplication_StartメソッドからRegisterRoutesメソッドを呼び出してルーティングルールをルートコレクションに追加しています。

 ルーティングルールは、「リクエストにより利用するURLの雛形を定義する」ことと、「リクエスト時にパラメタが足りない場合の雛形の初期値の設定」を行います。

 以下のコードは既定で作成されるルーティングルールです。

Global.asaxの一部
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が生成されます。

{controller}/{action}/{id}の生成する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を扱う上で最低限必要なキモとなるので、実際に触れる前にポイントを押さえましょう。


  • LINEで送る
  • このエントリーをはてなブックマークに追加

バックナンバー

連載:ASP.NET MVCフレームワーク 正式版 入門

著者プロフィール

  • 山田 祥寛(ヤマダ ヨシヒロ)

    静岡県榛原町生まれ。一橋大学経済学部卒業後、NECにてシステム企画業務に携わるが、2003年4月に念願かなってフリーライターに転身。Microsoft MVP for ASP/ASP.NET。執筆コミュニティ「WINGSプロジェクト」代表。 主な著書に「入門シリーズ(サーバサイドAjax/XM...

  • WINGSプロジェクト ナオキ(ナオキ)

    <WINGSプロジェクトについて> 有限会社 WINGSプロジェクトが運営する、テクニカル執筆コミュニティ(代表 山田祥寛)。主にWeb開発分野の書籍/記事執筆、翻訳、講演等を幅広く手がける。2018年11月時点での登録メンバは55名で、現在も執筆メンバを募集中。興味のある方は、どしどし応募頂...

あなたにオススメ

All contents copyright © 2005-2021 Shoeisha Co., Ltd. All rights reserved. ver.1.5