ASP.NET Core通過路由(Routing)設(shè)定,將定義的URL規(guī)則找到相對應(yīng)行為;當(dāng)使用者Request的URL滿足特定規(guī)則條件時,則自動對應(yīng)到相符合的行為處理。從ASP.NET就已經(jīng)存在的架構(gòu),而且用法也很相似,只有些許的不同。
本篇將介紹ASP.NET Core的Router Middleware用法。
簡單路由
Startup.cs
// ...
public class Startup
{
// ...
public void Configure(IApplicationBuilder app)
{
// ...
app.Map("/first", mapApp =>
{
mapApp.Run(async context =>
{
await context.Response.WriteAsync("First. \r\n");
});
});
app.Map("/second", mapApp =>
{
mapApp.Run(async context =>
{
await context.Response.WriteAsync("Second. \r\n");
});
});
}
}
但要搭配ASP.NET Core MVC的話,簡單路由就沒這么好用了。
Router Middleware除了方便搭配ASP.NET Core MVC外,也可以比較彈性的使用路由定義。
路由注冊
RouterMiddleware 的路由注冊方式大致分為兩種:
?全局注冊。如:MapRoute。
?局部注冊。如:RouteAttribute。
預(yù)設(shè)路由的順序如下:

路由的Middleware需要Microsoft.AspNetCore.Routing套件。
在Startup.cs的ConfigureServices加入Routing的服務(wù),并在Configure定義路由規(guī)則:
Startup.cs
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
services.AddRouting();
}
public void Configure(IApplicationBuilder app)
{
var defaultRouteHandler = new RouteHandler(context =>
{
var routeValues = context.GetRouteData().Values;
return context.Response.WriteAsync($"Route values: {string.Join(", ", routeValues)}");
});
var routeBuilder = new RouteBuilder(app, defaultRouteHandler);
routeBuilder.MapRoute("default", "{first:regex(^(default|home)$)}/{second?}");
routeBuilder.MapGet("user/{name}", context => {
var name = context.GetRouteValue("name");
return context.Response.WriteAsync($"Get user. name: {name}");
});
routeBuilder.MapPost("user/{name}", context => {
var name = context.GetRouteValue("name");
return context.Response.WriteAsync($"Create user. name: {name}");
});
var routes = routeBuilder.Build();
app.UseRouter(routes);
}
}
可以看到上面代碼,建立了兩個對象:
RouteHandler:這個對象如同簡單路由的Run事件,當(dāng)路由成立的時候,就會執(zhí)行這個事件。
?RouteBuilder:在這個對象定義路由規(guī)則,當(dāng)Requset URL符合規(guī)則就會執(zhí)行該事件。 ?MapRoute:預(yù)設(shè)的路由規(guī)則,可以支持正則表示式(Regular Expressions)。
?MapGet & MapPost
HTTP Method路由:同樣的URL可以通過不同的HTTP Method,對應(yīng)不同的事件。
第一個路由MapRoute定義:
?URL第一層通過正則表示式必需是default或home,并放到路由變量first中。
?URL第二層可有可無,如果有的話,放到路由變量second中。
第二個路由MapGet定義:
?指定要是HTTP Get
?URL第一層必需是user。
?URL第二層必需要有值,放到路由變量name中。
第三個路由MapPost定義:
?指定要是HTTP Post
?URL第一層必需是user。
?URL第二層必需要有值,放到路由變量name中。
以上設(shè)定的路由結(jié)果如下:
?http://localhost:5000/default會顯示:
Route values: [first, default]
?http://localhost:5000/home/about會顯示:
Route values: [first, home], [second, about]
?http://localhost:5000/user/snaildev通過HTTP Get會顯示:
Get user. name: snaildev
?http://localhost:5000/user/snaildev通過HTTP Post會顯示:
Create user. name: snaildev
MVC 路由
MVC路由使用跟上面范例差不多,只是把事件指向Controller及Action。
ASP.NET Core MVC注冊路由規(guī)則的方式跟ASP.NET MVC差不多。
可以注冊多個MapRoute,每個Request會經(jīng)過這些RouterMiddleware找到對應(yīng)Action。
先被執(zhí)行到的路由,后面就會被跳過,所以越通用的越寫在下面,如下:
Startup.cs
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
services.AddMvc();
}
public void Configure(IApplicationBuilder app)
{
app.UseMvc(routes =>
{
routes.MapRoute(
name: "about",
template: "about",
defaults: new { controller = "Home", action = "About" }
);
routes.MapRoute(
name: "default",
template: "{controller=Home}/{action=Index}/{id?}"
);
// 跟上面設(shè)置的 default 效果一樣
//routes.MapRoute(
// name: "default",
// template: "{controller}/{action}/{id?}",
// defaults: new { controller = "Home", action = "Index" }
//);
});
}
}
以上設(shè)定的路由結(jié)果如下:
http://localhost:5000 會對應(yīng)到HomeController 的Index()。
http://localhost:5000/about 會對應(yīng)到HomeController 的About()。
http://localhost:5000/home/test 會對應(yīng)到HomeController 的Test()。
RouteAttribute
預(yù)設(shè)RouteAttribute的優(yōu)先順序高于Startup注冊的MapRoute,所以當(dāng)使用[Route]后,原本的MapRoute將不再對Controller或Action產(chǎn)生作用。
[Route("[controller]")]
public class UserController : Controller
{
[Route("")]
public IActionResult Profile()
{
return View();
}
[Route("change-password")]
public IActionResult ChangePassword()
{
return View();
}
[Route("[action]")]
public IActionResult Other()
{
return View();
}
}
以上設(shè)定的路由結(jié)果如下:
http://localhost:5000/user 會對應(yīng)到UserController 的Profile()。
http://localhost:5000/user/change-password 會對應(yīng)到UserController 的ChangePassword()。
http://localhost:5000/user/other 會對應(yīng)到UserController 的Other()。
若Controller設(shè)定了[Route],Action就要跟著加[Route],不然會發(fā)生錯誤。
如果只有特定的Action 需要改路由,也可以只加Action。如下:
public class UserController : Controller
{
public IActionResult Profile()
{
return View();
}
[Route("change-password")]
public IActionResult ChangePassword()
{
return View();
}
public IActionResult Other()
{
return View();
}
}
http://localhost:5000/user/profile 會對應(yīng)到UserController 的Profile()。
http://localhost:5000/change-password 會對應(yīng)到UserController 的ChangePassword()。
http://localhost:5000/user/other 會對應(yīng)到UserController 的Other()。
注意!如果[Route]是設(shè)定在Action,路徑是由網(wǎng)站根路徑開始算。
如果要用MVC預(yù)設(shè)路由,可以使用 ASP.NET Core 2 學(xué)習(xí)筆記(六)MVC中 提到的:
- UseMvcWithDefaultRoute
這個是ASP.NET Core的預(yù)設(shè)路由,會將Request來的URL找到對應(yīng)的Controller及Action。