为ASP.NET MVC及WebApi添加路由优先级
一、为什么需要路由优先级
大家都知道我们在Asp.Net MVC项目或WebApi项目中注册路由是没有优先级的,当项目比较大、或有多个区域、或多个Web项目、或采用插件式框架开发时,我们的路由注册很可能 不是写在一个文件中的,而是分散在很多不同项目的文件中,这样一来,路由的优先级的问题就突显出来了。
比如: App_Start/RouteConfig.cs中
routes.MapRoute( name: "Default", url: "{controller}/{action}/{id}", defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional } ); Areas/Admin/AdminAreaRegistration.cs中 context.MapRoute( name: "Login", url: "login", defaults: new { area = "Admin", controller = "Account", action = "Login", id = UrlParameter.Optional }, namespaces: new string[] { "Wenku.Admin.Controllers" } );
假如是先注册上面那个通用的default路由,再注册这个login的路由,那么无论怎么样,都会先匹配第一个满足条件的路由,也就是第两个路由注册是无效的。
造成这个问题的原因就是这两个路由注册的顺序问题,而Asp.Net MVC及WebApi中注册路由都没有优先级这个概念,所以今天我们就是要自己实现这个想法,在注册路由时加入一个优先级的概念。
二、解决思路
1、先分析路由注册的入口,比如我们新建一个mvc4.0的项目
public class MvcApplication : System.Web.HttpApplication { protected void Application_Start() { AreaRegistration.RegisterAllAreas(); WebApiConfig.Register(GlobalConfiguration.Configuration); FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters); RouteConfig.RegisterRoutes(RouteTable.Routes); } }
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、路由定义
public class RoutePriority : Route { public string Name { get; set; } public int Priority { get; set; } public RoutePriority(string url, IRouteHandler routeHandler) : base(url,routeHandler) { } } public class HttpRoutePriority { public string Name { get; set; } public int Priority { get; set; } public string RouteTemplate{get;set;} public object Defaults{get;set;} public object Constraints{get;set;} public HttpMessageHandler Handler{get;set;} }
2、定义路由注册的接口
public interface IRouteRegister { void Register(RegistrationContext context); }
3、定义路由注册上下文类
public class RegistrationContext { #region mvc public List<RoutePriority> Routes = new List<RoutePriority>(); public RoutePriority MapRoute(string name, string url,int priority=0) { return MapRoute(name, url, (object)null /* defaults */, priority); } public RoutePriority MapRoute(string name, string url, object defaults, int priority = 0) { return MapRoute(name, url, defaults, (object)null /* constraints */, priority); } public RoutePriority MapRoute(string name, string url, object defaults, object constraints, int priority = 0) { return MapRoute(name, url, defaults, constraints, null /* namespaces */, priority); } public RoutePriority MapRoute(string name, string url, string[] namespaces, int priority = 0) { return MapRoute(name, url, (object)null /* defaults */, namespaces, priority); } public RoutePriority MapRoute(string name, string url, object defaults, string[] namespaces,int priority=0) { return MapRoute(name, url, defaults, null /* constraints */, namespaces, priority); } public RoutePriority MapRoute(string name, string url, object defaults, object constraints, string[] namespaces, int priority = 0) { var route = MapPriorityRoute(name, url, defaults, constraints, namespaces, priority); var areaName = GetAreaName(defaults); route.DataTokens["area"] = areaName; // disabling the namespace lookup fallback mechanism keeps this areas from accidentally picking up // controllers belonging to other areas bool useNamespaceFallback = (namespaces == null || namespaces.Length == 0); route.DataTokens["UseNamespaceFallback"] = useNamespaceFallback; return route; } private static string GetAreaName(object defaults) { if (defaults != null) { var property = defaults.GetType().GetProperty("area"); if (property != null) return (string)property.GetValue(defaults, null); } return null; } private RoutePriority MapPriorityRoute(string name, string url, object defaults, object constraints, string[] namespaces,int priority) { if (url == null) { throw new ArgumentNullException("url"); } var route = new RoutePriority(url, new MvcRouteHandler()) { Name = name, Priority = priority, Defaults = CreateRouteValueDictionary(defaults), Constraints = CreateRouteValueDictionary(constraints), DataTokens = new RouteValueDictionary() }; if ((namespaces != null) && (namespaces.Length > 0)) { route.DataTokens["Namespaces"] = namespaces; } Routes.Add(route); return route; } private static RouteValueDictionary CreateRouteValueDictionary(object values) { var dictionary = values as IDictionary<string, object>; if (dictionary != null) { return new RouteValueDictionary(dictionary); } return new RouteValueDictionary(values); } #endregion #region http public List<HttpRoutePriority> HttpRoutes = new List<HttpRoutePriority>(); public HttpRoutePriority MapHttpRoute(string name, string routeTemplate, int priority = 0) { return MapHttpRoute(name, routeTemplate, defaults: null, constraints: null, handler: null, priority: priority); } public HttpRoutePriority MapHttpRoute(string name, string routeTemplate, object defaults, int priority = 0) { return MapHttpRoute(name, routeTemplate, defaults, constraints: null, handler: null, priority: priority); } public HttpRoutePriority MapHttpRoute(string name, string routeTemplate, object defaults, object constraints, int priority = 0) { return MapHttpRoute(name, routeTemplate, defaults, constraints, handler: null, priority: priority); } public HttpRoutePriority MapHttpRoute(string name, string routeTemplate, object defaults, object constraints, HttpMessageHandler handler, int priority = 0) { var httpRoute = new HttpRoutePriority(); httpRoute.Name = name; httpRoute.RouteTemplate = routeTemplate; httpRoute.Defaults = defaults; httpRoute.Constraints = constraints; httpRoute.Handler = handler; httpRoute.Priority = priority; HttpRoutes.Add(httpRoute); return httpRoute; } #endregion }
4、把路由注册处理方法添加到Configuration类中
public static Configuration RegisterRoutePriority(this Configuration config) { var typesSoFar = new List<Type>(); var assemblies = GetReferencedAssemblies(); foreach (Assembly assembly in assemblies) { var types = assembly.GetTypes().Where(t => typeof(IRouteRegister).IsAssignableFrom(t) && !t.IsAbstract && !t.IsInterface); typesSoFar.AddRange(types); } var context = new RegistrationContext(); foreach (var type in typesSoFar) { var obj = (IRouteRegister)Activator.CreateInstance(type); obj.Register(context); } foreach (var route in context.HttpRoutes.OrderByDescending(x => x.Priority)) GlobalConfiguration.Configuration.Routes.MapHttpRoute(route.Name, route.RouteTemplate, route.Defaults, route.Constraints, route.Handler); foreach (var route in context.Routes.OrderByDescending(x => x.Priority)) RouteTable.Routes.Add(route.Name, route); return config; } private static IEnumerable<Assembly> GetReferencedAssemblies() { var assemblies = BuildManager.GetReferencedAssemblies(); foreach (Assembly assembly in assemblies) yield return assembly; } 这样一来就大功告成,使用时只需要在Global.asax.cs文件中修改原注册入口为 public class MvcApplication : System.Web.HttpApplication { protected void Application_Start() { WebApiConfig.Register(GlobalConfiguration.Configuration); FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters); RouteConfig.RegisterRoutes(RouteTable.Routes); Configuration.Instance() .RegisterComponents() .RegisterRoutePriority(); //注册自定义路由 } } 在每个项目中使用只需要要继承自定义路由注册接口IRouteRegister,例如: public class Registration : IRouteRegister { public void Register(RegistrationContext context) { //注册后端管理登录路由 context.MapRoute( name: "Admin_Login", url: "Admin/login", defaults: new { area = "Admin", controller = "Account", action = "Login", id = UrlParameter.Optional }, namespaces: new string[] { "Wenku.Admin.Controllers" }, priority: 11 ); //注册后端管理页面默认路由 context.MapRoute( name: "Admin_default", url: "Admin/{controller}/{action}/{id}", defaults: new { area = "Admin", controller = "Home", action = "Index", id = UrlParameter.Optional }, namespaces: new string[] { "Wenku.Admin.Controllers" }, priority: 10 ); //注册手机访问WebApi路由 context.MapHttpRoute( name: "Mobile_Api", routeTemplate: "api/mobile/{controller}/{action}/{id}", defaults: new { area = "mobile", action = RouteParameter.Optional, id = RouteParameter.Optional, namespaceName = new string[] { "Wenku.Mobile.Http" } }, constraints: new { action = new StartWithConstraint() }, priority: 0 ); } }
四、总结
当遇到大项目注册的路由不生效时你应该要想到有可能是因为路由顺序的原因,以上就是本文的全部内容,希望对大家的学习有所启发。
相关文章
- 这篇文章主要为大家详细介绍了ASP.NET购物车的实现过程,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2021-09-22
- 在开发过程中,使用Visual Studio的断点调试功能可以很方便帮我们调试发现程序存在的错误,同样Visual Studio也支持对SQL Server里面的存储过程进行调试,下面就让我们看看具体的调试方法。...2021-09-22
ASP.NET Core根据环境变量支持多个 appsettings.json配置文件
这篇文章主要介绍了ASP.NET Core根据环境变量支持多个 appsettings.json配置文件,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-09-22- 这篇文章主要介绍了记一次EFCore类型转换错误及解决方案,帮助大家更好的理解和学习使用asp.net core,感兴趣的朋友可以了解下...2021-09-22
- 这篇文章主要介绍了SpringMVC文件上传原理及实现过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-07-15
C# MVC模式中应该怎样区分应用程序逻辑(Controller层)和业务逻辑(Model层)?
这篇文章主要介绍了C# MVC模式中应该怎样区分应用程序逻辑(Controller层)和业务逻辑(Model层)?,这也小编做.NET项目时经常思考和让人混乱的一个问题,这篇文章写的挺好,一下清晰了许多,需要的朋友可以参考下...2020-06-25详解ASP.NET Core 中基于工厂的中间件激活的实现方法
这篇文章主要介绍了ASP.NET Core 中基于工厂的中间件激活的实现方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2021-09-22使用Maven 搭建 Spring MVC 本地部署Tomcat的详细教程
这篇文章主要介绍了使用Maven 搭建 Spring MVC 本地部署Tomcat,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2021-08-16asp.net通过消息队列处理高并发请求(以抢小米手机为例)
这篇文章主要介绍了asp.net通过消息队列处理高并发请求(以抢小米手机为例),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-09-22ASP.NET单选按钮控件RadioButton常用属性和方法介绍
RadioButton又称单选按钮,其在工具箱中的图标为 ,单选按钮通常成组出现,用于提供两个或多个互斥选项,即在一组单选钮中只能选择一个...2021-09-22- 这篇文章主要介绍了SpringMvc自动装箱及GET请求参数原理解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-09-19
- 这篇文章主要介绍了SpringMvc获取请求头请求体消息过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-09-17
ASP.NET 2.0中的数据操作:使用两个DropDownList过滤的主/从报表
在前面的指南中我们研究了如何显示一个简单的主/从报表, 该报表使用DropDownList和GridView控件, DropDownList填充类别,GridView显示选定类别的产品. 这类报表用于显示具有...2016-05-19Springmvc ResponseBody响应json数据实现过程
这篇文章主要介绍了Springmvc ResponseBody响应json数据实现过程,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-10-26ASP.NET中iframe框架点击左边页面链接 右边显示链接页面内容
这篇文章主要介绍了ASP.NET中iframe框架点击左边页面链接,右边显示链接页面内容的实现代码,感兴趣的小伙伴们可以参考一下...2021-09-22- 本篇文章介绍了,基于C#后台调用跨域MVC服务及带Cookie验证的实现。需要的朋友参考下...2020-06-25
- ASP.NET Web API具有与ASP.NET MVC类似的编程方式,ASP.NET Web API不仅仅具有一个完全独立的消息处理管道,而且这个管道比为ASP.NET MVC设计的管道更为复杂,功能也更为强大。下面创建一个简单的Web API项目,需要的朋友可以参考下...2021-09-22
- 这篇文章主要为大家介绍了javascript中的MVC模式,MVC是一种软件架构模式,一般把软件模式分为三部分,本文就针对MVC模式的三部分进行讲解,感兴趣的小伙伴们可以参考一下...2016-02-01
- Spring MVC是Spring系列框架中使用频率最高的部分。不管是Spring Boot还是传统的Spring项目,只要是Web项目都会使用到Spring MVC部分。因此程序员一定要熟练掌握MVC部分。本篇博客简要分析Spring MVC处理一个请求的流程。...2021-02-06
- 这篇文章主要介绍了c# webapi 配置swagger的方法,文中示例代码非常详细,帮助大家更好的理解和学习,感兴趣的朋友可以了解下...2020-07-09