史上最全的ASP.NET MVC路由配置,以後RouteConfig再弄不懂神仙都難救你啦~

原文http://www.cnblogs.com/zeusro/p/RouteConfig.html 裝載註明出處,爬蟲請自重。

繼續延續坑爹標題系列。其實只是把apress.pro.asp.net.mvc.4.framework裏的CHAPTER 13翻譯過來罷了,當做自己總結吧。內容看看就好,排版就不要吐槽了,反正我知道你也不會反對的。

先說一下基本的路由規則原則。基本的路由規則是從特殊到一般排列,也就是最特殊(非主流)的規則在最前面,最一般(萬金油)的規則排在最後。這是因爲匹配路由規則也是照着這個順序的。如果寫反了,那麼即便你路由規則寫對了那照樣坐等404.

XD 首先說URL的構造。 其實這個也談不上構造,只是語法特性吧。

URL構造

命名參數規範+匿名對象

routes.MapRoute(name: "Default",url: "{controller}/{action}/{id}", defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional } );

 

構造路由然後添加

 

1
2
Route myRoute = new Route("{controller}/{action}"new MvcRouteHandler());
routes.Add("MyRoute", myRoute);

 

直接方法重載+匿名對象

1
routes.MapRoute("ShopSchema""Shop/{action}"new { controller = "Home" });

 

  個人覺得第一種比較易懂,第二種方便調試,第三種寫起來比較效率吧。各取所需吧。本文行文偏向於第三種。

路由規則

 1.默認路由(MVC自帶)

 

