您好,登錄后才能下訂單哦!
小編給大家分享一下基于Lamda表達(dá)式的強(qiáng)類(lèi)型Routing實(shí)現(xiàn)的示例分析,希望大家閱讀完這篇文章之后都有所收獲,下面讓我們一起去探討吧!
這種方式的基本使用示例如下:
services.Configure<MvcOptions>(opt => { opt.EnableTypedRouting(); opt.GetRoute("homepage", c => c.Action<ProductsController>(x => x.Index())); opt.GetRoute("aboutpage/{name}", c => c.Action<ProductsController>(x => x.About(Param<string>.Any))); opt.PostRoute("sendcontact", c => c.Action<ProductsController>(x => x.Contact())); });
從示例中可以看出,我們可以通過(guò)GetRoute或PostRoute等擴(kuò)展方法來(lái)定義route,而且后面使用Lambda表達(dá)式來(lái)定Controller的類(lèi)型和Action的方法。
注意,在這里獲取Action的方法名,是通過(guò)委托執(zhí)行該Action方法來(lái)實(shí)現(xiàn)的(實(shí)際上并沒(méi)有執(zhí)行,而是基于此獲取該Action的MethodInfo)。
實(shí)現(xiàn)原理
在Stratup.cs
的ConfigureServices
方法中配置services的時(shí)候,我們可以對(duì)MVC站點(diǎn)使用的核心配置文件MvcOptions
進(jìn)行配置,其中該類(lèi)有一個(gè)ApplicationModelConventions
屬性(List<IApplicationModelConvention
>)可以保存一個(gè)IApplicationModelConvention
接口的集合,改接口可以對(duì)MVC程序的程序模型進(jìn)行管線處理,該接口的定義如下:
public interface IApplicationModelConvention { void Apply(ApplicationModel application); }
接口中的Apply
方法所接收的參數(shù)類(lèi)型是ApplicationModel
,而ApplicationModel
有兩個(gè)極其重要的內(nèi)容可以供我們操作,一個(gè)是Controller模型集合,一個(gè)是各種Filter的集合,該類(lèi)的定義如下:
public class ApplicationModel { public ApplicationModel(); public IList<ControllerModel> Controllers { get; } public IList<IFilter> Filters { get; } }
這里最重要的就是ControllerModel
類(lèi),該類(lèi)的實(shí)例上保存了各種各樣重要而又可以操作的信息,比如該類(lèi)和相關(guān)Action上的路由定義數(shù)據(jù),API描述信息,路由約束等等,這些信息都可以進(jìn)行操作。
新的IApplicationModelConvention注冊(cè)方式如下:
services.Configure<MvcOptions>(opt => { opts.ApplicationModelConventions.Add(new MyApplicationModelConvention()); });
所以我們可以利用這個(gè)方法,在合適的時(shí)機(jī)對(duì)整個(gè)MVC的程序模型做響應(yīng)的調(diào)整和修改,本章節(jié)中的強(qiáng)類(lèi)型路由就是利用這個(gè)特性來(lái)實(shí)現(xiàn)的。
實(shí)現(xiàn)步驟
首先定義一個(gè)強(qiáng)類(lèi)型的路由模型TypedRouteModel
類(lèi),該類(lèi)要繼承于AttributeRouteModel
,AttributeRouteModel
類(lèi)是基于Attribute路由的基本模型,TypedRouteModel
類(lèi)的代碼如下:
public class TypedRouteModel : AttributeRouteModel { public TypedRouteModel(string template) { Template = template; HttpMethods = new string[0]; } public TypeInfo ControllerType { get; private set; } public MethodInfo ActionMember { get; private set; } public IEnumerable<string> HttpMethods { get; private set; } public TypedRouteModel Controller<TController>() { ControllerType = typeof(TController).GetTypeInfo(); return this; } public TypedRouteModel Action<T, U>(Expression<Func<T, U>> expression) { ActionMember = GetMethodInfoInternal(expression); ControllerType = ActionMember.DeclaringType.GetTypeInfo(); return this; } public TypedRouteModel Action<T>(Expression<Action<T>> expression) { ActionMember = GetMethodInfoInternal(expression); ControllerType = ActionMember.DeclaringType.GetTypeInfo(); return this; } private static MethodInfo GetMethodInfoInternal(dynamic expression) { var method = expression.Body as MethodCallExpression; if (method != null) return method.Method; throw new ArgumentException("Expression is incorrect!"); } public TypedRouteModel WithName(string name) { Name = name; return this; } public TypedRouteModel ForHttpMethods(params string[] methods) { HttpMethods = methods; return this; } }
該類(lèi)主要的功能是:定義支持傳入Controller類(lèi)型,支持鏈?zhǔn)秸{(diào)用。
然后再定義一個(gè)繼承IApplicationModelConvention
接口的TypedRoutingApplicationModelConvention
類(lèi)。代碼如下:
public class TypedRoutingApplicationModelConvention : IApplicationModelConvention { internal static readonly Dictionary<TypeInfo, List<TypedRouteModel>> Routes = new Dictionary<TypeInfo, List<TypedRouteModel>>(); public void Apply(ApplicationModel application) { foreach (var controller in application.Controllers) { if (Routes.ContainsKey(controller.ControllerType)) { var typedRoutes = Routes[controller.ControllerType]; foreach (var route in typedRoutes) { var action = controller.Actions.FirstOrDefault(x => x.ActionMethod == route.ActionMember); if (action != null) { action.AttributeRouteModel = route; //注意這里是直接替換,會(huì)影響現(xiàn)有Controller上的Route特性定義的路由 foreach (var method in route.HttpMethods) { action.HttpMethods.Add(method); } } } } } } }
在該類(lèi)中,保存了一個(gè)靜態(tài)變量Routes,用于保存所有以Lamda表達(dá)式方式聲明的路由,然后在現(xiàn)有的Controllers集合中進(jìn)行查找及修改,然后替換AttributeRouteModel
屬性,并設(shè)置響應(yīng)的Http Method(如果不設(shè)置,則默認(rèn)所有的方式都允許)。
在這里,我們只是簡(jiǎn)單替換action.AttributeRouteModel
,所以會(huì)導(dǎo)致一些缺陷(比如一個(gè)Action只能支持一個(gè)路由路徑,以最后一個(gè)為準(zhǔn)),各位同學(xué)可以根據(jù)自己的能力進(jìn)行優(yōu)化。
優(yōu)化的時(shí)候,要注意Controller上的Route
集合保存在controller.Attributes
屬性上,Action上的Route集合保存在action.Attributes
屬性上,可以對(duì)其進(jìn)行優(yōu)化。
然后,在MvcOptions上,我們?cè)贋門(mén)ypeRouteModel添加一些擴(kuò)展方法以方便使用,代碼如下:
public static class MvcOptionsExtensions { public static TypedRouteModel GetRoute(this MvcOptions opts, string template, Action<TypedRouteModel> configSetup) { return AddRoute(template, configSetup).ForHttpMethods("GET"); } public static TypedRouteModel PostRoute(this MvcOptions opts, string template, Action<TypedRouteModel> configSetup) { return AddRoute(template, configSetup).ForHttpMethods("POST"); } public static TypedRouteModel PutRoute(this MvcOptions opts, string template, Action<TypedRouteModel> configSetup) { return AddRoute(template, configSetup).ForHttpMethods("PUT"); } public static TypedRouteModel DeleteRoute(this MvcOptions opts, string template, Action<TypedRouteModel> configSetup) { return AddRoute(template, configSetup).ForHttpMethods("DELETE"); } public static TypedRouteModel TypedRoute(this MvcOptions opts, string template, Action<TypedRouteModel> configSetup) { return AddRoute(template, configSetup); } private static TypedRouteModel AddRoute(string template, Action<TypedRouteModel> configSetup) { var route = new TypedRouteModel(template); configSetup(route); if (TypedRoutingApplicationModelConvention.Routes.ContainsKey(route.ControllerType)) { var controllerActions = TypedRoutingApplicationModelConvention.Routes[route.ControllerType]; controllerActions.Add(route); } else { var controllerActions = new List<TypedRouteModel> { route }; TypedRoutingApplicationModelConvention.Routes.Add(route.ControllerType, controllerActions); } return route; } public static void EnableTypedRouting(this MvcOptions opts) { opts.ApplicationModelConventions.Add(new TypedRoutingApplicationModelConvention()); } }
在上述代碼中,我們添加了一個(gè)EnableTypedRouting
擴(kuò)展方法,以便向MvcOptions.ApplicationModelConventions
屬性上添加新的TypedRoutingApplicationModelConvention
類(lèi)型示例。
其它的擴(kuò)展方法則都是用于聲明相關(guān)的route,大家注意,在最開(kāi)頭的示例中,我們看到獲取action信息的方法是通過(guò)委托調(diào)用該action方法(但沒(méi)有真正調(diào)用),但是有的方法有參數(shù),那怎么辦呢?為此,我們定于一個(gè)忽略參數(shù)的Param類(lèi),代碼如下:
public static class Param<TValue> { public static TValue Any { get { return default(TValue); } } }
這樣,我們?yōu)楹袇?shù)的About方法定于路由的時(shí)候,就可以這樣來(lái)定義了,代碼如下:
opt.GetRoute("aboutpage/{name}", c => c.Action<HomeController>(x => x.About(Param<string>.Any)));
另外,由于TypeRouteModel里很多方法都是可以鏈?zhǔn)秸{(diào)用,所以我們也可以通過(guò)這種方式為route指定一個(gè)名稱,示例代碼如下:
opt.GetRoute("homepage", c => c.Action<HomeController>(x => x.Index())).WithName("foo");
至此,整個(gè)強(qiáng)類(lèi)型路由的功能就實(shí)現(xiàn)完畢了,大家在使用的時(shí)候,就多了一種選擇了。
弊端(或Bug)
我們看到,在上面實(shí)現(xiàn)IApplicationModelConvention
接口的時(shí)候,我們只是簡(jiǎn)單的對(duì)action.AttributeRouteModel
進(jìn)行替換,也就是說(shuō),如果你在Action上已經(jīng)了Route
特性的話,他會(huì)把你的信息給你覆蓋掉,從而導(dǎo)致你的route失效。比如,如果你定義了一個(gè)這樣的自定義路由:
public class ProductsController : Controller { [Route("index")] public IActionResult Index() { return Content("Index"); } }
然后又通過(guò)Lamda表達(dá)式又定義了強(qiáng)類(lèi)型路由,代碼如下:
opt.GetRoute("homepage", c => c.Action<ProductsController>(x => x.Index()));
那么,你只能通過(guò)/homepage
開(kāi)來(lái)訪問(wèn),而不能通過(guò)/index
來(lái)訪問(wèn)了,因?yàn)樗涯愕腞oute給你覆蓋掉了。
但是,上述Lamda表達(dá)式方式并沒(méi)有覆蓋Controller上定義的Route特性定義,所以如果你在ProductsController上定義了Route特性的話,兩者就會(huì)組合在一起,例如:
[Route("products")] public class ProductsController : Controller { public IActionResult Index() { return Content("Index"); } }
那么你的訪問(wèn)網(wǎng)址應(yīng)該是/products/homepage
,而不是/homepage
。不過(guò)如果你在Lamda表達(dá)式方式里的代碼,是如下這樣的話:
opt.GetRoute("/homepage", c => c.Action<ProductsController>(x => x.Index()));
那你的訪問(wèn)網(wǎng)址就應(yīng)該是/homepage
了,因?yàn)樵撀酚勺址墙^對(duì)路徑/homepage
,而不是homepage
。
看完了這篇文章,相信你對(duì)“基于Lamda表達(dá)式的強(qiáng)類(lèi)型Routing實(shí)現(xiàn)的示例分析”有了一定的了解,如果想了解更多相關(guān)知識(shí),歡迎關(guān)注億速云行業(yè)資訊頻道,感謝各位的閱讀!
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。