Как добавить глобальные фильтры ASP.Net Web Api?

Я создал фильтр Web Api (использующий System.Web.Http.Filters.ActionFilterAttribute), но я не могу заставить его работать внутри ASP.Net MVC 4. Я попытался добавить его в RegisterGlobalFilters()метод, но это не сработало.

Итак, если вы используете Web Api, размещенный в ASP.Net MVC, как зарегистрировать фильтры?

У меня работает следующий код в моем Global.asax:

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

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

обратите внимание, что этот ответ верен до MVC 5 / Web API 2

Краткий ответ: фильтры MVC и веб-API несовместимы, и если вы хотите зарегистрировать их глобально, вы должны использовать соответствующие классы конфигурации для каждого из них.

Длинный ответ: ASP.NET MVC и веб-API специально разработаны для работы одинаковым образом, но на самом деле это разные существа.

Веб-API находится в System.Web.Httpпространстве имен, а MVC - в System.Web.Mvcпространстве имен. Эти два будут счастливо жить бок о бок, но один не содержит другого, и, несмотря на сходство модели программирования, лежащие в основе реализации разные. Так же, как контроллеры MVC и контроллеры веб-API наследуют разные базовые классы контроллеров (MVC просто именуются, Controllerа веб-API именуются ApiController), фильтры MVC и фильтры веб-API наследуются от разных FilterAttributeклассов (оба имеют одно и то же имя в этом случае, но являются отдельными классами, которые живут в их соответствующих пространствах имен).

Глобальные фильтры веб-API регистрируются через HttpConfigurationобъект, доступный вам в Registerметоде WebApiConfig.cs, если вы используете шаблон проекта с WebActivator:

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

или иначе в global.asax.cs:

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

Глобальные фильтры MVC регистрируются с помощью GlobalFilterCollectionобъекта, который доступен вам через RegisterGlobalFiltersметод FilterConfig.cs для проектов, использующих WebActivator:

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

или в файле global.asax.cs путем GlobalFilters.Filtersсбора для тех, у кого нет WebActivator:

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

Стоит отметить, что в обоих случаях наследование от соответствующего FilterAttributeтипа не требуется . Фильтры веб-API должны реализовывать только интерфейс System.Web.Http.IFilter, в то время как регистрация фильтра MVC проверяет, наследует ли ваш класс один из нескольких интерфейсов фильтра, определенных в System.Web.Mvcпространстве имен.

Начиная с MVC 4 RC, правильное имя класса - HttpFilterCollection :

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

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

Я предпочитаю использовать не глобальные фильтры:

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

И после этого унаследовать все контроллеры api от CustomizedApiControllerBase этого подхода более выразительно по сравнению с глобальными фильтрами в файле global.ascx.