深入了解ASP.NET MVC5的Controller核心原理及扩展

本文介绍一下ASP.NET mvc中与Controller相关的高级特性，下图展示了一个MVC请求从接收到响应的过程要经历的组件的流程。

下面我们主要就来谈谈ASP.NET MVC5中的Controller Factory和Action Invoker。这两个组件通过名字也能够知道这它们的用途。

controller factory主要是用来创建Contoller的实例，而action invoker是用来查找并调用一个Contoller类中的Action方法。MVC框架本自己就已经我们实现了这两个组件，下面我们就分别举例说明一下如何在ASP.NET MVC5中，自己实现一个Controller Factory、Action Invoker，并介绍一下使用内置组件Controller Factory、Action Invoker的方法。

一、创建一个自定义的Controller Factory

对于ASP.NET MVC中的大多数类或组件，我们想要真正的搞懂它，最好的方式就是继承对应的接口或抽象类，然后自己写一个它的实现类。同理要了解Controller Factory是怎么创建一个Controller实例的我们也可以自己写一个Controller Factory我类，所有的Controller Factory都使用了接口IControllerFactory。

首先，我们来看看IControllerFactory在MVC框架中是怎么定义的：

1. using System.Web.Routing;
2. using System.Web.SessionState;
4. namespace System.Web.Mvc {
5. public interface IControllerFactory {
7. IController CreateController(RequestContext requestContext,
8. string controllerName);
10. SessionStateBehavior GetControllerSessionBehavior(RequestContext requestContext,
11. string controllerName);
13. void ReleaseController(IController controller);
14. }
15. }

可以看到IControllerFactory有三个方法，它们的作用如下：

1、CreateController：负责创建Controller实例，返回类型是IController类型

2、GetControllerSessionBehavior：负责设置Controller的Session行为

3、ReleaseController：可以释放Controlller相关的资源

下面我们看看一个自定义自定义的Controller Factory的完整例子：

1.1、创建一个自定义Controller Factory

1. using System;
2. using System.Web.Mvc;
3. using System.Web.Routing;
4. using System.Web.SessionState;
5. using ControllerExtensibility.Controllers;
7. namespace ControllerExtensibility.Infrastructure {
9. public class CustomControllerFactory: IControllerFactory {
11. public IController CreateController(RequestContext requestContext,
12. string controllerName) {
14. Type targetType = null;
15. switch (controllerName) {
16. case "Product":
17. targetType = typeof(ProductController);
18. break;
19. case "Customer":
20. targetType = typeof(CustomerController);
21. break;
22. default:
23. requestContext.RouteData.Values["controller"] = "Product";
24. targetType = typeof(ProductController);
25. break;
26. }
28. return targetType == null ? null :
29. (IController)DependencyResolver.Current.GetService(targetType);
30. }
32. public SessionStateBehavior GetControllerSessionBehavior(RequestContext
33. requestContext, string controllerName) {
35. return SessionStateBehavior.Default;
36. }
38. public void ReleaseController(IController controller) {
39. IDisposable disposable = controller as IDisposable;
40. if (disposable != null) {
41. disposable.Dispose();
42. }
43. }
44. }
45. }

从上面我们可以看到CreateController有两个参数，第一个参数是RequestContext类型的对象，表示请求的上下文，可以用来访问或设置请求相关的信息，它有两个属性：

HttpContext：http请求上下文。

RouteData：MVC路由相关信息。

第二个是要创建的controller名。

在CreateController方法的最后使用了MVC内置的依赖注入容器解析类来创建一个类的实例：

1. return targetType == null ? null :
2. (IController)DependencyResolver.Current.GetService(targetType);

1.2、注册自定义Controller Factory类到MVC5框架，使其生效

自定义Controller Factory类在项目中要生效，必须要注册到MVC5框架中。注册自定义Controller Factory类会用到类ControllerBuilder类，如下：

1. using System;
2. using System.Collections.Generic;
3. using System.linq;
4. using System.Web;
5. using System.Web.Http;
6. using System.Web.Mvc;
7. using System.Web.Routing;
8. using ControllerExtensibility.Infrastructure;
10. namespace ControllerExtensibility {
12. public class MvcApplication : System.Web.HttpApplication {
13. protected void Application_Start() {
14. AreaRegistration.RegisterAllAreas();
16. WebApiConfig.Register(GlobalConfiguration.Configuration);
17. FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters)
18. RouteConfig.RegisterRoutes(RouteTable.Routes);
20. ControllerBuilder.Current.SetControllerFactory(new
21. CustomControllerFactory());
22. }
23. }
24. }

一旦这个CustomControllerFactory被注册成功了，它就负责请求创建相应的Controller实例并做出响应。

二、使用MVC5自带的Controller Factory即DefaultControllerFactory

注意：上面实现了一个自定义了的ControllerFactory，你应该明白了ControllerFactory的作用了，但是不建议你自己实现ControllerFactory，因为你负责处理一些潜在的问题，比如：有歧义的Controller名字--不同命名空间相同名称的Controller类，构造函数异常等等。其实最快速有效的方式是使用MVC框架的自带的Controller Factory，DefaultControllerFactory，因为这些问题都为我们解决了。但是要使用DefaultControllerFactory，Controller类必须要满足一下几个条件：

