這是一個(gè)對Asp.Net Mvc的一個(gè)很小的功能拓展，小項(xiàng)目可能不太需要這個(gè)功能，但有時(shí)候項(xiàng)目大了注冊的路由不生效時(shí)你應(yīng)該要想到有可能是因?yàn)槁酚身樞虻脑颍@時(shí)這個(gè)路由優(yōu)先級的功能有可能就會(huì)給你帶來便利。

一、為什么需要路由優(yōu)先級

大家都知道我們在Asp.Net MVC項(xiàng)目或WebApi項(xiàng)目中注冊路由是沒有優(yōu)先級的，當(dāng)項(xiàng)目比較大、或有多個(gè)區(qū)域、或多個(gè)Web項(xiàng)目、或采用插件式框架開發(fā)時(shí)，我們的路由注冊很可能 不是寫在一個(gè)文件中的，而是分散在很多不同項(xiàng)目的文件中，這樣一來，路由的優(yōu)先級的問題就突顯出來了。

比如： App_Start/RouteConfig.cs中

1. routes.MapRoute(  
2. name: "Default",  
3. url: "{controller}/{action}/{id}",  
4. defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }  
5. );  
6.  
7. Areas/Admin/AdminAreaRegistration.cs中  
8.  
9. context.MapRoute(  
10. name: "Login",  
11. url: "login",  
12. defaults: new { area = "Admin", controller = "Account", action = "Login", id = UrlParameter.Optional },  
13. namespaces: new string[] { "Wenku.Admin.Controllers" }  
14. );  

假如是先注冊上面那個(gè)通用的default路由，再注冊這個(gè)login的路由，那么無論怎么樣，都會(huì)先匹配第一個(gè)滿足條件的路由，也就是第兩個(gè)路由注冊是無效的。

造成這個(gè)問題的原因就是這兩個(gè)路由注冊的順序問題，而Asp.Net MVC及WebApi中注冊路由都沒有優(yōu)先級這個(gè)概念，所以今天我們就是要自己實(shí)現(xiàn)這個(gè)想法，在注冊路由時(shí)加入一個(gè)優(yōu)先級的概念。

二、解決思路

1、先分析路由注冊的入口，比如我們新建一個(gè)mvc4.0的項(xiàng)目

1. public class MvcApplication : System.Web.HttpApplication  
2. {  
3. protected void Application_Start()  
4. {  
5. AreaRegistration.RegisterAllAreas();  
6.  
7. WebApiConfig.Register(GlobalConfiguration.Configuration);  
8. FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);  
9. RouteConfig.RegisterRoutes(RouteTable.Routes);  
10. }  
11. } 

Mvc路由的注冊入口有兩個(gè)：

注冊區(qū)域路由

a. AreaRegistration.RegisterAllAreas();

注冊項(xiàng)目路由

b. RouteConfig.RegisterRoutes(RouteTable.Routes);

WebApi路由注冊入口有一個(gè)：

WebApiConfig.Register(GlobalConfiguration.Configuration); 注冊WebApi路由

2、注冊路由的處理類分析

AreaRegistrationContext

RouteCollection

HttpRouteCollection

注冊路由時(shí)主要是由這三個(gè)類來注冊處理路由的。

3、路由優(yōu)先級方案

a、更改路由的注冊入口

b、自定義一個(gè)路由的結(jié)構(gòu)類RoutePriority及HttpRoutePriority，這兩個(gè)類下面都有Priority這個(gè)屬性

c、自定一個(gè)RegistrationContext來注冊路由，注冊的對象為上述自定義路由。

d、所有的路由注冊完成之后再按優(yōu)先順序添加到RouteCollection及HttpRouteCollection中實(shí)際生效。

三、具體實(shí)現(xiàn)

1、路由定義

1. public class RoutePriority : Route  
2. {  
3. public string Name { get; set; }  
4. public int Priority { get; set; }  
5.  
6. public RoutePriority(string url, IRouteHandler routeHandler)  
7. : base(url,routeHandler)  
8. {  
9.  
10. }  
11. }  
12.  
13. public class HttpRoutePriority  
14. {  
15. public string Name { get; set; }  
16. public int Priority { get; set; }  
17. public string RouteTemplate{get;set;}  
18. public object Defaults{get;set;}  
19. public object Constraints{get;set;}  
20. public HttpMessageHandler Handler{get;set;}  
21. }  

2、定義路由注冊的接口

1. public interface IRouteRegister  
2. {  
3. void Register(RegistrationContext context);  
4. } 

