解讀ASP.NET 5 & MVC6系列教程(12):基于Lamda表達(dá)式的強(qiáng)類型Routing實(shí)現(xiàn)
前面的深入理解Routing章節(jié),我們講到了在MVC中,除了使用默認(rèn)的ASP.NET 5的路由注冊方式,還可以使用基于Attribute的特性(Route和HttpXXX系列方法)來定義。本章,我們將講述一種基于Lambda表達(dá)式的強(qiáng)類型類型。
這種方式的基本使用示例如下:
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()));
});
從示例中可以看出,我們可以通過GetRoute或PostRoute等擴(kuò)展方法來定義route,而且后面使用Lambda表達(dá)式來定Controller的類型和Action的方法。
注意,在這里獲取Action的方法名,是通過委托執(zhí)行該Action方法來實(shí)現(xiàn)的(實(shí)際上并沒有執(zhí)行,而是基于此獲取該Action的MethodInfo)。
實(shí)現(xiàn)原理
在Stratup.cs的ConfigureServices方法中配置services的時(shí)候,我們可以對MVC站點(diǎn)使用的核心配置文件MvcOptions進(jìn)行配置,其中該類有一個(gè)ApplicationModelConventions屬性(List<IApplicationModelConvention>)可以保存一個(gè)IApplicationModelConvention接口的集合,改接口可以對MVC程序的程序模型進(jìn)行管線處理,該接口的定義如下:
public interface IApplicationModelConvention
{
void Apply(ApplicationModel application);
}
接口中的Apply方法所接收的參數(shù)類型是ApplicationModel,而ApplicationModel有兩個(gè)極其重要的內(nèi)容可以供我們操作,一個(gè)是Controller模型集合,一個(gè)是各種Filter的集合,該類的定義如下:
public class ApplicationModel
{
public ApplicationModel();
public IList<ControllerModel> Controllers { get; }
public IList<IFilter> Filters { get; }
}
這里最重要的就是ControllerModel類,該類的實(shí)例上保存了各種各樣重要而又可以操作的信息,比如該類和相關(guān)Action上的路由定義數(shù)據(jù),API描述信息,路由約束等等,這些信息都可以進(jìn)行操作。
新的IApplicationModelConvention注冊方式如下:
services.Configure<MvcOptions>(opt =>
{
opts.ApplicationModelConventions.Add(new MyApplicationModelConvention());
});
所以我們可以利用這個(gè)方法,在合適的時(shí)機(jī)對整個(gè)MVC的程序模型做響應(yīng)的調(diào)整和修改,本章節(jié)中的強(qiáng)類型路由就是利用這個(gè)特性來實(shí)現(xiàn)的。
實(shí)現(xiàn)步驟
首先定義一個(gè)強(qiáng)類型的路由模型TypedRouteModel類,該類要繼承于AttributeRouteModel,AttributeRouteModel類是基于Attribute路由的基本模型,TypedRouteModel類的代碼如下:
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;
}
}
該類主要的功能是:定義支持傳入Controller類型,支持鏈?zhǔn)秸{(diào)用。
然后再定義一個(gè)繼承IApplicationModelConvention接口的TypedRoutingApplicationModelConvention類。代碼如下:
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;
//注意這里是直接替換,會影響現(xiàn)有Controller上的Route特性定義的路由
foreach (var method in route.HttpMethods)
{
action.HttpMethods.Add(method);
}
}
}
}
}
}
}
在該類中,保存了一個(gè)靜態(tài)變量Routes,用于保存所有以Lamda表達(dá)式方式聲明的路由,然后在現(xiàn)有的Controllers集合中進(jìn)行查找及修改,然后替換AttributeRouteModel屬性,并設(shè)置響應(yīng)的Http Method(如果不設(shè)置,則默認(rèn)所有的方式都允許)。
在這里,我們只是簡單替換action.AttributeRouteModel,所以會導(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屬性上,可以對其進(jìn)行優(yōu)化。
然后,在MvcOptions上,我們再為TypeRouteModel添加一些擴(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類型示例。
其它的擴(kuò)展方法則都是用于聲明相關(guān)的route,大家注意,在最開頭的示例中,我們看到獲取action信息的方法是通過委托調(diào)用該action方法(但沒有真正調(diào)用),但是有的方法有參數(shù),那怎么辦呢?為此,我們定于一個(gè)忽略參數(shù)的Param類,代碼如下:
public static class Param<TValue>
{
public static TValue Any
{
get { return default(TValue); }
}
}
這樣,我們?yōu)楹袇?shù)的About方法定于路由的時(shí)候,就可以這樣來定義了,代碼如下:
opt.GetRoute("aboutpage/{name}", c => c.Action<HomeController>(x => x.About(Param<string>.Any)));
另外,由于TypeRouteModel里很多方法都是可以鏈?zhǔn)秸{(diào)用,所以我們也可以通過這種方式為route指定一個(gè)名稱,示例代碼如下:
opt.GetRoute("homepage", c => c.Action<HomeController>(x => x.Index())).WithName("foo");
至此,整個(gè)強(qiáng)類型路由的功能就實(shí)現(xiàn)完畢了,大家在使用的時(shí)候,就多了一種選擇了。
弊端(或Bug)
我們看到,在上面實(shí)現(xiàn)IApplicationModelConvention接口的時(shí)候,我們只是簡單的對action.AttributeRouteModel進(jìn)行替換,也就是說,如果你在Action上已經(jīng)了Route特性的話,他會把你的信息給你覆蓋掉,從而導(dǎo)致你的route失效。比如,如果你定義了一個(gè)這樣的自定義路由:
public class ProductsController : Controller
{
[Route("index")]
public IActionResult Index()
{
return Content("Index");
}
}
然后又通過Lamda表達(dá)式又定義了強(qiáng)類型路由,代碼如下:
opt.GetRoute("homepage", c => c.Action<ProductsController>(x => x.Index()));
那么,你只能通過/homepage開來訪問,而不能通過/index來訪問了,因?yàn)樗涯愕腞oute給你覆蓋掉了。
但是,上述Lamda表達(dá)式方式并沒有覆蓋Controller上定義的Route特性定義,所以如果你在ProductsController上定義了Route特性的話,兩者就會組合在一起,例如:
[Route("products")]
public class ProductsController : Controller
{
public IActionResult Index()
{
return Content("Index");
}
}
那么你的訪問網(wǎng)址應(yīng)該是/products/homepage,而不是/homepage。不過如果你在Lamda表達(dá)式方式里的代碼,是如下這樣的話:
opt.GetRoute("/homepage", c => c.Action<ProductsController>(x => x.Index()));
那你的訪問網(wǎng)址就應(yīng)該是/homepage了,因?yàn)樵撀酚勺址墙^對路徑/homepage,而不是homepage。
參考:http://www.strathweb.com/2015/03/strongly-typed-routing-asp-net-mvc-6-iapplicationmodelconvention/
相關(guān)文章
在ASP.NET 2.0中操作數(shù)據(jù)之六十九:處理Computed Columns列
SQL Server創(chuàng)建表的時(shí)候允許我們創(chuàng)建computed columns列,這種列的值源與表達(dá)式,并且是只讀的,所以我們不能通過Insert和Update為其賦值,本文具體講解創(chuàng)建和調(diào)用顯示的方法和步驟。2016-05-05
解讀ASP.NET 5 & MVC6系列教程(13):TagHelper
這篇文章主要介紹了新版MVC6中強(qiáng)大的TagHelper功能,需要的朋友可以參考下2016-06-06
解讀ASP.NET 5 & MVC6系列教程(3):項(xiàng)目發(fā)布與部署
這篇文章主要介紹了ASP.NET 5 項(xiàng)目發(fā)布與部署的設(shè)置和流程,并介紹IIS和web.cmd模式兩種發(fā)布模式的區(qū)別,需要的朋友可以參考一下。2016-06-06
在MacOS+Linux+Nginx中發(fā)布和部署Asp.Net?Core
這篇文章介紹了在MacOS+Linux+Nginx中發(fā)布和部署Asp.Net?Core,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-12-12
在ASP.NET 2.0中操作數(shù)據(jù)之三十:格式化DataList和Repeater的數(shù)據(jù)
本文主要介紹ASP.NET 2.0使用DataList和Repeater如何呈現(xiàn)數(shù)據(jù),一種是在控件的ItemDataBound事件中處理,一種則是在綁定數(shù)據(jù)時(shí)調(diào)用后臺定義的方法來實(shí)現(xiàn)。2016-05-05
ASP.NET MVC4入門教程(四):添加一個(gè)模型
本文主要介紹在MVC4中如何添加一個(gè)模型(Model),這個(gè)類負(fù)責(zé)和數(shù)據(jù)庫交互,主要處理一些增刪改查的操作。2016-04-04