1、类必须是public的

2、类不能够是abstract抽象的

3、类不能够带有泛型参数

4、类名必须要以Controller结尾

5、类必须实现接口IController

DefaultControllerFactory自身会维护保持这一个满足以上条件的类列表，这样不用每次请求都去项目中搜索这样类。

2.1、设置Controller的命名空间的优先级

我们可以设置指定命名空间的Controller就先去匹配，如下：

1. public class MvcApplication : System.Web.HttpApplication {
2. protected void Application_Start() {
3. AreaRegistration.RegisterAllAreas();
5. WebApiConfig.Register(GlobalConfiguration.Configuration);
6. FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
7. RouteConfig.RegisterRoutes(RouteTable.Routes);
9. ControllerBuilder.Current.DefaultNamespaces.Add("MyControllerNamespace");
10. ControllerBuilder.Current.DefaultNamespaces.Add("MyProject.*");
11. }
12. }

上面我们用静态方法ControllerBuilder.Current.DefaultNamespaces.Add，设置了两个命名空间。

注意：这里两个Add是不分先后顺序的，并不表示写在前面就先去对应命名空间搜索。

2.2、自定义DefaultControllerFactory创建Controlller的实例

自定义DefaultControllerFactory创建Controlller的实例的方式有很多种，有时为了把我们的项目耦合性降低，我们一般会引入DI（依赖注入）。

1、使用MVC自带的Dependency Resolver

当有Dependency Resolver可用时，DefaultControllerFactory会使用它来创建Controller实例。

定义一个Dependency Resolver

1. using System;
2. using System.Collections.Generic;
3. using System.Web.Mvc;
4. using Ninject;
5. using Ninject.Parameters;
6. using Ninject.Syntax;
7. using System.Configuration;
8. using EssentialTools.Models;
10. namespace EssentialTools.Infrastructure {
11. public class NinjectDependencyResolver : IDependencyResolver {
12. private IKernel kernel;
14. public NinjectDependencyResolver() {
15. kernel = new StandardKernel();
16. AddBindings();
17. }
19. public object GetService(Type serviceType) {
20. return kernel.TryGet(serviceType);
21. }
23. public IEnumerable<object> GetServices(Type serviceType) {
24. return kernel.GetAll(serviceType);
25. }
27. private void AddBindings() {
28. kernel.Bind<IValueCalculator>().To<LinqValueCalculator>();
29. }
30. }
31. }

上面使用依赖注入DI（Ioc框架）--Ninject，最后在Gloabl中注册上面的NinjectDependencyResolver

1. using EssentialTools.Infrastructure;
2. using System.Web.Http;
3. using System.Web.Mvc;
4. using System.Web.Routing;
6. namespace EssentialTools {
7. public class MvcApplication : System.Web.HttpApplication {
8. protected void Application_Start() {
9. AreaRegistration.RegisterAllAreas();
11. DependencyResolver.SetResolver(new NinjectDependencyResolver());
13. WebApiConfig.Register(GlobalConfiguration.Configuration);
14. FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
15. RouteConfig.RegisterRoutes(RouteTable.Routes);
17. }
18. }
19. }

2、使用一个Controller Activator 

除了上面使用DependencyResolver来控制DefaultControllerFactory创建Controller，还可以定义一个Controller Activator，然后把这个类的实例通过DefaultControllerFactory的构造函数传进去。

我们先来看一看定义一个Controller Activator要用到的接口IControllerActivator：

1. namespace System.Web.Mvc {
2. using System.Web.Routing;
4. public interface IControllerActivator {
5. IController Create(RequestContext requestContext, Type controllerType);
6. }
7. }

下面是一个完整的Controller Activator的定义：

1. using ControllerExtensibility.Controllers;
2. using System;
3. using System.Web.Mvc;
4. using System.Web.Routing;
6. namespace ControllerExtensibility.Infrastructure {
7. public class CustomControllerActivator : IControllerActivator {
9. public IController Create(RequestContext requestContext,
10. Type controllerType) {
12. if (controllerType == typeof(ProductController)) {
13. controllerType = typeof(CustomerController);
14. }
16. return (IController)DependencyResolver.Current.GetService(controllerType);
17. }
18. }
19. }

最后在Global.asax 中注册使用这个 Controller Actionvator：

1. using System.Collections.Generic;
2. using System.Linq;
3. using System.Web;
4. using System.Web.Http;
5. using System.Web.Mvc;
6. using System.Web.Routing;
7. using ControllerExtensibility.Infrastructure;
9. namespace ControllerExtensibility {
11. public class MvcApplication : System.Web.HttpApplication {
12. protected void Application_Start() {
13. AreaRegistration.RegisterAllAreas();
15. WebApiConfig.Register(GlobalConfiguration.Configuration);
16. FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
17. RouteConfig.RegisterRoutes(RouteTable.Routes);
19. ControllerBuilder.Current.SetControllerFactory(new
20. DefaultControllerFactory(new CustomControllerActivator()));
21. }
22. }
23. }