解读ASP.NET 5 MVC6系列(10):Controller与Action
我们知道在MVC5和之前的版本,两个框架的生命周期是不一样的,在新版MVC6中,MVC Controller/Web API Controller已经合二为一了,本章我们主要讲解Controller和Action的定义与使用,以及在MVC框架中,如何根据路由查询相应的Controller和Action。
Controller&Action的定义和使用
在新版MVC6框架中,依然提供了一个Controller基类,在这里除了依然提供了Url
、RouteData
、HttpContent
、Request
、Response
以外,还提供了一个IServiceProvider
类型的Resovler
属性,该属于是依赖注入的容器,用于获取当前请求作用域内指定类型的实例对象。
其遵守如下规则:
- 继承于
Microsoft.AspNet.Mvc.Controller
的类肯定都是控制器,不管有没有Controller后缀。 - 不继承
Microsoft.AspNet.Mvc.Controller
的自定义XXXController要作为MVC Controller的话,,则必须要引用Microsoft.AspNet.Mvc
相关的程序集。 - 如果不想让满足上述条件的Controller类作为Controller,需要在该类上加上
NonControllerAttribute
特性。 - 同理,如果不想让某个Controller中的方法作为Action,则需要在该方法上加上
NonActionAttribute
特性。
另外还有如下几个特性需要注意:
特性 | 描述 |
---|---|
ActionNameAttribute | 定义Action的名称(可以和Action方法名不同) |
AcceptVerbsAttribute | 定义支持的Http Method名称,支持单个或多个Method。 |
ActivateAttribute | 依赖注入的标记,可以放在具有set权限的属性或字段上。 |
ResponseCacheAttribute | 针对某个Controller或Action设置客户端缓存。 |
RequireHttpsAttribute | 限制必须是Https请求。 |
RemoteAttribute | 标记为Ajax请求,服务器端不验证form表单的验证。 |
NonControllerAttribute | 标记该类不是Controller。 |
NonActionAttribute | 标记该方法不是Action。 |
Controller的查找机制
由上述章节,我们知道MVC6不仅支持正常的Controller(继承于Controller基类的子类),也支持POCO的Controller,本节我们就来研究一下Controller的查找原理机制。
首先,要判断一个类是否是Controller必须先确定有多少个程序集里定义了这样的类。Microsoft.AspNet.Mvc
命名空间下的IAssemblyProvider
接口就是覆盖查找所有可能定义Controller的程序集,该接口的默认实现是DefaultAssemblyProvider
类,在该类中,设置的必要条件是,定义了MVC的Controller必须要引用了如下程序集中的一个或多个程序集,列表如下:
Microsoft.AspNet.Mvc
Microsoft.AspNet.Mvc.Core
Microsoft.AspNet.Mvc.ModelBinding
Microsoft.AspNet.Mvc.Razor
Microsoft.AspNet.Mvc.Razor.Host
Microsoft.AspNet.Mvc.TagHelpers
Microsoft.AspNet.Mvc.Xml
Microsoft.AspNet.PageExecutionInstrumentation.Interfaces
也就是说,如果你定义了一个引用了Microsoft.AspNet.Mvc
的DLL类库的话,其里面的POCO Controller都会被认为是MVC的Controller。换句话说,如果你定义的POCO Controller类没有引用上述程序集中的任意一个程序集,那这些Controller类不会被认为是MVC的Controller。
程序集的查找
目前有两种方式可以自定义Controller的查找机制,第一种是继承IAssemblyProvider
实现CandidateAssemblies
方法(或重载DefaultAssemblyProvider
),来定义自己的逻辑。接口定义如下:
public interface IAssemblyProvider
{IEnumerable<Assembly> CandidateAssemblies { get; }
}
另外一种方式,可能相对来说更简单一些,那就是使用IServicesCollection
上定义的扩展方法来定义要查找的程序集:
services.AddMvc().WithControllersAsServices(new[]
{typeof(MyController).Assembly,typeof(ExternalPocoController).Assembly
});
使用上述代码后,系统将会把DefaultAssemblyProvider
切换成FixedSetAssemblyProvider
来实现上述判断机制,即:在固定范围内的程序集里进行查找。
程序集的筛选
确定了程序集以后,另外一个问题就来了,如何判断一个程序集是否引用了上述MVC必要条件中所列的程序集呢?答案是,Microsoft.Framework.Runtime
中的ILibraryManager
接口实例的GetReferencingLibraries
方法,可以查找有多少个程序集引用了上述列表中的其中一个程序集。例如,可以根据Microsoft.AspNet.Mvc
程序集,来查找有多少个程序集引用了该程序集,示例如下:
var col = this.Resolver.GetRequiredService<ILibraryManager>();
var data = col.GetReferencingLibraries("Microsoft.AspNet.Mvc");
该功能在DefaultAssemblyProvider默认实现类中的使用代码如下:
protected virtual IEnumerable<ILibraryInformation> GetCandidateLibraries()
{if (ReferenceAssemblies == null){return Enumerable.Empty<ILibraryInformation>();}// GetReferencingLibraries returns the transitive closure of referencing assemblies// for a given assembly.return ReferenceAssemblies.SelectMany(_libraryManager.GetReferencingLibraries).Distinct().Where(IsCandidateLibrary);
}
Controller的判断
确定了符合必要条件的程序集之后,就可以遍历该程序集内所有的类型,并接着判断该类型是否是Controller了。在新版的Controller判断上,实现该功能的是一个IControllerTypeProvider
接口,该接口提供了一个ControllerTypes
只读属性用于获取所有定义的Controller,接口定义如下:
public interface IControllerTypeProvider
{IEnumerable<TypeInfo> ControllerTypes { get; }
}
DefaultControllerTypeProvider
是该接口的默认实现,在查询符合条件的Controller的时候,该默认实现类定义了一个IsController
方法,用于判断一个类型是否是Controller,具体逻辑如下:
protected internal virtual bool IsController([NotNull] TypeInfo typeInfo,[NotNull] ISet<Assembly> candidateAssemblies)
{if (!typeInfo.IsClass) // 该类型必须是一个类{return false;}if (typeInfo.IsAbstract) // 该类必须不是抽象类{return false;}// We only consider public top-level classes as controllers. IsPublic returns false for nested// classes, regardless of visibility modifiersif (!typeInfo.IsPublic) // 该类必须是一个Public类(并且不嵌套),嵌套类不能作为Controller{return false;}if (typeInfo.ContainsGenericParameters) // 该类不能是泛型类{return false;}if (!typeInfo.Name.EndsWith(ControllerTypeName, StringComparison.OrdinalIgnoreCase) &&!DerivesFromController(typeInfo, candidateAssemblies)) // 该类以Controller结尾,或继承于Controller基类,或其父类也是Controller。{return false;}if (typeInfo.IsDefined(typeof(NonControllerAttribute))) // 该类不能设置NonControllerAttribute特性{return false;}return true;
}
你也可以自己实现IControllerTypeProvider
接口来定义自己的Controller判断逻辑,不过和固定某些程序集类型,MVC在IServicesCollection
上也提供了一个扩展方法,用于限制一些Controller特定类型,示例如下:
services.AddMvc().WithControllersAsServices(new[]{typeof(MyController),typeof(ExternalPocoController)});
使用上述代码后,系统将会把DefaultControllerTypeProvider
切换成FixedSetControllerTypeProvider
来实现上述判断机制,即:限制某些特定的类作为Controller,其它类型都不能作为Controller。
Action的查找机制
Action的选择则是通过IActionSelector
接口的默认实现类DefaultActionSelector
来实现的,在实现的SelectAsync
方法中,通过上下文和路由数据选择最匹配的Action,示意代码如下:
public Task<ActionDescriptor> SelectAsync([NotNull] RouteContext context)
{// ...
}
还有一个地方会判断一个方法是否是Action,那就是IActionModelBuilder
接口,该接口的默认实现为DefaultActionModelBuilder
类,实现方法如下:
public IEnumerable<ActionModel> BuildActionModels([NotNull] TypeInfo typeInfo,[NotNull] MethodInfo methodInfo)
{if (!IsAction(typeInfo, methodInfo)){return Enumerable.Empty<ActionModel>();}// ....省略其它代码
}
该实现方法,通过一个内部的IsAction
方法来判断该方法是否是一个真正的Action方法,具体代码如下:
protected virtual bool IsAction([NotNull] TypeInfo typeInfo, [NotNull] MethodInfo methodInfo)
{// The SpecialName bit is set to flag members that are treated in a special way by some compilers// (such as property accessors and operator overloading methods).if (methodInfo.IsSpecialName) // 不能是特殊名称(如重载的操作符或属性访问器){return false;}if (methodInfo.IsDefined(typeof(NonActionAttribute))) // 不能声明NonActionAttribute特性{return false;}// Overriden methods from Object class, e.g. Equals(Object), GetHashCode(), etc., are not valid.if (methodInfo.GetBaseDefinition().DeclaringType == typeof(object)) //不能是重载的方法,比如Equals和GetHashCode{return false;}// Dispose method implemented from IDisposable is not validif (IsIDisposableMethod(methodInfo, typeInfo)) // 不能是Dispose方法{return false;}if (methodInfo.IsStatic) // 不能是静态方法{return false;}if (methodInfo.IsAbstract) // 不能是抽象方法{return false;}if (methodInfo.IsConstructor) // 不能是构造函数{return false;}if (methodInfo.IsGenericMethod) // 不能是泛型方法{return false;}returnmethodInfo.IsPublic; // 必须是Public方法
}
以上内容就是关于Controller和Action查找相关的重要代码,详细原理步骤,请参考Microsoft.AspNet.Mvc.Core
程序集下的所有源码。
同步与推荐
本文已同步至目录索引:解读ASP.NET 5 & MVC6系列
解读ASP.NET 5 MVC6系列(10):Controller与Action相关推荐
- 解读ASP.NET 5 MVC6系列(14):View Component
原文:解读ASP.NET 5 & MVC6系列(14):View Component 在之前的MVC中,我们经常需要类似一种小部件的功能,通常我们都是使用Partial View来实现,因为M ...
- 解读ASP.NET 5 MVC6系列(13):TagHelper
解读ASP.NET 5 & MVC6系列(13):TagHelper 原文:解读ASP.NET 5 & MVC6系列(13):TagHelper 在新版的MVC6中,微软提供了强大的T ...
- [转]解读ASP.NET 5 MVC6系列(7):依赖注入
本文转自:http://www.cnblogs.com/TomXu/p/4496440.html 在前面的章节(Middleware章节)中,我们提到了依赖注入功能(Dependency Inject ...
- 解读ASP.NET 5 MVC6系列(7):依赖注入
原文:解读ASP.NET 5 & MVC6系列(7):依赖注入 在前面的章节(Middleware章节)中,我们提到了依赖注入功能(Dependency Injection),ASP.NET ...
- 解读ASP.NET 5 MVC6系列(6):Middleware详解
在第1章项目结构分析中,我们提到Startup.cs作为整个程序的入口点,等同于传统的Global.asax文件,即:用于初始化系统级的信息(例如,MVC中的路由配置).本章我们就来一一分析,在这里如 ...
- 解读ASP.NET 5 MVC6系列(9):日志框架
解读ASP.NET 5 & MVC6系列(9):日志框架 原文:解读ASP.NET 5 & MVC6系列(9):日志框架 框架介绍 在之前的.NET中,微软还没有提供过像样的日志框架, ...
- 解读ASP.NET 5 MVC6系列(17):MVC中的其他新特性
原文:解读ASP.NET 5 & MVC6系列(17):MVC中的其他新特性 (GlobalImport全局导入功能) 默认新建立的MVC程序中,在Views目录下,新增加了一个_Global ...
- [ASP.NET MVC 小牛之路]10 - Controller 和 Action (2)
继上一篇文章之后,本文将介绍 Controller 和 Action 的一些较高级特性,包括 Controller Factory.Action Invoker 和异步 Controller 等内容. ...
- 【ASP.NET MVC 学习笔记】- 10 Controller和Action(1)
本文参考:http://www.cnblogs.com/willick/p/3331521.html 1.继承IController接口,示例代码将当前请求的Controller和Action打印到浏 ...
最新文章
- kotlin重写构造方法编译报错:Primary constructor call expected
- 重磅福利!60篇近两年高影响因子环境污染微生态相关文献合集免费领取
- 【网络安全】 利用 EHole 进行红队快速批量打点
- [转] 深入浅出 妙用Javascript中apply、call、bind
- 如何在C++中调用C程序?
- 您需要了解的所有有关System.gc()的信息
- axios 的简单使用
- Spring-Data-JPA--增删改查2——自定义接口查询
- HCNA配置telnet远程管理
- 裸板烧写linux内核,嵌入式linux学习(二):烧写裸板进程
- 软件测试流程和项目管理流程
- python重写和重载的区别_Java 重写(Override)与重载(Overload)
- [译]C语言实现一个简易的Hash table(5)
- 线性代数第八章 λ 矩阵 定理8 多项式最大公约数的性质
- c语言个人日记本系统的设计,[设计]c语言程序课程设计日记本管理系统.doc
- php完美pdo类封装,PDO类的封装
- 上海居住证积分全流程
- 微信 Android 视频编码爬过的那些坑
- android自动照相机2.0,Koda相机app下载-Koda相机v2.0.12 安卓版-腾牛安卓网
- STM32F103ZE工程移植到STM32F107VC上软件调试时死循环在while((RCC-CR RCC_CR_PLL2RDY) == 0) { }
热门文章
- 纹理特征:灰度共生矩阵
- 大学计算机基础毕业论文操作步骤,大学计算机基础教学论文
- mysql32位主从复制安装包,MySQL安装-主从复制(5)
- Spark机器学习实战 (十二) - 推荐系统实战
- 亲测能用的mysqli类,挺好用的
- python学习笔记(四):函数
- 【android】getCacheDir()、getFilesDir()、getExternalFilesDir()、getExternalCacheDir()的作用
- Android 开发中常用小技巧
- 关于程序工作者的规划与思考
- REVIT使用中遇到的各种问题汇总