哈尔滨h5建站模板,wordpress占用空间,官方小程序,大连网站制作代理价格《200行代码#xff0c;7个对象——让你了解ASP.NET Core框架的本质》让很多读者对ASP.NET Core管道有了真实的了解。在过去很长一段时间中#xff0c;有很多人私信给我#xff1a;能否按照相同的方式分析一下MVC框架的设计与实现原理#xff0c;希望这篇文章能够满足你们的… 《200行代码7个对象——让你了解ASP.NET Core框架的本质》让很多读者对ASP.NET Core管道有了真实的了解。在过去很长一段时间中有很多人私信给我能否按照相同的方式分析一下MVC框架的设计与实现原理希望这篇文章能够满足你们的需求源代码可以通过原文下载。01MVC与路由整个MVC框架建立在路由中间件上。不论是面向Controller的Model-View-Controller编程模型还是面向页面的Razor Pages编程模型每个请求指向的都一个某个Action所以MVC框架只需要将每个Action封装成一个路由终结点RouteEndpoint并通过自定义的EndpointDataSource注册到路由中间件上即可。被封装的路由终结点它的请求处理器会帮助我们执行对应的Action这是一个相对复杂的流程所以我们创建了一个模拟框架。模拟框架采用真实MVC框架的设计和实现原理但是会在各个环节进行最大限度地简化。我们希望读者朋友们通过这个模拟框架对MVC框架的设计与实现具有一个总体的认识。02Action元数据的解析由于我们需要在应用启动的时候将所有Action提取出来并封装成路由终结点所以我们需要一种“Action发现机制”得到定义在所有Controller类型的Action方法以及所有Razor Page对应的Action方法并将它们的元数据提取出来。两种编程模型的Action元数据都封装到一个ActionDescriptor对象中。ActionDescriptor模拟框架针对Action的描述体现在如下这个ActionDescriptor类型上它的两个属性成员都与路由有关。我们知道面向Controller的MVC模型支持两种形式的路由即“约定路由Conventional Routing”和“特性路由Attribute Routing”。对于前者我们可以将路由规则定义在Action方法上标注的特性比如HttpGetAttribute特性上后者则体现为针对路由的全局注册。public abstract class ActionDescriptor
{public AttributeRouteInfo AttributeRouteInfo { get; set; }public IDictionarystring, string RouteValues { get; set; }
}public class AttributeRouteInfo
{public int Order { get; set; }public string Template { get; set; }
}
我们将通过特性路由提供的原始信息封装成 一个AttributeRouteInfo对象它的Template代表路由模板。对于一组给定的路由终结点来说有可能存在多个终结点的路由模式都与某个请求匹配所以代表路由终结点的RouteEndpoint类型定义了一个Order属性该属性值越小代表选择优先级越高。对于通过特性路由创建的RouteEndpoint对象来说它的Order属性来源于对应AttributeRouteInfo对象的同名属性。ActionDescriptor的RouteValues属性与“约定路由”有关。比如我们全局定义了一个模板为“{controller}/{action}/{id?}”的路由{controller}和{action}分别表示Controller和Action的名称如果定义在某个Controller类型比如FooController的Action方法比如Bar上没有标注任何路由特性它对应的路由终结点将采用这个约定路由来创建具体的路由模板将使用真正的Controller和Action名称“Foo/Bar/{id?}”。ActionDescriptor的RouteValues属性表示某个Action为约定路由参数提供的参数值这些值会用来替换约定路由模板中相应的路由参数来生成属于当前Action的路由模板。我们的模拟框架只提供针对面向Controller的MVC编程模型的支持针对该模型的Action描述通过如下这个ControllerActionDescriptor类型表示。ControllerActionDescriptor类型继承自抽象类ActionDescriptor它的MethodInfo和ControllerType属性分别表示Action方法和所在的Controller类型。public class ControllerActionDescriptor : ActionDescriptor
{public Type ControllerType { get; set; }public MethodInfo Method { get; set; }
}
IActionDescriptorProvider当前应用范围内针对有效Action元数据的解析通过相应的IActionDescriptorProvider对象来完成。如下面的代码片段所示IActionDescriptorProvider接口通过唯一的属性ActionDescriptors来提供用来描述所有有效Action的ActionDescriptor对象。public interface IActionDescriptorProvider
{IEnumerableActionDescriptor ActionDescriptors { get; }
}
如下这个ControllerActionDescriptorProvider类型是IActionDescriptorProvider接口针对面向Controller的MVC编程模型的实现。简单起见我们在这里作了这么一个假设所有的Controller类型都定义在当前ASP.NET Core应用所在的项目程序集中。基于这个假设我们在构造函数中注入了代表当前承载环境的IHostEnvironment对象并利用它得到当前的应用名称。由于应用名称同时也是程序集名称所以我们得以获取应用所在的程序集并从中解析出有效的Controller类型。public class ControllerActionDescriptorProvider : IActionDescriptorProvider
{private readonly LazyIEnumerableActionDescriptor _accessor;public IEnumerableActionDescriptor ActionDescriptors _accessor.Value;public ControllerActionDescriptorProvider(IHostEnvironment environment){_accessor new LazyIEnumerableActionDescriptor(() GetActionDescriptors(environment.ApplicationName));}private IEnumerableActionDescriptor GetActionDescriptors(string applicationName){var assemblyName new AssemblyName(applicationName);var assembly Assembly.Load(assemblyName);foreach (var type in assembly.GetExportedTypes()){if (type.Name.EndsWith(Controller)){var controllerName type.Name.Substring(0,type.Name.Length - Controller.Length);foreach (var method in type.GetMethods()){yield return CreateActionDescriptor(method, type, controllerName);}}}}private ControllerActionDescriptor CreateActionDescriptor(MethodInfo method,Type controllerType, string controllerName){var actionName method.Name;if (actionName.EndsWith(Async)){actionName actionName.Substring(0, actionName.Length - Async.Length);}var templateProvider method.GetCustomAttributes().OfTypeIRouteTemplateProvider().FirstOrDefault();if (templateProvider ! null){var routeInfo new AttributeRouteInfo{Order templateProvider.Order ?? 0,Template templateProvider.Template};return new ControllerActionDescriptor{AttributeRouteInfo routeInfo,ControllerType controllerType,Method method};}return new ControllerActionDescriptor{ControllerType controllerType,Method method,RouteValues new Dictionarystring, string{[controller] controllerName,[action] actionName}};}
}
简单起见我们只是将定义在当前应用所在程序集中采用“Controller”后缀命名的类型解析出来并将定义在它们之中的公共方法作为Action方法针对Controller和Action方法应该做更为严谨的有效性验证为了使模拟框架显得更简单一点我们刻意将这些验证简化了。我们根据类型和方法解析出Controller名称类型名称去除“Controller”后缀和Action名称方法名去除“Async”后缀并进一步为每个Action方法创建出对应的ControllerActionDescriptor对象。如果Action方法上标注了如下这个IRouteTemplateProvider接口类型的特性比如HttpGetAttribute类型最终实现了该接口意味着当前Action方法采用“特性路由”那么最终创建的ControllerActionDescriptor对象的AttributeRouteInfo属性将通过这个特性构建出来。如果没有标注这样的特性意味着可能会采用约定路由所以我们需要将当前Controller和Action名称填充到RouteValues属性表示的”必需路由参数值字典”中。public interface IRouteTemplateProvider
{string Name { get; }string Template { get; }int? Order { get; }
}
IActionDescriptorCollectionProviderControllerActionDescriptorProvider类型仅仅是IActionDescriptorProvider接口针对面向Controller的MVC编程模型的实现Razor Pages编程模型中对应的实现类型为PageActionDescriptorProvider。由于同一个应用是可以同时支持这两种编程模型的所以这两个实现类型可能会同时注册到应用的依赖注入框架中。MVC框架需要获取两种编程模型的Action这一个功能体现在如下这个IActionDescriptorCollectionProvider接口上描述所有类型Action的ActionDescriptor对象通过它的ActionDescriptors属性返回。public interface IActionDescriptorCollectionProvider
{IReadOnlyListActionDescriptor ActionDescriptors { get; }
}
如下所示的DefaultActionDescriptorCollectionProvider是对IActionDescriptorCollectionProvider接口的默认实现它直接利用在构造函数中注入的IActionDescriptorProvider对象列表来提供描述Action的ActionDescriptor对象。public class DefaultActionDescriptorCollectionProvider : IActionDescriptorCollectionProvider
{private readonly LazyIReadOnlyListActionDescriptor _accessor;public IReadOnlyListActionDescriptor ActionDescriptors _accessor.Value;public DefaultActionDescriptorCollectionProvider(IEnumerableIActionDescriptorProvider providers) _accessor new LazyIReadOnlyListActionDescriptor(() providers.SelectMany(it it.ActionDescriptors).ToList());
}
03路由当描述Action的所有ActionDescriptor对象被解析出来之后MVC框架需要将它们转换成表示路由终结点的RoutEndpoint对象。一个RoutEndpoint对象由代表路由模式的RoutePattern对象和代表请求处理器的RequestDelegate对象组成。RoutePattern对象可以直接通过ActionDescriptor对象提供的路由信息构建出来所以最难解决的是如果创建出用来执行目标Action的RequestDelegate对象。MVC框架中针对Action的执行是通过一个IActionInvoker对象来完成的。IActionInvokerMVC框架需要解决的核心问题就是根据请求选择并执行目标Action所以用来执行Action的IActionInvoker对象无疑是整个MVC框架最为核心的对象。虽然重要性不容置疑但是IActionInvoker接口的定义却极其简单。如下面的代码片段所示IActionInvoker接口只定义了一个唯一的InvokeAsync这是一个返回类型为Task的无参数方法。public interface IActionInvoker
{Task InvokeAsync();
}
用来执行Action的IActionInvoker对象是根据每个请求上下文动态创建的。具体来说当路由解析成功并执行匹配终结点的请求处理器时针对目标Action的上下文对象会被创建出来一个IActionInvokerFactory对象会被用来创建执行目标Action的IActionInvoker对象。顾名思义IActionInvokerFactory接口代表创建IActionInvoker对象的工厂针对IActionInvoker对象的创建体现在如下这个CreateInvoker方法上。public interface IActionInvokerFactory
{IActionInvoker CreateInvoker(ActionContext actionContext);
}
具体的IActionInvokerFactory对象应该创建怎样的IActionInvoker对象取决于提供的ActionContext上下文。如下面的代码片段所示ActionContext对象是对当前HttpContext上下文的封装它的ActionDescriptor属性返回的ActionDescriptor对象是对待执行Action的描述。public class ActionContext
{public ActionDescriptor ActionDescriptor { get; set; }public HttpContext HttpContext { get; set; }
}
ActionEndpointDataSourceBase终结点的路由模式可以通过描述Action的ActionDescriptor对象提供的路由信息来创建它的处理器则可以利用IActionInvokerFactory工厂创建的IActionInvoker对象来完成针对请求的处理所以我们接下来只需要提供一个自定义的EndpointDataSource类型按照这样的方式为每个Action创建对应的路由终结点就可以了。考虑到两种不同编程模型的差异我们会定义不同的EndpointDataSource派生类它们都继承自如下这个抽象的基类ActionEndpointDataSourceBase。public abstract class ActionEndpointDataSourceBase : EndpointDataSource
{private readonly LazyIReadOnlyListEndpoint _endpointsAccessor;protected readonly ListActionEndpointBuilder Conventions;public override IReadOnlyListEndpoint Endpoints _endpointsAccessor.Value;protected ActionEndpointDataSourceBase(IActionDescriptorCollectionProvider provider){Conventions new ListActionEndpointBuilder();_endpointsAccessor new LazyIReadOnlyListEndpoint(() CreateEndpoints(provider.ActionDescriptors, Conventions));}public override IChangeToken GetChangeToken() NullChangeToken.Instance;protected abstract ListEndpoint CreateEndpoints(IReadOnlyListActionDescriptor actions,IReadOnlyListActionEndpointBuilder conventions);
} MVC框架支持采用全局注册方式的 “约定理由Conventional Routing ” 这里的约定路由规则通过ActionEndpointBuilder对象的列表来体现对应着ActionEndpointDataSourceBase类型的Conventions属性。ActionEndpointDataSourceBase类型的构造函数中注入了一个IActionDescriptorCollectionProvider对象我们利用它来获取描述当前应用范围内所有Action的ActionDescriptor对象。Endpoints属性返回的路由终结点列表最终是通过抽象方法CreateEndpoints根据提供的ActionDescriptor对象列表和约定路由列表创建的。对于重写的GetChangeToken方法我们直接返回如下这个不具有变化监测功能的NullChangeToken对象。internal class NullChangeToken : IChangeToken
{public bool ActiveChangeCallbacks false;public bool HasChanged false;public IDisposable RegisterChangeCallback(Actionobject callback, object state) new NullDisposable() ;public static readonly NullChangeToken Instance new NullChangeToken();private class NullDisposable : IDisposable{public void Dispose() {}}
}
ControllerActionEndpointDataSourceControllerActionEndpointDataSource是ActionEndpointDataSourceBase的派生类型它帮助我们完成基于Controller的MVC编程模式下的路由终结点的创建。不过在正式介绍这个类型之前我们先来介绍两个与 “约定路由” 相关的类型。如下这个ConventionalRouteEntry结构表示单个约定路由的注册项其中包括路由名称、路由模式、Data Token和排列位置。我们在上面说过注册的约定路由规则最终体现为一个ActionEndpointBuilder对象的列表ConventionalRouteEntry的Conventions属性返回的就是这个列表。internal struct ConventionalRouteEntry
{public string RouteName;public RoutePattern Pattern { get; }public RouteValueDictionary DataTokens { get; }public int Order { get; }public IReadOnlyListActionEndpointBuilder Conventions { get; }public ConventionalRouteEntry(string routeName, string pattern,RouteValueDictionary defaults, IDictionarystring, object constraints,RouteValueDictionary dataTokens, int order,ListActionEndpointBuilder conventions){RouteName routeName;DataTokens dataTokens;Order order;Conventions conventions;Pattern RoutePatternFactory.Parse(pattern, defaults, constraints);}
} 另一个与约定路由相关的是如下这个ControllerActionEndpointConventionBuilder类型我们从其明明不难看出该类型用来帮助我们构建约定路由。ControllerActionEndpointConventionBuilder是对一个ActionEndpointBuilder列表的封装它定义的唯一的Add方法仅仅是向该列表中添加一个表示路由约定的ActionEndpointBuilder对象罢了。public class ControllerActionEndpointConventionBuilder : IEndpointConventionBuilder
{private readonly ListActionEndpointBuilder _conventions;public ControllerActionEndpointConventionBuilder(ListActionEndpointBuilder conventions){_conventions conventions;}public void Add(ActionEndpointBuilder convention) _conventions.Add(convention);
} 我们最后来看看ControllerActionEndpointDataSource类型的定义。对于ControllerActionEndpointDataSource对象构建的路由终结点来说作为请求处理器的RequestDelegate委托对象指向的都是ProcessRequestAsync方法。我们先来看看ProcessRequestAsync方法是如何处理请求的该方法首先从HttpContext上下文中获取当前终结点的Endpoint对象并从其元数据列表中得到预先放置的用来表示目标Action的ActionDescriptor对象。接下来该方法根据HttpContext上下文和这个ActionDescriptor对象创建出ActionContext上下文。该方法最后从基于请求的依赖注入容器中提取出IActionInvokerFactory工厂并利用它根据当前ActionContext上下文创建出对应的IActionInvoker对象。请求的处理最终通过执行该IActionInvoker得以完成。public class ControllerActionEndpointDataSource : ActionEndpointDataSourceBase
{private readonly ListConventionalRouteEntry _conventionalRoutes;private int _order;private readonly RoutePatternTransformer _routePatternTransformer;private readonly RequestDelegate _requestDelegate;public ControllerActionEndpointConventionBuilder DefaultBuilder { get; }public ControllerActionEndpointDataSource(IActionDescriptorCollectionProvider provider,RoutePatternTransformer transformer) : base(provider){_conventionalRoutes new ListConventionalRouteEntry();_order 0;_routePatternTransformer transformer;_requestDelegate ProcessRequestAsync;DefaultBuilder new ControllerActionEndpointConventionBuilder(base.Conventions);}public ControllerActionEndpointConventionBuilder AddRoute(string routeName,string pattern, RouteValueDictionary defaults,IDictionarystring, object constraints, RouteValueDictionary dataTokens){ListActionEndpointBuilder conventions new ListActionEndpointBuilder();order;conventionalRoutes.Add(new ConventionalRouteEntry(routeName, pattern, defaults,constraints, dataTokens, _order, conventions));return new ControllerActionEndpointConventionBuilder(conventions);}protected override ListEndpoint CreateEndpoints(IReadOnlyListActionDescriptor actions,IReadOnlyListActionEndpointBuilder conventions){var endpoints new ListEndpoint();foreach (var action in actions){var attributeInfo action.AttributeRouteInfo;if (attributeInfo null) //约定路由{foreach (var route in _conventionalRoutes){var pattern _routePatternTransformer.SubstituteRequiredValues(route.Pattern, action.RouteValues);if (pattern ! null){var builder new RouteEndpointBuilder(_requestDelegate, pattern, route.Order);builder.Metadata.Add(action);endpoints.Add(builder.Build());}}}else //特性路由{var original RoutePatternFactory.Parse(attributeInfo.Template);var pattern _routePatternTransformer.SubstituteRequiredValues(original, action.RouteValues);if (pattern ! null){var builder new RouteEndpointBuilder(_requestDelegate, pattern, attributeInfo.Order);builder.Metadata.Add(action);endpoints.Add(builder.Build());}}}return endpoints;}private Task ProcessRequestAsync(HttpContext httContext){var endpoint httContext.GetEndpoint();var actionDescriptor endpoint.Metadata.GetMetadataActionDescriptor();var actionContext new ActionContext{ActionDescriptor actionDescriptor,HttpContext httContext};var invokerFactory httContext.RequestServices.GetRequiredServiceIActionInvokerFactory();var invoker invokerFactory.CreateInvoker(actionContext);return invoker.InvokeAsync();}
}
ControllerActionEndpointDataSource定义了一个ListConventionalRouteEntry类型的字段_conventionalRoutes用来表示存储添加的约定路由注册项。的构造函数中除了注入了用于提供Action描述的IActionDescriptorCollectionProvider对象之外还注入了用于路由模式转换的RoutePatternTransformer对象。它的_order字段表示为注册的约定路由指定的位置编号最终会赋值到表示路由终结点的RouteEndpoint对象的Order属性。在实现的CreateEndpoints方法中ControllerActionEndpointDataSource会便利提供的每个ActionDescriptor对象如果该对象的AttributeRouteInfo属性为空意味着应该采用约定路由该方法会为每个表示约定路由注册项的ConventionalRouteEntry对象创建一个路由终结点。具体来说ControllerActionEndpointDataSource会将当前ActionDescriptor对象RouteValues属性携带的路由参数值包含Controller和Action名称等必要信息并将其作为参数调用RoutePatternTransformer对象的SubstituteRequiredValues方法将全局注册的原始路由模式比如“{controller}/{action}/{id?}”中相应的路由参数替换掉最终可能变成“Foo/Bar/{id?}”。SubstituteRequiredValues返回RoutePattern对象将作为最终路由终结点的路由模式。如果ActionDescriptor对象的AttributeRouteInfo属性返回一个具体的AttributeRouteInfo对象意味着应该采用特性路由支持它会利用这个AttributeRouteInfo对象创建一个新的RoutePattern对象将作为最终路由终结点的路由模式。不论是采用何种路由方式用来描述当前Action的ActionDescriptor对象都会以元数据的形式添加到路由终结点的元数据集合中对应于Endpoint类型的Metadata属性ProcessRequestAsync方法中从当前终结点提取的ActionDescriptor对象就来源于此。ControllerActionEndpointDataSource还提供了一个DefaultBuilder属性它会返回一个默认的ControllerActionEndpointConventionBuilder对象用来进一步注册约定路由。约定路由可以直接通过调用AddRoute方法进行注册由于该方法使用自增的_order字段作为注册路由的Order属性所以先注册的路由具有更高的选择优先级。AddRoute方法同样返回一个ControllerActionEndpointConventionBuilder对象。如下定义的针对IEndpointRouteBuilder接口的MapMvcControllers扩展方法帮助我们方便地注册ControllerActionEndpointDataSource对象。另一个MapMvcControllerRoute扩展方法则在此基础上提供了约定路由的注册。这两个扩展分别模拟的是MapControllers和MapControllerRoute扩展方法的实现为了避免命名冲突我们不得不起一个不同的方法名。public static class EndpointRouteBuilderExtensions
{public static ControllerActionEndpointConventionBuilder MapMvcControllers(this IEndpointRouteBuilder endpointBuilder){var endpointDatasource endpointBuilder.ServiceProvider.GetRequiredServiceControllerActionEndpointDataSource();endpointBuilder.DataSources.Add(endpointDatasource);return endpointDatasource.DefaultBuilder;}public static ControllerActionEndpointConventionBuilder MapMvcControllerRoute(this IEndpointRouteBuilder endpointBuilder, string name, string pattern,RouteValueDictionary defaults null, RouteValueDictionary constraints null,RouteValueDictionary dataTokens null){var endpointDatasource endpointBuilder.ServiceProvider.GetRequiredServiceControllerActionEndpointDataSource();endpointBuilder.DataSources.Add(endpointDatasource);return endpointDatasource.AddRoute(name, pattern, defaults, constraints,dataTokens);}
}
