這篇文章主要介紹了請(qǐng)求如何進(jìn)入ASP.NET MVC框架的實(shí)現(xiàn)過程,感興趣的小伙伴們可以參考一下
一、前言
對(duì)于WebForm開發(fā),請(qǐng)求通常是一個(gè)以.aspx結(jié)尾的url,對(duì)應(yīng)一個(gè)物理文件,從代碼的角度來說它其實(shí)是一個(gè)控件(Page)。而在MVC中,一個(gè)請(qǐng)求對(duì)應(yīng)的是一個(gè)Controller里的Action。熟悉asp.net的朋友都知道,asp.net請(qǐng)求實(shí)際都是交給HttpHandler處理(實(shí)現(xiàn)了IHttpHandler的類型)。無論是.aspx,.ashx,.asmx 還是MVC里的Action,請(qǐng)求都會(huì)交給HttpHandler。具體是在管道事件中,會(huì)根據(jù)請(qǐng)求創(chuàng)建一個(gè)HttpHandler,并執(zhí)行它的PR方法。對(duì)于aspx和ashx都很好理解,因?yàn)樗鼈儽旧砭蛯?shí)現(xiàn)了IHttpHandler接口,而MVC的Controller和Action都和HttpHandler沒有關(guān)系,它是如何實(shí)現(xiàn)的呢?接下來我們就看一個(gè)請(qǐng)求是如何進(jìn)入mvc框架內(nèi)部的。
二、例子
WebForm和MVC都是建立在asp.net平臺(tái)上的,Webform出現(xiàn)得比較早,那么MVC是如何做到在不影響底層框架,實(shí)現(xiàn)擴(kuò)展的呢?這主要得益于asp.net的路由機(jī)制。路由機(jī)制并不屬于MVC,WebForm也可以使用它。它的目的是讓一個(gè)請(qǐng)求與物理文件分離,原理是通過映射關(guān)系,將請(qǐng)求映射到指定的HttpHandler。例如我們也可以將一個(gè)/Admin/User.aspx?name=張三 的請(qǐng)求映射成可讀性更好的/Admin/張三。下面是兩種url的注冊(cè)方式:
public static void RegisterRoutes(RouteCollection routes)
{
//MVC
routes.MapRoute(
name: "Default",
url: "{controller}/{action}/{id}",
defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
);
//WebForm
routes.MapPageRoute(
routeName: "WebForm",
routeUrl: "Admin/{user}",
physicalFile: "~/Admin/User.aspx"
);
}
RouteCollection是一個(gè)Route集合,Route封裝了名稱、url模式、約束條件、默認(rèn)值等路由相關(guān)信息。其中,MapPageRoute是RouteCollection定義的方法,而MapRoute是MVC擴(kuò)展出來的(擴(kuò)展方法的好處就是可以在不修改原有代碼的情況下添加所需的功能)。它們的目的都是一樣的,創(chuàng)建一個(gè)Route對(duì)象,添加到集合當(dāng)中;我們也可以new 一個(gè)Route對(duì)象,然后調(diào)用RouteCollection.Add,效果是一樣的。下面我們主要關(guān)注MVC的實(shí)現(xiàn)過程,WebForm其實(shí)也是類似的。
三、分析源碼
接下來我們看MVC是如何利用路由機(jī)制實(shí)現(xiàn)擴(kuò)展的。路由機(jī)制是通過一個(gè)UrlRoutingModule完成的,它是一個(gè)實(shí)現(xiàn)了IHttpModule的類,路由模塊已經(jīng)默認(rèn)幫我們注冊(cè)好了。HttpModule通過注冊(cè)HttpApplication事件參與到管道處理請(qǐng)求中,具體是訂閱HttpApplication某個(gè)階段的事件。路由機(jī)制就是利用這個(gè)原理,UrlRoutingModule訂閱了PostResolveRequestCache 事件,實(shí)現(xiàn)url的映射。為什么是該事件呢?因?yàn)樵撌录南乱徊骄鸵瓿烧?qǐng)求和物理文件的映射,所以必須要此之前進(jìn)行攔截。核心代碼如下:
public class UrlRoutingModule : IHttpModule {
public RouteCollection RouteCollection {
get {
if (_routeCollection == null) {
//全局的RouteCollection集合
_routeCollection = RouteTable.Routes;
}
return _routeCollection;
}
set {
_routeCollection = value;
}
}
protected virtual void Init(HttpApplication application) {
//注冊(cè)PostResolveRequestCache事件
application.PostResolveRequestCache += OnApplicationPostResolveRequestCache;
}
private void OnApplicationPostResolveRequestCache(object sender, EventArgs e) {
//創(chuàng)建上下文
HttpApplication app = (HttpApplication)sender;
HttpContextBase context = new HttpContextWrapper(app.Context);
PostResolveRequestCache(context);
}
public virtual void PostResolveRequestCache(HttpContextBase context) {
//1.獲取RouteData
RouteData routeData = RouteCollection.GetRouteData(context);
if (routeData == null) {
return;
}
//2.獲取IRouteHandler
IRouteHandler routeHandler = routeData.RouteHandler;
if (routeHandler == null) {
}
//RequestContext保證了HttpContext和RouteData,在后續(xù)使用
RequestContext requestContext = new RequestContext(context, routeData);
context.Request.RequestContext = requestContext;
//3.獲取IHttpHandler
IHttpHandler httpHandler = routeHandler.GetHttpHandler(requestContext);
//重新映射到處理程序
context.RemapHandler(httpHandler);
}
}
我們關(guān)注主要方法PostResolveRequestCache,這里有三個(gè)關(guān)鍵步驟。
步驟一. 獲取RouteData
RouteData是對(duì)Route的包裝,在后續(xù)的處理中使用。它的獲取是通過RouteCollection獲得的,這個(gè)和上面注冊(cè)用到的RouteTable.Routes是同一個(gè)集合對(duì)象。調(diào)用RouteCollection的GetRouteData會(huì)遍歷它的每一個(gè)項(xiàng),也就是Route對(duì)象,然后調(diào)用Route對(duì)象的GetRouteData方法(MVC內(nèi)部很多集合都用到了這種設(shè)計(jì))。如下代碼:
public RouteData GetRouteData(HttpContextBase httpContext) {
using (GetReadLock()) {
foreach (RouteBase route in this) {
RouteData routeData = route.GetRouteData(httpContext);
if (routeData != null) {
return routeData;
}
}
}
return null;
}
Route對(duì)象的GetRouteData方法如下:
public override RouteData GetRouteData(HttpContextBase httpContext) {
string requestPath = httpContext.Request.AppRelativeCurrentExecutionFilePath.Substring(2) + httpContext.Request.PathInfo;
//結(jié)合默認(rèn)值,匹配url
RouteValueDictionary values = _parsedRoute.Match(requestPath, Defaults);
if (values == null) {
return null;
}
//包裝成RouteData,這里為什么不放在if后面呢?
RouteData routeData = new RouteData(this, RouteHandler);
//匹配約束
if (!ProcessConstraints(httpContext, values, RouteDirection.IncomingRequest)) {
return null;
}
//RouteData的Values和DataTokens都來自于Route
foreach (var value in values) {
routeData.Values.Add(value.Key, value.Value);
}
if (DataTokens != null) {
foreach (var prop in DataTokens) {
routeData.DataTokens[prop.Key] = prop.Value;
}
}
return routeData;
}
可以看到,Route對(duì)象的GetRouteData方法會(huì)匹配url模式,和檢查約束條件,如何不符合會(huì)返回null。如果匹配,則new一個(gè)RouteData。
步驟二、獲取IRouteHandler接口對(duì)象
上面創(chuàng)建RouteData,參數(shù)分別是當(dāng)前Route對(duì)象和它的RouteHandler屬性。RouteHandler是一個(gè)IRouteHandler,這是一個(gè)重要接口,它的定義如下:
public interface IRouteHandler {
IHttpHandler GetHttpHandler(RequestContext requestContext);
}
很明顯,它是用于獲取IHttpHandler的。那么Route對(duì)象的RouteHandler屬性又是在哪里初始化的呢?我們回到開始的注冊(cè)方法,routes.MapRoute,這個(gè)方法根據(jù)傳遞的參數(shù)創(chuàng)建一個(gè)Route對(duì)象,該方法的實(shí)現(xiàn)如下:
public static Route MapRoute(this RouteCollection routes, string name, string url, object defaults, object constraints, string[] namespaces)
{
//創(chuàng)建一個(gè)Route對(duì)象,它的IRouteHandler為MvcRouteHandler
Route route = new Route(url, new MvcRouteHandler())
{
Defaults = CreateRouteValueDictionary(defaults),
Constraints = CreateRouteValueDictionary(constraints),
DataTokens = new RouteValueDictionary()
};
if ((namespaces != null) && (namespaces.Length > 0))
{
route.DataTokens["Namespaces"] = namespaces;
}
//將Route注冊(cè)到RouteCollection中
routes.Add(name, route);
return route;
}
在創(chuàng)建Route時(shí),除了傳遞url模式外,還默認(rèn)幫我們傳遞了一個(gè)MvcRouteHandler,它實(shí)現(xiàn)了IRouteHandler接口。
步驟三、獲取IHttpHandler接口對(duì)象
有了MvcRouteHandler,就可以調(diào)用它的GetHttpHandler方法獲取IHttpHandler了,該方法實(shí)現(xiàn)如下:
protected virtual IHttpHandler GetHttpHandler(RequestContext requestContext)
{
//設(shè)置session狀態(tài)
requestContext.HttpContext.SetSessionStateBehavior(GetSessionStateBehavior(requestContext));
//返回一個(gè)實(shí)現(xiàn)了IHttpHandler的MvcHandler
return new MvcHandler(requestContext);
}
可以看到,它返回了一個(gè)MvcHandler,MvcHandler就實(shí)現(xiàn)了IHttpHandler接口。所以開頭說的,請(qǐng)求本質(zhì)都是交給HttpHandler的,其實(shí)MVC也是這樣的,請(qǐng)求交給了MvcHandler處理。我們可以看MvcHandler定義和主要方法:
public class MvcHandler : IHttpAsyncHandler, IHttpHandler, IRequiresSessionState
{
protected internal virtual IAsyncResult BeginProcessRequest(HttpContextBase httpContext, AsyncCallback callback, object state)
{
IController controller;
IControllerFactory factory;
//這個(gè)方法里會(huì)激活Controller對(duì)象
ProcessRequestInit(httpContext, out controller, out factory);
IAsyncController asyncController = controller as IAsyncController;
if (asyncController != null)
{
// asynchronous controller
BeginInvokeDelegate beginDelegate = delegate(AsyncCallback asyncCallback, object asyncState)
{
try
{
//調(diào)用Controller的BeginExecute方法
return asyncController.BeginExecute(RequestContext, asyncCallback, asyncState);
}
catch
{
factory.ReleaseController(asyncController);
throw;
}
};
EndInvokeDelegate endDelegate = delegate(IAsyncResult asyncResult)
{
try
{
asyncController.EndExecute(asyncResult);
}
finally
{
factory.ReleaseController(asyncController);
}
};
SynchronizationContext syncContext = SynchronizationContextUtil.GetSynchronizationContext();
AsyncCallback newCallback = AsyncUtil.WrapCallbackForSynchronizedExecution(callback, syncContext);
return AsyncResultWrapper.Begin(newCallback, state, beginDelegate, endDelegate, _processRequestTag);
}
else
{
// synchronous controller
Action action = delegate
{
try
{
controller.Execute(RequestContext);
}
finally
{
factory.ReleaseController(controller);
}
};
return AsyncResultWrapper.BeginSynchronous(callback, state, action, _processRequestTag);
}
}
}
可以看到,MvcHandler的任務(wù)就是激活Controller,并執(zhí)行它的Execute方法。這個(gè)過程和Webform里的頁(yè)面處理是很相似的,.aspx請(qǐng)求到來,會(huì)根據(jù)虛擬路徑找到實(shí)現(xiàn)IHttpHandler的Page(類似于路由機(jī)制根據(jù)url模式找到MvcHandler),然后進(jìn)入Page的頁(yè)面周期(類似于Mvc的激活Controller,然后執(zhí)行Action過程)。
四、總結(jié)
接下來,簡(jiǎn)單總結(jié)一下請(qǐng)求進(jìn)入到MVC框架的過程:
1.添加路由對(duì)象Route到全局的RouteCollection,Route的IRouteHandler初始化為MvcRouteHandler。
2. UrlRoutingModule注冊(cè) HttpApplication PostResolveRequestCache事件,實(shí)現(xiàn)請(qǐng)求攔截。
3. 請(qǐng)求到來, 在處理事件中遍歷RouteCollection,調(diào)用每一個(gè)Route對(duì)象的GetRouteData獲取RouteData包裝對(duì)象。
4. 調(diào)用MvcRouteHandler的GetHttpHandler獲取MvcHandler。
5. 調(diào)用HttpContext的RemapHandler將請(qǐng)求映射到MvcHandler處理程序。
6. 執(zhí)行MvcHandler的PR方法,激活Controller,執(zhí)行Action。
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助。