3、定義路由注冊上下文類

1. public class RegistrationContext  
2. {  
3. #region mvc  
4. public List<RoutePriority> Routes = new List<RoutePriority>();  
5.  
6. public RoutePriority MapRoute(string name, string url,int priority=0)  
7. {  
8. return MapRoute(name, url, (object)null /* defaults */, priority);  
9. }  
10.  
11. public RoutePriority MapRoute(string name, string url, object defaults, int priority = 0)  
12. {  
13. return MapRoute(name, url, defaults, (object)null /* constraints */, priority);  
14. }  
15.  
16. public RoutePriority MapRoute(string name, string url, object defaults, object constraints, int priority = 0)  
17. {  
18. return MapRoute(name, url, defaults, constraints, null /* namespaces */, priority);  
19. }  
20.  
21. public RoutePriority MapRoute(string name, string url, string[] namespaces, int priority = 0)  
22. {  
23. return MapRoute(name, url, (object)null /* defaults */, namespaces, priority);  
24. }  
25.  
26. public RoutePriority MapRoute(string name, string url, object defaults, string[] namespaces,int priority=0)  
27. {  
28. return MapRoute(name, url, defaults, null /* constraints */, namespaces, priority);  
29. }  
30.  
31. public RoutePriority MapRoute(string name, string url, object defaults, object constraints, string[] namespaces, int priority = 0)  
32. {  
33. var route = MapPriorityRoute(name, url, defaults, constraints, namespaces, priority);  
34. var areaName = GetAreaName(defaults);  
35. route.DataTokens["area"] = areaName;  
36.  
37. // disabling the namespace lookup fallback mechanism keeps this areas from accidentally picking up  
38. // controllers belonging to other areas  
39. bool useNamespaceFallback = (namespaces == null || namespaces.Length == 0);  
40. route.DataTokens["UseNamespaceFallback"] = useNamespaceFallback;  
41.  
42. return route;  
43. }  
44.  
45. private static string GetAreaName(object defaults)  
46. {  
47. if (defaults != null)  
48. {  
49. var property = defaults.GetType().GetProperty("area");  
50. if (property != null)  
51. return (string)property.GetValue(defaults, null);  
52. }  
53.  
54. return null;  
55. }  
56.  
57. private RoutePriority MapPriorityRoute(string name, string url, object defaults, object constraints, string[] namespaces,int priority)  
58. {  
59. if (url == null)  
60. {  
61. throw new ArgumentNullException("url");  
62. }  
63.  
64. var route = new RoutePriority(url, new MvcRouteHandler())  
65. {  
66. Name = name,  
67. Priority = priority,  
68. Defaults = CreateRouteValueDictionary(defaults),  
69. Constraints = CreateRouteValueDictionary(constraints),  
70. DataTokens = new RouteValueDictionary()  
71. };  
72.  
73. if ((namespaces != null) && (namespaces.Length > 0))  
74. {  
75. route.DataTokens["Namespaces"] = namespaces;  
76. }  
77.  
78. Routes.Add(route);  
79. return route;  
80. }  
81.  
82. private static RouteValueDictionary CreateRouteValueDictionary(object values)  
83. {  
84. var dictionary = values as IDictionary<string, object>;  
85. if (dictionary != null)  
86. {  
87. return new RouteValueDictionary(dictionary);  
88. }  
89.  
90. return new RouteValueDictionary(values);  
91. }  
92. #endregion  
93.  
94. #region http  
95. public List<HttpRoutePriority> HttpRoutes = new List<HttpRoutePriority>();  
96.  
97. public HttpRoutePriority MapHttpRoute(string name, string routeTemplate, int priority = 0)  
98. {  
99. return MapHttpRoute(name, routeTemplate, defaults: null, constraints: null, handler: null, priority: priority);  
100. }  
101.  
102. public HttpRoutePriority MapHttpRoute(string name, string routeTemplate, object defaults, int priority = 0)  
103. {  
104. return MapHttpRoute(name, routeTemplate, defaults, constraints: null, handler: null, priority: priority);  
105. }  
106.  
107. public HttpRoutePriority MapHttpRoute(string name, string routeTemplate, object defaults, object constraints, int priority = 0)  
108. {  
109. return MapHttpRoute(name, routeTemplate, defaults, constraints, handler: null, priority: priority);  
110. }  
111.  
112. public HttpRoutePriority MapHttpRoute(string name, string routeTemplate, object defaults, object constraints, HttpMessageHandler handler, int priority = 0)  
113. {  
114. var httpRoute = new HttpRoutePriority();  
115. httpRoute.Name = name;  
116. httpRoute.RouteTemplate = routeTemplate;  
117. httpRoute.Defaults = defaults;  
118. httpRoute.Constraints = constraints;  
119. httpRoute.Handler = handler;  
120. httpRoute.Priority = priority;  
121. HttpRoutes.Add(httpRoute);  
122.  
123. return httpRoute;  
124. }  
125. #endregion  
126. }  

