ASP.NET Web API ActionFilter 示例答案

【问题标题】：ASP.NET Web API ActionFilter exampleASP.NET Web API ActionFilter 示例
【发布时间】：2018-05-06 06:28:20
【问题描述】：

我是整个 MVC 的新手，我正在考虑使用 ASP.NET Web API 重新实现一些 WCF 服务。作为其中的一部分，我想实现一个动作过滤器，它记录所有动作和异常以及计时，所以我想我会从一个动作过滤器开始，但是过滤器没有被调用。

public class MyTrackingActionFilter : ActionFilterAttribute, IExceptionFilter 
{
    private Stopwatch stopwatch = new Stopwatch();

    public void OnException(ExceptionContext filterContext)
    {
           ...
    }

    public override void OnActionExecuted(ActionExecutedContext filterContext)
    {
           ...
    }

    public override void OnActionExecuting(ActionExecutingContext filterContext)
    {
        this.stopwatch.Start();
        Trace.TraceInformation(" Entering {0}", filterContext.RouteData);
    }
}

在控制器上，我有

[MyTrackingActionFilter]
public class MyResourceController : ApiController
{
  ...
}

使用如下调用在 Global.asax 中设置路由：

var routeTemplate = ...
var defaults = new { controller = controllerName, action = methodName };
var constraints = new { httpMethod = new HttpMethodConstraint(myHTTPMethods.Split(',')) };

routes.MapHttpRoute(methodName, routeTemplate, defaults, constraints);

问题是 MyResourceController 上的操作按预期调用并成功运行。客户端能够向服务器查询必要的信息，并且一切正常，除了没有调用任何操作过滤器方法。

我的理解是其余的都是“自动”发生的。这显然是不够的 - 关于什么是错的任何建议？我需要在某处注册吗？

【问题讨论】：

注意：我尝试将属性添加到操作和类中，但都没有成功。
100% 确保您的 API Controller 相关类使用 System.Web.HttpFilters 中的 ActionFilter 而不是 System.Web.Mvc 中的那个
在顶部你应该会看到类似的东西： using System.Web.HttpFilters;

标签： c# asp.net-web-api

【解决方案1】：

您必须确保您的代码使用ActionFilterAttribute from the System.Web.Http.Filters namespace 而不是来自System.Web.Mvc 的代码。

所以请检查你有

 using System.Web.Http.Filters;

【讨论】：

对于那些想知道的人，如果您正在构建 Mvc 应用程序，请使用 System.Web.Mvc；如果您正在构建 Web Api（从 ApiController 继承的控制器），请使用 System.Web.Http.Filters
如果这是在程序集中，您需要包含Microsoft.AspNet.WebApi.Core NuGet package

【解决方案2】：

正如 Sander 所说，我尝试了下面的代码，它的动作过滤器正在执行。

public class WebAPIActionFilterAttribute : System.Web.Http.Filters.ActionFilterAttribute
{
    public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
    {
        PersonController.Messages.Add("OnActionExecuted");
    }

    public override void OnActionExecuting(HttpActionContext actionContext)
    {
        PersonController.Messages.Add("OnActionExecuting");
    }
}

public class WebAPIExceptionFilter : System.Web.Http.Filters.ExceptionFilterAttribute
{
    public override void OnException(HttpActionExecutedContext actionExecutedContext)
    {
        PersonController.Messages.Add("OnException");
        actionExecutedContext.Response = new HttpResponseMessage(HttpStatusCode.NotFound) { Content = new StringContent("Something went wrong") };
    }
}

PersonController.Messages 是一个静态字符串列表。如果您想检查 OnActionExecuted 是否正在执行，您可以再次调用相同的 API 方法，您会在 Messages 列表中看到“OnActionExecuted”。

【讨论】：