1
2
3
4
routes.MapRoute(
"Default"// 路由名稱
"{controller}/{action}/{id}"// 帶有參數的 URL
new { controller = "Home", action = "Index", id = UrlParameter.Optional } // 參數默認值 (UrlParameter.Optional-可選的意思) );

 

2.靜態URL段

 

1
2
3
4
5
routes.MapRoute("ShopSchema2""Shop/OldAction"new { controller = "Home", action = "Index" });
 
routes.MapRoute("ShopSchema""Shop/{action}"new { controller = "Home" });
routes.MapRoute("ShopSchema2""Shop/OldAction.js",
 new { controller = "Home", action = "Index" });

 沒有佔位符路由就是現成的寫死的。

比如這樣寫然後去訪問http://localhost:XXX/Shop/OldAction.js,response也是完全沒問題的。 controller , action , area這三個保留字就別設靜態變量裏面了。

3.自定義常規變量URL段(好吧這翻譯暴露智商了)

 

1
routes.MapRoute("MyRoute2""{controller}/{action}/{id}"new { controller = "Home", action = "Index", id = "DefaultId" });

 

這種情況如果訪問 /Home/Index 的話,因爲第三段(id)沒有值,根據路由規則這個參數會被設爲DefaultId

這個用viewbag給title賦值就能很明顯看出

1
ViewBag.Title = RouteData.Values["id"];

 

圖不貼了,結果是標題顯示爲DefaultId。 注意要在控制器裏面賦值,在視圖賦值沒法編譯的。

4.再述默認路由

然後再回到默認路由。 UrlParameter.Optional這個叫可選URL段.路由裏沒有這個參數的話id爲null。 照原文大致說法,這個可選URL段能用來實現一個關注點的分離。剛纔在路由裏直接設定參數默認值其實不是很好。照我的理解,實際參數是用戶發來的,我們做的只是定義形式參數名。但是,如果硬要給參數賦默認值的話,建議用語法糖寫到action參數裏面。比如:

 

1
public ActionResult Index(string id = "abcd"){ViewBag.Title = RouteData.Values["id"];return View();}

 

5.可變長度路由。

 

1
routes.MapRoute("MyRoute""{controller}/{action}/{id}/{*catchall}"new { controller = "Home", action = "Index", id = UrlParameter.Optional });

 

在這裏id和最後一段都是可變的,所以 /Home/Index/dabdafdaf 等效於 /Home/Index//abcdefdjldfiaeahfoeiho 等效於 /Home/Index/All/Delete/Perm/.....

6.跨命名空間路由

 這個提醒一下記得引用命名空間,開啓IIS網站不然就是404。這個非常非主流,不建議瞎搞。

 

1
routes.MapRoute("MyRoute","{controller}/{action}/{id}/{*catchall}"new { controller = "Home", action = "Index", id = UrlParameter.Optional },new[] { "URLsAndRoutes.AdditionalControllers""UrlsAndRoutes.Controllers" });

 

但是這樣寫的話數組排名不分先後的,如果有多個匹配的路由會報錯。 然後作者提出了一種改進寫法。

 

1
2
3
routes.MapRoute("AddContollerRoute","Home/{action}/{id}/{*catchall}",new { controller = "Home", action = "Index", id = UrlParameter.Optional },new[] { "URLsAndRoutes.AdditionalControllers" });
 
routes.MapRoute("MyRoute""{controller}/{action}/{id}/{*catchall}"new { controller = "Home", action = "Index", id = UrlParameter.Optional },new[] { "URLsAndRoutes.Controllers" });

 這樣第一個URL段不是Home的都交給第二個處理 最後還可以設定這個路由找不到的話就不給後面的路由留後路啦,也就不再往下找啦。

1
2
3
4
Route myRoute = routes.MapRoute("AddContollerRoute",
"Home/{action}/{id}/{*catchall}",
new { controller = "Home", action = "Index", id = UrlParameter.Optional },
new[] { "URLsAndRoutes.AdditionalControllers" });  myRoute.DataTokens["UseNamespaceFallback"] = false;

 

7.正則表達式匹配路由

1
2
3
4
routes.MapRoute("MyRoute""{controller}/{action}/{id}/{*catchall}",
 new { controller = "Home", action = "Index", id = UrlParameter.Optional },
 new { controller = "^H.*"},
new[] { "URLsAndRoutes.Controllers"});

 

 約束多個URL

 

1
2
3
4
routes.MapRoute("MyRoute""{controller}/{action}/{id}/{*catchall}",
new { controller = "Home", action = "Index", id = UrlParameter.Optional },
new { controller = "^H.*", action = "^Index$|^About$"},
new[] { "URLsAndRoutes.Controllers"});

 

8.指定請求方法

 

1
2
3
4
5
6
7
routes.MapRoute("MyRoute""{controller}/{action}/{id}/{*catchall}",
 
new { controller = "Home", action = "Index", id = UrlParameter.Optional },
 
new { controller = "^H.*", action = "Index|About", httpMethod = new HttpMethodConstraint("GET") },
 
new[] { "URLsAndRoutes.Controllers" });

 

9. WebForm支持

1
2
3
4
5
6
7
routes.MapPageRoute("""""~/Default.aspx");
 
 routes.MapPageRoute("list""Items/{action}""~/Items/list.aspx"falsenew RouteValueDictionary { { "action""all" } });
 
 routes.MapPageRoute("show""Show/{action}""~/show.aspx"falsenew RouteValueDictionary { { "action""all" } });
 
 routes.MapPageRoute("edit""Edit/{id}""~/edit.aspx"falsenew RouteValueDictionary { { "id""1" } }, new RouteValueDictionary { { "id"@"\d+" } });

 具體的可以看

使用Asp.Net4新特性路由創建WebForm應用

或者官方msdn

 

10.MVC5的RouteAttribute

首先要在路由註冊方法那裏

1
2
//啓用路由特性映射
routes.MapMvcAttributeRoutes();

 這樣

1
[Route("Login")]

 route特性纔有效.該特性有好幾個重載.還有路由約束啊,順序啊,路由名之類的.

其他的還有路由前綴,路由默認值

1
[RoutePrefix("reviews")]<br>[Route("{action=index}")]<br>public class ReviewsController : Controller<br>{<br>}

 路由構造

1
2
3
4
5
6
7
// eg: /users/5
[Route("users/{id:int}"]
public ActionResult GetUserById(int id) { ... }
  
// eg: users/ken
[Route("users/{name}"]
public ActionResult GetUserByName(string name) { ... }

 參數限制

1
2
3
4
5
// 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) { ... }

  

Constraint Description Example
alpha Matches uppercase or lowercase Latin alphabet characters (a-z, A-Z) {x:alpha}
bool Matches a Boolean value. {x:bool}
datetime Matches a DateTime value. {x:datetime}
decimal Matches a decimal value. {x:decimal}
double Matches a 64-bit floating-point value. {x:double}
float Matches a 32-bit floating-point value. {x:float}
guid Matches a GUID value. {x:guid}
int Matches a 32-bit integer value. {x:int}
length Matches a string with the specified length or within a specified range of lengths. {x:length(6)}  {x:length(1,20)}
long Matches a 64-bit integer value. {x:long}
max Matches an integer with a maximum value. {x:max(10)}
maxlength Matches a string with a maximum length. {x:maxlength(10)}
min Matches an integer with a minimum value. {x:min(10)}
minlength Matches a string with a minimum length. {x:minlength(10)}
range Matches an integer within a range of values. {x:range(10,50)}
regex Matches a regular expression. {x:regex(^\d{3}-\d{3}-\d{4}$)}

 

具體的可以參考

Attribute Routing in ASP.NET MVC 5

 對我來說,這樣的好處是分散了路由規則的定義.有人喜歡集中,我個人比較喜歡這種靈活的處理.因爲這個action定義好後,我不需要跑到配置那裏定義對應的路由規則

 

11.最後還是不爽的話自己寫個類實現 IRouteConstraint的匹配方法。

 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Routing;
/// <summary>
/// If the standard constraints are not sufficient for your needs, you can define your own custom constraints by implementing the IRouteConstraint interface.
/// </summary>
public class UserAgentConstraint : IRouteConstraint
{
 
    private string requiredUserAgent;
    public UserAgentConstraint(string agentParam)
    {
        requiredUserAgent = agentParam;
    }
    public bool Match(HttpContextBase httpContext, Route route, string parameterName,
    RouteValueDictionary values, RouteDirection routeDirection)
    {
        return httpContext.Request.UserAgent != null &&
        httpContext.Request.UserAgent.Contains(requiredUserAgent);
    }
}

 

1
2
3
4
5
6
7
routes.MapRoute("ChromeRoute""{*catchall}",
 
new { controller = "Home", action = "Index" },
 
new { customConstraint = new UserAgentConstraint("Chrome") },
 
new[] { "UrlsAndRoutes.AdditionalControllers" });

 比如這個就用來匹配是否是用谷歌瀏覽器訪問網頁的。

12.訪問本地文檔

 

1
2
3
routes.RouteExistingFiles = true;
 
routes.MapRoute("DiskFile""Content/StaticContent.html"new { controller = "Customer", action = "List", });

 

瀏覽網站,以開啓 IIS Express,然後點顯示所有應用程序-點擊網站名稱-配置(applicationhost.config)-搜索UrlRoutingModule節點

1
<add name="UrlRoutingModule-4.0" type="System.Web.Routing.UrlRoutingModule" preCondition="managedHandler,runtimeVersionv4.0" />

 

把這個節點裏的preCondition刪除,變成

1
<add name="UrlRoutingModule-4.0" type="System.Web.Routing.UrlRoutingModule" preCondition="" />

 

 13.直接訪問本地資源,繞過了路由系統

1
routes.IgnoreRoute("Content/{filename}.html");

 

文件名還可以用 {filename}佔位符。

IgnoreRoute方法是RouteCollection裏面StopRoutingHandler類的一個實例。路由系統通過硬-編碼識別這個Handler。如果這個規則匹配的話,後面的規則都無效了。 這也就是默認的路由裏面routes.IgnoreRoute("{resource}.axd/{*pathInfo}");寫最前面的原因。

路由測試(在測試項目的基礎上,要裝moq)

1
PM> Install-Package Moq

 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
using System;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using System.Web;
using Moq;
using System.Web.Routing;
using System.Reflection;
[TestClass]
public class RoutesTest
{
    private HttpContextBase CreateHttpContext(string targetUrl = nullstring HttpMethod = "GET")
    {
        // create the mock request
        Mock<HttpRequestBase> mockRequest = new Mock<HttpRequestBase>();
        mockRequest.Setup(m => m.AppRelativeCurrentExecutionFilePath)
        .Returns(targetUrl);
        mockRequest.Setup(m => m.HttpMethod).Returns(HttpMethod);
        // create the mock response
        Mock<HttpResponseBase> mockResponse = new Mock<HttpResponseBase>();
        mockResponse.Setup(m => m.ApplyAppPathModifier(
        It.IsAny<string>())).Returns<string>(s => s);
        // create the mock context, using the request and response
        Mock<HttpContextBase> mockContext = new Mock<HttpContextBase>();
        mockContext.Setup(m => m.Request).Returns(mockRequest.Object);
        mockContext.Setup(m => m.Response).Returns(mockResponse.Object);
        // return the mocked context
        return mockContext.Object;
    }
 
    private void TestRouteMatch(string url, string controller, string action, object routeProperties = nullstring httpMethod = "GET")
    {
        // Arrange
        RouteCollection routes = new RouteCollection();
        RouteConfig.RegisterRoutes(routes);
        // Act - process the route
        RouteData result = routes.GetRouteData(CreateHttpContext(url, httpMethod));
        // Assert
        Assert.IsNotNull(result);
        Assert.IsTrue(TestIncomingRouteResult(result, controller, action, routeProperties));
    }
 
    private bool TestIncomingRouteResult(RouteData routeResult, string controller, string action, object propertySet = null)
    {
        Func<objectobjectbool> valCompare = (v1, v2) =>
        {
            return StringComparer.InvariantCultureIgnoreCase
            .Compare(v1, v2) == 0;
        };
        bool result = valCompare(routeResult.Values["controller"], controller)
        && valCompare(routeResult.Values["action"], action);
        if (propertySet != null)
        {
            PropertyInfo[] propInfo = propertySet.GetType().GetProperties();
            foreach (PropertyInfo pi in propInfo)
            {
                if (!(routeResult.Values.ContainsKey(pi.Name)
                && valCompare(routeResult.Values[pi.Name],
                pi.GetValue(propertySet, null))))
                {
                    result = false;
                    break;
                }
            }
        }
        return result;
    }
 
    private void TestRouteFail(string url)
    {
        // Arrange
        RouteCollection routes = new RouteCollection();
        RouteConfig.RegisterRoutes(routes);
        // Act - process the route
        RouteData result = routes.GetRouteData(CreateHttpContext(url));
        // Assert
        Assert.IsTrue(result == null || result.Route == null);
    }
 
    [TestMethod]
    public void TestIncomingRoutes()
    {
        // check for the URL that we hope to receive
        TestRouteMatch("~/Admin/Index""Admin""Index");
        // check that the values are being obtained from the segments
        TestRouteMatch("~/One/Two""One""Two");
        // ensure that too many or too few segments fails to match
        TestRouteFail("~/Admin/Index/Segment");//失敗
        TestRouteFail("~/Admin");//失敗
        TestRouteMatch("~/""Home""Index");
        TestRouteMatch("~/Customer""Customer""Index");
        TestRouteMatch("~/Customer/List""Customer""List");
        TestRouteFail("~/Customer/List/All");//失敗
        TestRouteMatch("~/Customer/List/All""Customer""List"new { id = "All" });
        TestRouteMatch("~/Customer/List/All/Delete""Customer""List"new { id = "All", catchall = "Delete" });
        TestRouteMatch("~/Customer/List/All/Delete/Perm""Customer""List"new { id = "All", catchall = "Delete/Perm" });
    }
 
 
 
}

 

 

  最後還是再推薦一下Adam Freeman寫的apress.pro.asp.net.mvc.4這本書。稍微熟悉MVC的從第二部分開始讀好了。前面都是入門(對我來說是扯淡)。但總比國內某些寫書的人好吧——把個開源項目的源代碼下載下來帖到書上面來,然後標題起個深入解析XXXX,然後淨瞎扯淡。最後一千多頁的鉅著又誕生了。Adam Freeman的風格我就很喜歡,都是實例寫作,然後還在那邊書裏面專門寫了大量的測試。

  哎沒辦法啊,技術差距就是這樣了。

發佈了22 篇原創文章 · 獲贊 18 · 訪問量 10萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章