ASP.NET MVCのルーティングの基本

＜目次＞

(１) ASP.NET MVCのルーティングの基本
　 (１-１) 構文
　 (１-２) サンプルプログラム
　　・RouteConfig.cs
　　・Controller
　　・View
　(１-３) 補足：要求されたURLがパターンにマッチしない場合

(１) ASP.NET MVCのルーティングの基本

ルーティングというのはブラウザ（クライアント）から来るリクエストを、適切なMVCのControllerアクションに振り分け、レスポンスを返す役割を果たします。

ルーティングの設定は「/App_Start」配下の「RoutingConfig.cs」というC#のモジュールに設定されています。

(１-１) 構文

以下はデフォルトで用意されているルーティング用のメソッドです。

●構文（ルーティング全体）

public static void RegisterRoutes(RouteCollection routes)  
{  
	routes.IgnoreRoute("{resource}.axd/{*pathInfo}");  
	routes.MapRoute(  
		name: "Default",  
		url: "{controller}/{action}/{id}",  
		defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }  
	);  
}

●構文説明

・RegisterRoutes()メソッド

MVCのアプリケーションが最初に処理開始する際に、まず最初に「Global.asax.cs」の「Application_Start()」メソッドが呼び出され、そこからRouteConfig.csのRegisterRoutes()メソッドが呼び出されます。

（図１１１）

・MapRoute()メソッド

そしてRegisterRoutes()メソッド内で「MapRoute()」メソッドを呼び出す事によって「ルートテーブル」を生成します。

（構文）MapRoute

Route MapRoute(string name, string url, Object defaults)

引数の意味は次の通りです。

（表）

name	ルートを一意に識別するための名前です。デフォルトのルートは「Default」という名前になっています。（例） name: “Default”
url	リクエストURLとのマッチングを行うためのURLパターンを指定します。（例） url: “{controller}/{action}/{id}”
default	上記の{controller}、{action}、{id}といったパラメータにデフォルト値を、匿名のプロパティを使ってセットします。（例） defaults: new { controller = “Home”, action = “Index”, id = UrlParameter.Optional }

デフォルトのルートテーブルは「Default」という名前のルートが１つだけ定義されています。そしてURL（url: “{controller}/{action}/{id}”）の各セグメントは次のように割り当てられています。

（表１）

	プレースホルダ―	紐づける値
第１セグメント	{controller}	コントローラー名を割り当て（例：Home）
第２セグメント	{action}	コントローラーのアクションに割り当て（例：Index）
第３セグメント	{id}	任意のユーザーパラメータを割り当て

なので、例えば下図のように「https://localhost:44313/Home/Index/1」のようなURLをリクエストした場合は、デフォルトルート（Default）によってURLを次のようにマッピングします。

controller：Home

action：Index

id：1

（図１１２）

そして内部的には、次のメソッドが実行されます。

HomeController.Index(1)

（図１１３）

＞目次にもどる

(１-２) サンプルプログラム

簡単なASP.NET MVCのアプリケーションを例に使って、ルーティングのイメージを掴んでいけたらと思います。

構造としてはシンプルで「HomeController.cs」というコントローラーと、「Index.cshtml」というビューがあります。そして、クライアントからリクエストを受けたのちRouteConfig.cs（▲1）からController（▲2）へのルーティングを行い、そこからView（▲3）が描画される流れをイメージするために、▲1～▲3のサンプルプログラムを掲載します。

（構造）

App_Start

　∟RouteConfig.cs

Controller

　∟HomeController.cs

Views

　∟Home

　　∟Index.cshtml

Global.asax

（図１２１）

・RouteConfig.cs

RouteConfig.csのサンプルです。先ほどご紹介した構文をベースにしています。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
using System.Web.Routing;

namespace MVCTest
{
  public class RouteConfig
  {
    public static void RegisterRoutes(RouteCollection routes)
    {
      routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

      routes.MapRoute(
        name: "Default",
        url: "{controller}/{action}/{id}",
        defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
      );
    }
  }
}

＞目次にもどる

・Controller

Controllerのサンプルは以下になりますが、概要については別記事「ASP.NETのMVCとは？」にてご紹介しています。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;

namespace MVCTest.Controllers
{
    public class HomeController : Controller
    {
        // GET: Home
        public ActionResult Index()
        {
            return View();
        }
    }
}

＞目次にもどる

・View

Viewについても、概要は別記事「ASP.NETのMVCとは？」にてご紹介しています。

@{
    Layout = null;
}

<!DOCTYPE html>

<html>
<head>
    <meta name="viewport" content="width=device-width" />
    <title></title>
</head>
<body>
    <div>
 HelloWorld
    </div>
</body>
</html>

（図１２２）