4、把路由注冊處理方法添加到Configuration類中

1. public static Configuration RegisterRoutePriority(this Configuration config)  
2. {  
3. var typesSoFar = new List<Type>();  
4. var assemblies = GetReferencedAssemblies();  
5. foreach (Assembly assembly in assemblies)  
6. {  
7. var types = assembly.GetTypes().Where(t => typeof(IRouteRegister).IsAssignableFrom(t) && !t.IsAbstract && !t.IsInterface);  
8. typesSoFar.AddRange(types);  
9. }  
10.  
11. var context = new RegistrationContext();  
12. foreach (var type in typesSoFar)  
13. {  
14. var obj = (IRouteRegister)Activator.CreateInstance(type);  
15. obj.Register(context);  
16. }  
17.  
18. foreach (var route in context.HttpRoutes.OrderByDescending(x => x.Priority))  
19. GlobalConfiguration.Configuration.Routes.MapHttpRoute(route.Name, route.RouteTemplate, route.Defaults, route.Constraints, route.Handler);  
20.  
21. foreach (var route in context.Routes.OrderByDescending(x => x.Priority))  
22. RouteTable.Routes.Add(route.Name, route);  
23.  
24. return config;  
25. }  
26.  
27. private static IEnumerable<Assembly> GetReferencedAssemblies()  
28. {  
29. var assemblies = BuildManager.GetReferencedAssemblies();  
30. foreach (Assembly assembly in assemblies)  
31. yield return assembly;  
32. }  
33. 這樣一來就大功告成，使用時(shí)只需要在Global.asax.cs文件中修改原注冊入口為 
34.  
35. public class MvcApplication : System.Web.HttpApplication  
36. {  
37. protected void Application_Start()  
38. {  
39. WebApiConfig.Register(GlobalConfiguration.Configuration);  
40. FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);  
41. RouteConfig.RegisterRoutes(RouteTable.Routes);  
42.  
43. Configuration.Instance()  
44. .RegisterComponents()  
45. .RegisterRoutePriority(); //注冊自定義路由  
46. }  
47. }  
48. 在每個(gè)項(xiàng)目中使用只需要要繼承自定義路由注冊接口IRouteRegister，例如： 
49.  
50. public class Registration : IRouteRegister  
51. {  
52. public void Register(RegistrationContext context)  
53. {  
54. //注冊后端管理登錄路由  
55. context.MapRoute(  
56. name: "Admin_Login",  
57. url: "Admin/login",  
58. defaults: new { area = "Admin", controller = "Account", action = "Login", id = UrlParameter.Optional },  
59. namespaces: new string[] { "Wenku.Admin.Controllers" },  
60. priority: 11  
61. );  
62.  
63. //注冊后端管理頁面默認(rèn)路由  
64. context.MapRoute(  
65. name: "Admin_default",  
66. url: "Admin/{controller}/{action}/{id}",  
67. defaults: new { area = "Admin", controller = "Home", action = "Index", id = UrlParameter.Optional },  
68. namespaces: new string[] { "Wenku.Admin.Controllers" },  
69. priority: 10  
70. );  
71.  
72. //注冊手機(jī)訪問WebApi路由  
73. context.MapHttpRoute(  
74. name: "Mobile_Api",  
75. routeTemplate: "api/mobile/{controller}/{action}/{id}",  
76. defaults: new 
77. {  
78. area = "mobile",  
79. action = RouteParameter.Optional,  
80. id = RouteParameter.Optional,  
81. namespaceName = new string[] { "Wenku.Mobile.Http" }  
82. },  
83. constraints: new { action = new StartWithConstraint() },  
84. priority: 0  
85. );  
86. }  
87. }  

四、總結(jié)

當(dāng)遇到大項(xiàng)目注冊的路由不生效時(shí)你應(yīng)該要想到有可能是因?yàn)槁酚身樞虻脑颍陨暇褪潜疚牡娜績?nèi)容，希望對大家的學(xué)習(xí)有所啟發(fā)。