[Asp.net MVC]Asp.net MVC5系列——Routing特性

目錄

概述

路由特性

使用路由

可選參數和參數的默認值

路由前綴

默認路由

路由約束

自定義路由約束

路由名

區域（Area）

總結

系列文章

[Asp.net MVC]Asp.net MVC5系列——第一個項目

[Asp.net MVC]Asp.net MVC5系列——添加視圖

[Asp.net MVC]Asp.net MVC5系列——添加模型

[Asp.net MVC]Asp.net MVC5系列——從控制器訪問模型中的數據

[Asp.net MVC]Asp.net MVC5系列——添加數據

[Asp.net MVC]Asp.net MVC5系列——在模型中添加驗證規則 

[Asp.net MVC]Asp.net MVC5系列——實現編輯、刪除與明細信息視圖

[Asp.net MVC]Asp.net MVC5系列——Razor語法

概述

ASP.NET MVC 5支持一種新的路由協議，稱為路由特性。顧名思義，路由特性使用特性來定義路徑。路由特性使你的Web應用程序URI有了更多的控制。當然，MVC5也支持以前定義路由的方式，你可以在一個項目中混合使用這兩種方式來定義路由。

路由特性

例如，一個電子商務網站可能有以下的路由規則：

{productId:int}/{productTitle} 
Mapped to ProductsController.Show(int id)
{username} 
Mapped to ProfilesController.Show(string username)
{username}/catalogs/{catalogId:int}/{catalogTitle} 
Mapped to CatalogsController.Show(string username, int catalogId)

以往的ASP.NET MVC版本，該規則將設置在routeconfig.cs文件中，並指出實際控制器的Action方法，如：

routes.MapRoute(
    name: "ProductPage",
    url: "{productId}/{productTitle}",
    defaults: new { controller = "Products", action = "Show" },
    constraints: new { productId = "\\d+" }
);

當路由的定義與Action方法，在同一個源文件中而不是在外部配置類中聲明，它可以更容易的處理URI和行動之間的映射的。以前的路徑定義將使用以下，簡單的特性就可以達到目的：

[Route("{productId:int}/{productTitle}")]
public ActionResult Show(int productId) { ... }

使用路由特性

首先得啟用Attribute路由，我們可以調用MapMvcAttributeRoutes方法來啟用Attribute路由：

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

也可以和常規的路由設置一起使用。

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

可選URI參數和參數的默認值

可以通過添加“?”標記一個參數為可選的參數，也可以為表單參數設置默認值（參數=value）。

public class BooksController : Controller
{
    // eg: /books
    // eg: /books/1430210079
    [Route("books/{isbn?}")]
    public ActionResult View(string isbn)
    {
        if (!String.IsNullOrEmpty(isbn))
        {
            return View("OneBook", GetBook(isbn));
        }
        return View("AllBooks", GetBooks());
    }
 
    // eg: /books/lang
    // eg: /books/lang/en
    // eg: /books/lang/he
    [Route("books/lang/{lang=en}")]
    public ActionResult ViewByLanguage(string lang)
    {
        return View("OneBook", GetBooksByLanguage(lang));
    }
}

在上面的例子中，/books和/books/1430210079將路由到View方法，前者將返回所有書的列表信息，后者將返回特定的書的信息。/books/lang和/books/lang/en將采用同樣的方式。

路由前綴

在同一個控制器里面，路由以相同的前綴開始，例如：

public class ReviewsController : Controller
{
    // eg: /reviews
    [Route("reviews")]
    public ActionResult Index() { ... }
    // eg: /reviews/5
    [Route("reviews/{reviewId}")]
    public ActionResult Show(int reviewId) { ... }
    // eg: /reviews/5/edit
    [Route("reviews/{reviewId}/edit")]
    public ActionResult Edit(int reviewId) { ... }
}

你可以通過使用[routeprefix ]特性整個控制器設定一個共同的前綴：

[RoutePrefix("reviews")]
public class ReviewsController : Controller
{
    // eg.: /reviews
    [Route]
    public ActionResult Index() { ... }
    // eg.: /reviews/5
    [Route("{reviewId}")]
    public ActionResult Show(int reviewId) { ... }
    // eg.: /reviews/5/edit
    [Route("{reviewId}/edit")]
    public ActionResult Edit(int reviewId) { ... }
}

如果需要定義不同的路由前綴，可以在方法特性上使用波浪號~覆蓋原來的前綴，例如：

[RoutePrefix("reviews")]
public class ReviewsController : Controller
{
    // eg.: /spotlight-review
    [Route("~/spotlight-review")]
    public ActionResult ShowSpotlight() { ... }
 
    ...
}

默認路由

你也可以運用在控制器級別的[路徑]特性，將Action方法作為一個參數。該路由將被應用在控制器中的所有Action方法，除非Action方法使用了一個具體的[路由]特性，否則將使用控制器級別的默認路由。

[RoutePrefix("promotions")]
[Route("{action=index}")]
public class ReviewsController : Controller
{
    // eg.: /promotions
    public ActionResult Index() { ... }
 
    // eg.: /promotions/archive
    public ActionResult Archive() { ... }
 
