MVC Action Filters

03 August 2011 brianbruff

 

So what are MVC Filters? To quote Professional ASP.NET MVC2 ISBN 978-0-470-64318-1

”Filters are a declarative attribute-based means of providing cross-cutting behavior to an action method.”

So what are MVC Filters? Sarcastic smile Well lets discuss the M the V and the C, The model is the data we wish to display in, the View, which is how we present the data, the responsibility of the controller is to coordinate the view with the model. But what about orthogonal functionalities, e.g logging, error handling, authentication etc.

In MVC the responsibility for these activities is undertaken by Filters. Out of the box MVC provides the following Filters

  • Authorize
  • HandleError
  • OutputCache
  • RequireHttps
  • ValidateAntiForgeryToken
  • ChildOnlyAction
  • ValidateInput
[HandleError[ExceptionType = typeof(RuntimeException), View='RuntimeError']
public ActionResult Test()
{
    throw new RuntimeException("oops");
}

What happens here is the we get directed towards the RuntimeError view,

The attributes can be added to the Controller or Action.

In MCV3 we get the possibility to add these filters Globally. The advantage of this is you no longer need to decorate every controller or action with an attribute that you wanted executed whenever it ran, now you can register is one place and have it executed across multiple controllers and action.

You add these global filters in your Global.asax as follows

public static void RegisterGlobalFilters(GlobalFilterCollection filters) 
{ 
    filters.Add(new HandleErrorAttribute());         
}