如何在ASP.NET Core Web API中定义可返回ObjectResult的自定义属性

普通的Attribute类只是标记性的，没法直接处理请求逻辑、访问HttpContext或者中断请求流程。要实现你要的功能，得用ASP.NET Core的动作过滤器（Action Filter），也就是继承ActionFilterAttribute。

具体实现步骤 #

1. 定义自定义过滤器属性 #

继承ActionFilterAttribute，重写OnActionExecuting方法（这个方法会在端点逻辑执行前触发）：

using Microsoft.AspNetCore.Mvc.Filters;
using Microsoft.AspNetCore.Mvc;

public class DeveloperTaskAttribute : ActionFilterAttribute
{
    // 在端点执行前触发
    public override void OnActionExecuting(ActionExecutingContext context)
    {
        // 直接获取HttpContext
        var httpContext = context.HttpContext;

        // 这里写你的自定义逻辑，比如检查请求头、参数等
        var someCondition = false; // 替换成你的实际判断条件
        if (someCondition)
        {
            // 如果需要中断请求，返回BadRequest
            context.Result = new BadRequestObjectResult("不符合要求，请求中断");
            return;
        }

        // 如果不需要中断，什么都不用做，请求会继续执行端点逻辑
        base.OnActionExecuting(context);
    }
}

2. 在端点上使用属性 #

直接把这个属性标记在你的API端点方法或者控制器上就行：

[HttpGet]
[DeveloperTask] // 使用自定义过滤器属性
public IActionResult EndPoint1() 
{      
    // 端点逻辑会在过滤器允许的情况下执行
    return Ok("端点逻辑执行成功");
}

3. 可选：全局注册过滤器 #

如果想让这个过滤器作用于所有API端点，不用逐个标记，可以在Program.cs里全局注册：

var builder = WebApplication.CreateBuilder(args);

// 添加控制器服务，并注册全局过滤器
builder.Services.AddControllers(options =>
{
    options.Filters.Add<DeveloperTaskAttribute>();
});

var app = builder.Build();

// 中间件配置...
app.MapControllers();

app.Run();

关键说明 #

• ActionExecutingContext提供了请求的上下文信息，包括HttpContext、请求参数、控制器信息等。
• 当你给context.Result赋值时，ASP.NET Core会直接返回这个结果，跳过后续的端点逻辑执行。
• 如果不需要中断请求，不要设置context.Result，请求会正常进入端点方法执行逻辑。

内容的提问来源于stack exchange，提问作者MMD