MVC Life Cycle - Part Four

Before reading this article, I highly recommend you read my previous parts:

This is the continuation of the MVC Life Cycle Series. If you are referring this article as a standalone, I would encourage you to go through the entire series in order to understand the entire gist of the same.

In this section, we are going to see how Controllers are created and initialized. Basically, controllers do nothing but implement IController interface. IController defines one important method called Execute(). Also, it is important to note that this method is entirely generic which means you can build your controller in a more custom way specific to particular requirement. However, MVC is very powerful framework wherein all the concerns are already addressed. But, you can extend the default implementation for any specific need.

Here, ControllerFactory here comes into picture. Here, it is used by MVCHandler. Now, ControllerFactory's primary responsibility is to provide appropriate type of controller to service the request. Again, ControllerFactory is tied with IControllerFactory. Hence, without wasting time, let us go ahead and jump to the demo. In the following snippet, I have created one sample controller and implemented IController here.

using System;
using System.Web.Mvc;
using System.Web.Routing;
namespace MVC_Life_Cycle.Controllers
{
public class SampleController : IController
{
public void Execute(RequestContext requestContext)
{
throw new NotImplementedException();
}
}
}

Above snippet is the raw snippet obviously. Now, let us go ahead and modify the same.

using System;
using System.Net.Http;
using System.Web;
using System.Web.Mvc;
using System.Web.Routing;
namespace MVC_Life_Cycle.Controllers
{
public class SampleController : IController
{
public void Execute(RequestContext requestContext)
{
//Displaying some message
HttpContext.Current.Response.Write("Hello From Custom Controller Implementation");
}
}
}

Now, let us go ahead and create one controller factory which will basically implement our custom controller. Now, you may be thinking there are lots of stuff going here, which is true by the way in this context.

using System.Web.Mvc;
using System.Web.Routing;
using System.Web.SessionState;
namespace MVC_Life_Cycle.CustomFactory
{
public class CustomFactory :IControllerFactory
{
public IController CreateController(RequestContext requestContext, string controllerName)
{
throw new System.NotImplementedException();
}
public SessionStateBehavior GetControllerSessionBehavior(RequestContext requestContext, string controllerName)
{
throw new System.NotImplementedException();
}
public void ReleaseController(IController controller)
{
throw new System.NotImplementedException();
}
}
}

Here you can see that controller factory implements three methods wherein, the first one is for controller creation, the third one is for session maintenance, and the third one is obviously for releasing the controller.

using System.Web.Mvc;
using System.Web.Routing;
using System.Web.SessionState;
using MVC_Life_Cycle.Controllers;
namespace MVC_Life_Cycle.CustomFactory
{
public class CustomFactory :IControllerFactory
{
public IController CreateController(RequestContext requestContext, string controllerName)
{
//Finds the controller with its name and then bring the logic here
if (controllerName == "Sample")
{
return new SampleController();
}
else
{
//Else return the existing one
return new HomeController();
}
}
//These two implementations are not required for the time being. Hence, kept the default values
public SessionStateBehavior GetControllerSessionBehavior(RequestContext requestContext, string controllerName)
{
return SessionStateBehavior.Default;
}
public void ReleaseController(IController controller)
{
//Since, this is void method. Hence, left empty for the time being
}
}
}

Now, in order to register the same, I need to make the changes in global.asax file itself.

using System.Diagnostics;
using System.Web;
using System.Web.Mvc;
using System.Web.Optimization;
using System.Web.Routing;
using MVC_Life_Cycle;
using MVC_Life_Cycle.CustomModules;
[assembly: PreApplicationStartMethod(typeof(MvcApplication), "RegisterCustomModule")]
namespace MVC_Life_Cycle
{
public class MvcApplication : System.Web.HttpApplication
{
public static void RegisterCustomModule()
{
HttpApplication.RegisterModule(typeof(CustomModule));
}
protected void Application_Start()
{
//Registering that custom controller
ControllerBuilder.Current.SetControllerFactory(new CustomFactory.CustomFactory());
AreaRegistration.RegisterAllAreas();
FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
RouteConfig.RegisterRoutes(RouteTable.Routes);
BundleConfig.RegisterBundles(BundleTable.Bundles);
}
protected void Application_End()
{
Debug.WriteLine("Application Stopped");
}
}
}

With the above change in place, when I run the app and navigate to URL http://localhost:44694/Sample, then it will produce the following output.

And then it will produce the default result.

I hope you have liked this discussion. I will continue to delve further in coming session. Until then, stay tuned and happy coding.

Code Download Link.

6 Comments

Join the conversation! Your thoughts help the community grow.

Manoj Kalla10y ago
Good one
Pradeep Sahoo10y ago
Thanks Rahul for such internals , can you please tell me some scenario where Execute() need to be written some custom logic .
- Rahul Sahay10y ago
  Ideally, it doesn't require overriding built in capabilities of MVC. But, let us suppose, there is some naming conflict or Business Scenario conflict even after applying logical Isolations like Areas. Then, before invoking normal built-in route, we can override with our custom route and from there, you can override this Execute() method. Again, this is very rare scenario. But, out of the box, MVC do provide flexibility to handle the scenario if there is any!
Santhakumar Munuswamy10y ago
Thanks for nice share
Ankit Bansal10y ago
keep sharing..thanks
Humayun Kabir Mamun10y ago
Nice...