[譯]ASP.NET Core 2.0 路由引擎

三生石上(FineUI控制元件)發表於2017-11-01
ASP.NET路由

問題

ASP.NET Core 2.0的路由引擎是如何工作的？

答案

建立一個空專案，為Startup類新增MVC服務和請求中介軟體：

public void ConfigureServices(IServiceCollection services)
{
	services.AddMvc();
}

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
	app.UseMvc(routes =>
	{
		routes.MapRoute(
			name: "goto_one",
			template: "one",
			defaults: new { controller = "Home", action = "PageOne" });

		routes.MapRoute(
			name: "goto_two",
			template: "two/{id?}",
			defaults: new { controller = "Home", action = "PageTwo" });

		routes.MapRoute(
			name: "default",
			template: "{controller=Home}/{action=Index}/{id?}");
	});
}

建立一個控制器HomeController，來演示常規路由：

public class HomeController : Controller
{
	public IActionResult Index()
	{
		return Content("Home/Index");
	}

	public IActionResult PageOne()
	{
		return Content("Home/One");
	}

	[HttpGet]
	public IActionResult PageTwo()
	{
		return Content("(GET) Home/Two");
	}

	[HttpPost]
	public IActionResult PageTwo(int id)
	{
		return Content($"(POST) Home/Two: {id}");
	}
}

建立一個控制器WorkController，來演示特性路由：

[Route("work")]
public class WorkController : Controller
{
	public IActionResult Index()
	{
		return Content("Work/Index");
	}

	[Route("one")]
	public IActionResult PageOne()
	{
		return Content("Work/One");
	}

	[HttpGet("two")]
	public IActionResult PageTwo()
	{
		return Content("(GET) Work/Two");
	}

	[HttpPost("two/{id?}")]
	public IActionResult PageTwo(int id)
	{
		return Content($"(POST) Work/Two: {id}");
	}
}

討論

ASP.NET Core的路由引擎可以將傳入的請求對映到控制器和它們的方法中。這是通過向請求管道中新增路由中介軟體實現的，具體來說是使用IRouteBuilder將URL規則（模板）對映到一個控制器的方法。

路由模板

路由模板可以使用字面值和標記（標識路由引數）。在匹配一個路由時，字面值會嚴格匹配URL中的文字，而標記會被替換掉。
為了匹配一個模板，模板中必須包含控制器和方法標記以便定位控制器方法（這是MVC的核心資訊）。模板中的其它標記被對映為方法的引數（通過模型繫結實現）。
當新增一個路由對映時，可以為標記提供預設值。當模板中不包含控制器和方法標記時會很有用。模板也可以包含對應於方法引數的可選標記。
讓我們來看一個示例模板：

contact/{controller=Home}/{action=Index}/{id?}


注意如下幾點：

  1. 標記包含中大括號中。這裡有三個標記，分別是controller，action和id。
  2. 模板中包含一個字面值contact，它會匹配URL中的文字。
  3. 已經為controller（Home）和action（Index）提供了預設值。
  4. 可選標記通過問號來宣告。

下面的URL會匹配這個模板：

  • /contact/Home/Index/1: 所有標記都有值。
  • /contact/Home/Index: 忽略了可選標記。
  • /contact/Home: 忽略了action標記，將使用預設值Index。
  • /contact: 忽略了controller和action標記，將分別使用其預設值Home和Index。


常規路由

常規路由為URL路徑建立一個約定, 例如給定一個模板:

  1. 第一個標記對映到控制器
  2. 第二個標記對映到方法
  3. 第三個標記對映到可選的方法引數id

你也可以從模板中省略控制器和方法，只要你為它們提供預設值就行了。比如下面的路由會對映到地址/one，因為通過defaults提供了所需的控制器和方法標記：

routes.MapRoute(
       name: "goto_one",
       template: "one",
       defaults: new { controller = "Home", action = "PageOne" });

注：請將此特定路由新增到通用路由之前，因為路由是按照定義的順序執行的，一旦某個路由匹配成功，則整個匹配流程就會終結。

由於路由中介軟體只使用了控制器和方法標記來對映到一個控制器方法，因此同一個控制器中放置多個同名的的方法將會丟擲異常。為了解決這個問題，可以使用方法上的IActionConstraint特性（比如HttpGet，HttpPost等特性）：

[HttpGet("two")]
public IActionResult PageTwo()
{
	return Content("(GET) Work/Two");
}

[HttpPost("two/{id?}")]
public IActionResult PageTwo(int id)
{
	return Content($"(POST) Work/Two: {id}");
}

 

====start by sanshi=========================

為了觀察控制器中同名方法出現的異常，我們首先需要修改Configure()方法，新增開發時異常處理中介軟體：

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
	if (env.IsDevelopment())
	{
		app.UseDeveloperExceptionPage();
	}

	app.UseMvc(routes => ....);
}

修改HomeController：

public IActionResult PageTwo()
{
	return Content("(GET) Home/Two");
}
public IActionResult PageTwo(int id)
{
	return Content($"(POST) Home/Two: {id}");
}

看似很正常的過載函式，但是放到控制器中會丟擲異常。

在瀏覽器位址列敲入：http://localhost:65415/Home/PageTwo，觀看到異常頁面：

　　

====end by sanshi=========================　　


特性路由

特性路由通過直接為控制器和方法提供路由模板來實現。
我們可以使用[Route]或者[HttpGet]（或者其他動詞）特性來指定模板。這些模板可以包含字面值和標記（不能包含控制器和方法標記）。
執行時，控制器的特性模板和方法的特性模板會被合併到一起，比如，在WorkController中，PageOne方法可以通過/work/one訪問：

[Route("work")]
public class WorkController : Controller
{
	[Route("one")]
	public IActionResult PageOne()
	{
		return Content("Work/One");
	}
}

 

原始碼下載

 

原文：https://tahirnaushad.com/2017/08/20/asp-net-core-mvc-routing/

相關文章