程序博客网 > 淘宝评价怎么取消隐藏

给ASP.NET MVC及WebApi添加路由优先级

来源：互联网 发布：淘宝评价怎么取消隐藏 编辑：程序博客网 时间：2024/05/27 01:10

这是一个对Asp.Net Mvc的一个很小的功能拓展，小项目可能不太需要这个功能，但有时候项目大了注册的路由不生效时你应该要想到有可能是因为路由顺序的原因，这时这个路由优先级的功能有可能就会给你带来便利。


一、为什么需要路由优先级

大家都知道我们在Asp.Net MVC项目或WebApi项目中注册路由是没有优先级的，当项目比较大、或有多个区域、或多个Web项目、或采用插件式框架开发时，我们的路由注册很可能 不是写在一个文件中的，而是分散在很多不同项目的文件中，这样一来，路由的优先级的问题就突显出来了。

比如： 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. ); 

假如是武汉电脑维修先注册上面那个通用的default路由，再注册这个login的路由，那么无论怎么样，都会先匹配第一个满足条件的路由，也就是第两个路由注册是无效的。
造成这个问题的原因就是这两个路由注册的顺序问题，而Asp.Net MVC及WebApi中注册路由都没有优先级这个概念，所以今天我们就是要自己实现这个想法，在注册路由时加入一个优先级的概念。

二、解决思路

1、先分析路由注册的入口，比如我们新建一个mvc4.0的项目

 
  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路由的注册入口有两个：
a. AreaRegistration.RegisterAllAreas();                            注册区域路由
b. RouteConfig.RegisterRoutes(RouteTable.Routes);          注册项目路由

WebApi路由注册入口有一个：
WebApiConfig.Register(GlobalConfiguration.Configuration);  注册WebApi路由

2、注册路由的处理类分析

AreaRegistrationContext
RouteCollection
HttpRouteCollection

注册路由时主要是由这三个类来注册处理路由的。

3、路由优先级方案

a、更改路由的注册入口
b、自定义一个路由的结构类RoutePriority及HttpRoutePriority，这两个类下面都有Priority这个属性
c、自定一个RegistrationContext来注册路由，注册的对象为上述自定义路由。
d、所有的路由注册完成之后再按优先顺序添加到RouteCollection及HttpRouteCollection中实际生效。

三、具体实现

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. } 

这样一来就大功告成，使用时只需要在Global.asax.cs文件中修改原注册入口为

  1. public class MvcApplication : System.Web.HttpApplication 
  2. { 
  3.     protected void Application_Start() 
  4.     { 
  5.         WebApiConfig.Register(GlobalConfiguration.Configuration); 
  6.         FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters); 
  7.         RouteConfig.RegisterRoutes(RouteTable.Routes); 
  8.  
  9.         Configuration.Instance() 
  10.             .RegisterComponents() 
  11.             .RegisterRoutePriority(); //注册自定义路由 
  12.     } 
  13. } 

在每个项目中使用只需要要继承自定义路由注册接口IRouteRegister，例如：

  1. public class Registration : IRouteRegister 
  2. { 
  3.     public void Register(RegistrationContext context) 
  4.     { 
  5.        //注册后端管理登录路由 
  6.         context.MapRoute( 
  7.           name: "Admin_Login", 
  8.           url: "Admin/login", 
  9.           defaults: new { area = "Admin", controller = "Account", action = "Login", id = UrlParameter.Optional }, 
  10.           namespaces: new string[] { "Wenku.Admin.Controllers" }, 
  11.           priority: 11 
  12.       ); 
  13.  
  14.        //注册后端管理页面默认路由 
  15.         context.MapRoute( 
  16.             name: "Admin_default", 
  17.             url: "Admin/{controller}/{action}/{id}", 
  18.             defaults: new { area = "Admin", controller = "Home", action = "Index", id = UrlParameter.Optional }, 
  19.             namespaces: new string[] { "Wenku.Admin.Controllers" }, 
  20.             priority: 10 
  21.         ); 
  22.  
  23.        //注册手机访问WebApi路由 
  24.         context.MapHttpRoute( 
  25.             name: "Mobile_Api", 
  26.             routeTemplate: "api/mobile/{controller}/{action}/{id}", 
  27.             defaults: new 
  28.             { 
  29.                 area = "mobile", 
  30.                 action = RouteParameter.Optional, 
  31.                 id = RouteParameter.Optional, 
  32.                 namespaceName = new string[] { "Wenku.Mobile.Http" } 
  33.             }, 
  34.             constraints: new { action = new StartWithConstraint() }, 
  35.             priority: 0 
  36.         ); 
  37.     } 
  38. } 

四、总结

这是一个对Asp.Net Mvc的一个很小的功能拓展，小项目可能不太需要这个功能，但有时候项目大了注册的路由不生效时你应该要想到有可能是因为路由顺序的原因，这时这个路由优先级的功能有可能就会给你带来便利。总之共享给有需要的朋友们参考。


0 0
淘宝评价怎么取消隐藏 淘宝评价怎么取消隐藏
原创粉丝点击
热门IT博客
信息门户源码信息门户源码
淘宝客户申请假冒品牌淘宝客户申请假冒品牌
java ee8安装
python remove delete
ubuntu 12.04 samba
设计彩印淘宝推荐
软件评测师是什么
淘宝网上药店哪家正规
深圳咫尺网络怎么样
矩阵计算 第四版pdf
python talib macdfix
淘宝买家怎么快速升3心
java web技术架构图
js对象如何获取属性
理财软件排行
天津广电网络 数字电视
兼职网站 知乎
pkpm计价软件
java random 0-9
西北大学数据科学
热门问题 老师的惩罚 人脸识别 我在镇武司摸鱼那些年 重生之率土为王 我在大康的咸鱼生活 盘龙之生命进化 天生仙种 凡人之先天五行 春回大明朝 姑娘不必设防，我是瞎子 微信版本过低怎么办 报关时通关单号没录怎么办 公司注销了行政许可证怎么办呢 报关项数超过50项怎么办 出口报关件数报多了怎么办 关税少交被海关缉私查到怎么办 外贸报关hs编码报错怎么办 报关金额少报了怎么办 进口报关金额少报了怎么办 报关重量报少了怎么办 金额报多100倍怎么办 ems没扫描到单号怎么办 回国海关被税了怎么办 代购买错东西了怎么办 征信报告有逾期怎么办 evus信息填错了怎么办 清关一个月了该怎么办 清关一直不发怎么办 清关一个月了怎么办 香港ems到西安海关税怎么办 寄东西被海关扣留怎么办 天津港新舱单品名错误核销怎么办 移动手机不能用联通卡怎么办 移动手机联通卡网速卡怎么办 移动手机不支持联通4g怎么办 汽车分离轴承异响怎么办 至尊宝被冻结了怎么办 qq冻结了至尊宝怎么办 至尊宝没办法申诉怎么办 至尊宝qq被冻结怎么办 未满16岁怎么办手机卡 联想预装的office卸载怎么办 win10激活后无法启动怎么办 移动电话卡没用了没注销怎么办 快捷快递客服热线一直打不通怎么办 牛奶乳加钙咀嚼片吃多了怎么办 三生骗了我该怎么办 国珍产品新时代卡怎么办 三个月大的宝宝对眼怎么办 9月大婴儿眼睛对眼怎么办 30岁眼部有皱纹怎么办

程序博客网，程序员的互联网技术博客家园。csdn论坛精品 msdn技术资料都在这里