    // eg.: /promotions/new
    public ActionResult New() { ... }
 
    // eg.: /promotions/edit/5
    [Route("edit/{promoId:int}")]
    public ActionResult Edit(int promoId) { ... }
}

由上可知，Action方法的路由特性的優先級大於控制器路由特性的優先級。

路由約束

路由約束，使你限制路由模版中的參數是如何匹配的，一般的語法為{parameter:constraint}，例如：

// eg: /users/5
[Route("users/{id:int}"]
public ActionResult GetUserById(int id) { ... }
 
// eg: users/ken
[Route("users/{name}"]
public ActionResult GetUserByName(string name) { ... }

這里，如果id為int類型，將選擇第一個路由，否則選擇第二個路由。

下表列出了支持的約束：

注意，其中一些帶min的約束，可以帶參數。

你也可以在一個參數上應用多個約束，多個約束以分號";"分割，例如：

// eg: /users/5
// but not /users/10000000000 because it is larger than int.MaxValue,
// and not /users/0 because of the min(1) constraint.
[Route("users/{id:int:min(1)}")]
public ActionResult GetUserById(int id) { ... }

通過問號"?"可以在內聯約束中指定可選參數，例如：

// eg: /greetings/bye
// and /greetings because of the Optional modifier,
// but not /greetings/see-you-tomorrow because of the maxlength(3) constraint.
[Route("greetings/{message:maxlength(3)?}")]
public ActionResult Greet(string message) { ... }

自定義路由約束

可以通過實現接口IRouteConstraint 自定義路由約束，例如，定義一個參數有效性的約束：

public class ValuesConstraint : IRouteConstraint
{
    private readonly string[] validOptions;
    public ValuesConstraint(string options)
    {
        validOptions = options.Split('|');
    }
 
    public bool Match(HttpContextBase httpContext, Route route, string parameterName, RouteValueDictionary values, RouteDirection routeDirection)
    {
        object value;
        if (values.TryGetValue(parameterName, out value) && value != null)
        {
            return validOptions.Contains(value.ToString(), StringComparer.OrdinalIgnoreCase);
        }
        return false;
    }
}

然后將自定義的約束進行注冊：

public class RouteConfig
{
    public static void RegisterRoutes(RouteCollection routes)
    {
        routes.IgnoreRoute("{resource}.axd/{*pathInfo}");
 
        var constraintsResolver = new DefaultInlineConstraintResolver();
 
        constraintsResolver.ConstraintMap.Add("values", typeof(ValuesConstraint));
 
        routes.MapMvcAttributeRoutes(constraintsResolver);
    }
}

現在，你就可以在你的路由中使用該自定義的約束了

public class TemperatureController : Controller
{
    // eg: temp/celsius and /temp/fahrenheit but not /temp/kelvin
    [Route("temp/{scale:values(celsius|fahrenheit)}")]
    public ActionResult Show(string scale)
    {
        return Content("scale is " + scale);
    }
}

路由名

你可以為一個路由指定一個名稱，以便生成相應的url。例如： 

[Route("menu", Name = "mainmenu")]
public ActionResult MainMenu() { ... }

你可以使用 Url.RouteUrl 來生成相應的 URL

<a href="@Url.RouteUrl("mainmenu")">Main menu</a>

區域（Area）

你可以使用特性[RouteArea]指定一個控制器屬於某個區域，當這樣做時，你可以安全的移除該區域的AreaRegistration 類：

[RouteArea("Admin")]
[RoutePrefix("menu")]
[Route("{action}")]
public class MenuController : Controller
{
    // eg: /admin/menu/login
    public ActionResult Login() { ... }
 
    // eg: /admin/menu/show-options
    [Route("show-options")]
    public ActionResult Options() { ... }
 
    // eg: /stats
    [Route("~/stats")]
    public ActionResult Stats() { ... }
}

使用該控制器，下面的鏈接將產生下面的url："/Admin/menu/show-options"

Url.Action("Options", "Menu", new { Area = "Admin" })

你也可以使用AreaPrefix參數建立一個自定義的區域前綴，例如：

[RouteArea("BackOffice", AreaPrefix = "back-office")]

如果你同時使用帶有路由特性的區域和帶有（AreaRegistration 類創建的）傳統路由的區域這兩種方式 的話，你應該在配置MVC路由特性之后，默認傳統路由之前注冊區域，原因很簡單，路由注冊順序必須是從最精確的匹配規則開始再到普通的匹配規則，最后才是模糊的匹配規則，這樣就避免了在進行路由匹配時，過早的匹配了模糊規則，而相對精確的匹配起不到任何作用。下面的例子展示了這一點：

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

 

 

總結

本文主要學習了asp.net mvc5路由的新特性，在查看mvc5的資料的時候，看到的一篇文章，覺得不錯，就認真的看了一遍，試着用自己的語言翻譯了原文，也許有翻譯不到位的地方，望諒解，如果你英語不錯，也可以參考原文。

原文地址：http://blogs.msdn.com/b/webdev/archive/2013/10/17/attribute-routing-in-asp-net-mvc-5.aspx