一、為什么需要路由優(yōu)先級(jí)
大家都知道我們?cè)贏sp.Net MVC項(xiàng)目或WebApi項(xiàng)目中注冊(cè)路由是沒(méi)有優(yōu)先級(jí)的，當(dāng)項(xiàng)目比較大、或有多個(gè)區(qū)域、或多個(gè)Web項(xiàng)目、或采用插件式框架開(kāi)發(fā)時(shí)，我們的路由注冊(cè)很可能 不是寫在一個(gè)文件中的，而是分散在很多不同項(xiàng)目的文件中，這樣一來(lái)，路由的優(yōu)先級(jí)的問(wèn)題就突顯出來(lái)了。
比如： 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" }
);
假如是先注冊(cè)上面那個(gè)通用的default路由，再注冊(cè)這個(gè)login的路由，那么無(wú)論怎么樣，都會(huì)先匹配第一個(gè)滿足條件的路由，也就是第兩個(gè)路由注冊(cè)是無(wú)效的。
造成這個(gè)問(wèn)題的原因就是這兩個(gè)路由注冊(cè)的順序問(wèn)題，而Asp.Net MVC及WebApi中注冊(cè)路由都沒(méi)有優(yōu)先級(jí)這個(gè)概念，所以今天我們就是要自己實(shí)現(xiàn)這個(gè)想法，在注冊(cè)路由時(shí)加入一個(gè)優(yōu)先級(jí)的概念。
二、解決思路
1、先分析路由注冊(cè)的入口，比如我們新建一個(gè)mvc4.0的項(xiàng)目
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路由的注冊(cè)入口有兩個(gè)：
a. AreaRegistration.RegisterAllAreas(); 注冊(cè)區(qū)域路由
b. RouteConfig.RegisterRoutes(RouteTable.Routes); 注冊(cè)項(xiàng)目路由
WebApi路由注冊(cè)入口有一個(gè)：
WebApiConfig.Register(GlobalConfiguration.Configuration); 注冊(cè)WebApi路由
2、注冊(cè)路由的處理類分析
AreaRegistrationContext
RouteCollection
HttpRouteCollection
注冊(cè)路由時(shí)主要是由這三個(gè)類來(lái)注冊(cè)處理路由的。
3、路由優(yōu)先級(jí)方案
a、更改路由的注冊(cè)入口
b、自定義一個(gè)路由的結(jié)構(gòu)類RoutePriority及HttpRoutePriority，這兩個(gè)類下面都有Priority這個(gè)屬性
c、自定一個(gè)RegistrationContext來(lái)注冊(cè)路由，注冊(cè)的對(duì)象為上述自定義路由。
d、所有的路由注冊(cè)完成之后再按優(yōu)先順序添加到RouteCollection及HttpRouteCollection中實(shí)際生效。
三、具體實(shí)現(xiàn)
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、定義路由注冊(cè)的接口
public interface IRouteRegister
{
void Register(RegistrationContext context);
}
3、定義路由注冊(cè)上下文類
public class RegistrationContext
{
#region mvc
public ListRoutePriority> Routes = new ListRoutePriority>();
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 IDictionarystring, object>;
if (dictionary != null)
{
return new RouteValueDictionary(dictionary);
}
return new RouteValueDictionary(values);
}
#endregion
#region http
public ListHttpRoutePriority> HttpRoutes = new ListHttpRoutePriority>();
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、把路由注冊(cè)處理方法添加到Configuration類中
public static Configuration RegisterRoutePriority(this Configuration config)
{
var typesSoFar = new ListType>();
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 IEnumerableAssembly> GetReferencedAssemblies()
{
var assemblies = BuildManager.GetReferencedAssemblies();
foreach (Assembly assembly in assemblies)
yield return assembly;
}
這樣一來(lái)就大功告成，使用時(shí)只需要在Global.asax.cs文件中修改原注冊(cè)入口為
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(); //注冊(cè)自定義路由
}
}
在每個(gè)項(xiàng)目中使用只需要要繼承自定義路由注冊(cè)接口IRouteRegister，例如：
public class Registration : IRouteRegister
{
public void Register(RegistrationContext context)
{
//注冊(cè)后端管理登錄路由
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
);
//注冊(cè)后端管理頁(yè)面默認(rèn)路由
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
);
//注冊(cè)手機(jī)訪問(wèn)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
);
}
}
四、總結(jié)
當(dāng)遇到大項(xiàng)目注冊(cè)的路由不生效時(shí)你應(yīng)該要想到有可能是因?yàn)槁酚身樞虻脑颍陨暇褪潜疚牡娜績(jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所啟發(fā)。
您可能感興趣的文章:- ASP.net WebAPI 上傳圖片實(shí)例
- Asp.net core WebApi 使用Swagger生成幫助頁(yè)實(shí)例
- ASP.NET Core 2.0 WebApi全局配置及日志實(shí)例
- ASP.NET WebAPi（selfhost）實(shí)現(xiàn)文件同步或異步上傳
- 淺談ASP.Net Core WebApi幾種版本控制對(duì)比
- 在CentOS6.5上使用Jexus安裝部署ASP.NET MVC4和WebApi
- asp.net core 2.0 webapi集成signalr(實(shí)例講解)
- ASP.Net WebAPI與Ajax進(jìn)行跨域數(shù)據(jù)交互時(shí)Cookies數(shù)據(jù)的傳遞
- asp.net mvc webapi 實(shí)用的接口加密方法示例
- .net webapi接收xml格式數(shù)據(jù)的3種情況小結(jié)
