Comment ajouter des filtres globaux d'API Web ASP.Net?

J'ai créé un filtre Web Api (en utilisant System.Web.Http.Filters.ActionFilterAttribute) mais je ne parviens pas à le faire fonctionner dans ASP.Net MVC 4. J'ai essayé de l'ajouter à la RegisterGlobalFilters()méthode, mais cela n'a pas fonctionné.

Donc, si l'on utilise Web Api hébergé dans ASP.Net MVC, comment enregistrer les filtres?

Le code suivant, dans mon Global.asax, fonctionne pour moi:

public static void RegisterWebApiFilters(System.Web.Http.Filters.HttpFilterCollection filters)
{
  filters.Add(new MyWebApiFilter());
}

protected void Application_Start()
{
  RegisterWebApiFilters(GlobalConfiguration.Configuration.Filters);
}

notez que cette réponse est vraie jusqu'à MVC 5 / Web API 2

Réponse courte: Les filtres MVC et Web API ne sont pas compatibles entre eux et si vous souhaitez les enregistrer globalement, vous devez utiliser les classes de configuration appropriées pour chacun.

Réponse longue: ASP.NET MVC et l'API Web sont délibérément conçus pour fonctionner de la même manière, mais ce sont en fait des créatures différentes.

L'API Web vit sous l' System.Web.Httpespace de noms, tandis que MVC vit sous l' System.Web.Mvcespace de noms. Les deux vivront heureusement côte à côte, mais l'un ne contient pas l'autre et malgré les similitudes dans le modèle de programmation, les implémentations sous-jacentes sont différentes. Tout comme les contrôleurs MVC et les contrôleurs d'API Web héritent de différentes classes de contrôleur de base (MVC est simplement nommé Controlleret l'API Web est nommé ApiController), les filtres MVC et les filtres d'API Web héritent de différentes FilterAttributeclasses (les deux partagent le même nom dans ce cas, mais sont des classes distinctes qui vivent dans leurs espaces de noms respectifs).

Les filtres globaux de l'API Web sont enregistrés via l' HttpConfigurationobjet mis à votre disposition dans la Registerméthode WebApiConfig.cs si vous utilisez un modèle de projet avec WebActivator:

public static void Register(HttpConfiguration config)
{
    //stuff before
    config.Filters.Add(new MyWebApiFilter());
    //stuff after
}

ou autrement dans le global.asax.cs:

GlobalConfiguration.Configuration.Filters.Add(new MyWebApiFilter());

Mvc filtres globaux sont enregistrés au moyen d'un GlobalFilterCollectionobjet, qui est à votre disposition par la RegisterGlobalFiltersméthode de FilterConfig.cs pour les projets qui utilisent WebActivator:

public class FilterConfig
{
    public static void RegisterGlobalFilters(GlobalFilterCollection filters)
    {
        //stuff before
        filters.Add(new MyMvcFilter());
        //stuff after
    }
}

ou dans le fichier global.asax.cs en guise de GlobalFilters.Filterscollecte pour ceux sans WebActivator:

GlobalFilters.Filters.Add(new MyMvcFilter());

Il est à noter que dans les deux cas, vous n'avez pas besoin d'hériter du FilterAttributetype approprié . Les filtres d'API Web doivent uniquement implémenter l'interface System.Web.Http.IFilter, tandis que l'inscription de filtre MVC vérifie que votre classe hérite de l'une des rares interfaces de filtre définies dans l' System.Web.Mvcespace de noms.

À partir de MVC 4 RC, le nom de classe correct est HttpFilterCollection :

public static void RegisterWebApiFilters(System.Web.Http.Filters.HttpFilterCollection filters)
{
    filters.Add(new MyWebApiFilter());
}

protected void Application_Start()
{
    RegisterWebApiFilters(GlobalConfiguration.Configuration.Filters);
}

Au lieu d'utiliser des filtres globaux, je préfère faire ceci:

[MyWebApiFilter]
public class CustomizedApiControllerBase : ApiController
{
   ...
}

Et après cela, héritez de tous les contrôleurs api de CustomizedApiControllerBase Cette approche est plus expressive que les filtres globaux du fichier global.ascx.