文章出處

問題

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/


文章列表


不含病毒。www.avast.com
arrow
arrow
    全站熱搜
    創作者介紹
    創作者 大師兄 的頭像
    大師兄

    IT工程師數位筆記本

    大師兄 發表在 痞客邦 留言(0) 人氣()