ASP.NET Core 中的行动过滤器如何使用?

来源:这里教程网 时间:2026-02-21 17:27:59 作者:

在 ASP.NET Core 中,行动过滤器(Action Filter)用于在控制器的某个动作方法执行前后插入自定义逻辑。它适用于日志记录、权限验证、参数校验、结果修改等场景。理解并正确使用行动过滤器可以提升代码的可维护性和复用性。

什么是行动过滤器?

行动过滤器是实现 IActionFilter 或继承 ActionFilterAttribute 的类,它允许你在动作方法执行前和执行后运行代码。ASP.NET Core 提供了多个过滤器接口,而行动过滤器主要关注的是 OnActionExecutingOnActionExecuted 两个方法:

OnActionExecuting:在动作方法执行前调用,可用于拦截请求(如验证失败时返回错误)。 OnActionExecuted:在动作方法执行后调用,可用于修改结果或记录执行信息。

创建自定义行动过滤器

下面是一个简单的示例,展示如何创建一个记录请求时间的行动过滤器:

using Microsoft.AspNetCore.Mvc.Filters;
using System.Diagnostics;
public class LogActionFilter : ActionFilterAttribute
{
    private Stopwatch _stopwatch;
    public override void OnActionExecuting(ActionExecutingContext context)
    {
        _stopwatch = Stopwatch.StartNew();
        Console.WriteLine($"开始执行动作: {context.ActionDescriptor.DisplayName}");
    }
    public override void OnActionExecuted(ActionExecutedContext context)
    {
        _stopwatch?.Stop();
        Console.WriteLine($"动作执行完成,耗时: {_stopwatch.ElapsedMilliseconds}ms");
    }
}

注册和使用过滤器

行动过滤器可以在多个级别注册,控制其作用范围:

应用到单个控制器或动作:直接在控制器或方法上添加特性。
[LogActionFilter]
public class HomeController : Controller
{
    [HttpGet]
    public IActionResult Index()
    {
        return View();
    }
}
全局注册:在 Program.cs 中将过滤器添加到 MVC 配置中,使其对所有动作生效。
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddControllersWithViews(options =>
{
    options.Filters.Add<LogActionFilter>();
});

常见应用场景

行动过滤器适合处理横切关注点。几个典型用途包括:

权限检查:在 OnActionExecuting 中判断用户是否有权访问当前操作,若无则设置 context.Result 返回 403。 模型验证增强:如果模型状态无效,可提前终止执行并返回错误响应。 性能监控:像上面的例子一样,测量每个动作的执行时间。 修改输出结果:在 OnActionExecuted 中更改 context.Result,例如统一包装 API 响应格式。

基本上就这些。掌握行动过滤器的使用,能让控制器更干净,通用逻辑更容易集中管理。注意不要在过滤器中做太重的操作,避免影响整体性能。

相关推荐