ASP.NET Core 2 學習筆記（七）路由

ASP.NET Core經過路由(Routing)設定，將定義的URL規則找到相對應行爲；當使用者Request的URL知足特定規則條件時，則自動對應到相符合的行爲處理。從ASP.NET就已經存在的架構，並且用法也很類似，只有些許的不一樣。
本篇將介紹ASP.NET Core的Router Middleware用法。

簡單路由

以前 ASP.NET Core 2 學習筆記（三）有介紹到，能夠透過Map處理一些簡單路由，例如：

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。

預設路由的順序以下：

路由的Middleware須要Microsoft.AspNetCore.Routing套件。

在Startup.cs的ConfigureServices加入Routing的服務，並在Configure定義路由規則：

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事件，當路由成立的時候，就會執行這個事件。
• RouteBuilder：在這個對象定義路由規則，當Requset URL符合規則就會執行該事件。
  • MapRoute：預設的路由規則，能夠支持正則表示式(Regular Expressions)。
  • MapGet & MapPost
    HTTP Method路由：一樣的URL能夠經過不一樣的HTTP Method，對應不一樣的事件。

第一個路由MapRoute定義：

• URL第一層經過正則表示式必需是default或home，並放到路由變量first中。
• URL第二層無關緊要，若是有的話，放到路由變量second中。

第二個路由MapGet定義：

• 指定要是HTTP Get
• URL第一層必需是user。
• URL第二層必須要有值，放到路由變量name中。

第三個路由MapPost定義：

• 指定要是HTTP Post
• URL第一層必需是user。
• URL第二層必須要有值，放到路由變量name中。

以上設定的路由結果以下：

• 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註冊路由規則的方式跟ASP.NET MVC差很少。
能夠註冊多個MapRoute，每一個Request會通過這些RouterMiddleware找到對應Action。
先被執行到的路由，後面就會被跳過，因此越通用的越寫在下面，以下：

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?}"
            );
            // 跟上面設置的 default 效果同樣
            //routes.MapRoute(
            //    name: "default",
            //    template: "{controller}/{action}/{id?}",
            //    defaults: new { controller = "Home", action = "Index" }
            //);
        });
    }
}

以上設定的路由結果以下：

• http://localhost:5000 會對應到HomeController 的Index()。
• http://localhost:5000/about 會對應到HomeController 的About()。
• http://localhost:5000/home/test 會對應到HomeController 的Test()。

RouteAttribute

預設RouteAttribute的優先順序高於Startup註冊的MapRoute，因此當使用[Route]後，本來的MapRoute將再也不對Controller或Action產生做用。

[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();
    }
}

以上設定的路由結果以下：

• http://localhost:5000/user 會對應到UserController 的Profile()。
• http://localhost:5000/user/change-password 會對應到UserController 的ChangePassword()。
• http://localhost:5000/user/other 會對應到UserController 的Other()。

若Controller設定了[Route]，Action就要跟着加[Route]，否則會發生錯誤。

若是隻有特定的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 會對應到UserController 的Profile()。
• http://localhost:5000/change-password 會對應到UserController 的ChangePassword()。
• http://localhost:5000/user/other 會對應到UserController 的Other()。

注意！若是[Route]是設定在Action，路徑是由網站根路徑開始算。

 

若是要用MVC預設路由，可使用 ASP.NET Core 2 學習筆記（六）MVC中 提到的：

• UseMvcWithDefaultRoute

 這個是ASP.NET Core的預設路由，會將Request來的URL找到對應的Controller及Action。

參考

Routing in ASP.NET Core

 

老司機發車啦：https://github.com/SnailDev/SnailDev.NETCore2Learning