.NET6自定义WebAPI过滤器

下面是“.NET6自定义WebAPI过滤器”的完整攻略。

什么是WebAPI过滤器？

WebAPI过滤器是ASP.NET Core中的一项功能，用于在Http中增加一些额外的功能，例如在处理请求或响应时进行日志记录、身份验证、缓存处理等。WebAPI过滤器可以全局应用，也可以被应用于单个Controller或Action。

如何创建自定义的WebAPI过滤器？

步骤一：定义一个类继承自ActionFilterAttribute或IActionFilter

public class MyFilter : ActionFilterAttribute
{
    public override void OnActionExecuting(ActionExecutingContext context)
    {
        // 在Action执行之前进行处理
        // 在此处可以加入日志记录，身份验证等操作
    }

    public override void OnActionExecuted(ActionExecutedContext context)
    {
        // 在Action执行后进行处理
        // 在此处可以加入缓存处理等操作
    }
}

步骤二：将自定义的WebAPI过滤器注册到Startup.cs中

public void ConfigureServices(IServiceCollection services)
{
    // 全局注册
    services.AddControllers(options =>
    {
        options.Filters.Add(typeof(MyFilter));
    });
}

步骤三：将自定义的WebAPI过滤器应用到单个Controller或Action中

[ServiceFilter(typeof(MyFilter))]
public class MyController : ControllerBase
{
    // Code
}

示例一：给所有WebAPI请求添加TraceID

public class TraceFilter : ActionFilterAttribute
{
    public override void OnActionExecuting(ActionExecutingContext context)
    {
        // 生成TraceID
        var traceId = Guid.NewGuid().ToString("N");

        // 把TraceID存放在HttpContext中
        context.HttpContext.Items["TraceId"] = traceId;

        base.OnActionExecuting(context);
    }
}

// 注册
services.AddControllers(options =>
{
    options.Filters.Add(typeof(TraceFilter));
});

// 使用
public void Get()
{
    var traceId = HttpContext.Items["TraceId"].ToString();
    // Code
}

示例二：给指定的Action添加Rate Limit

public class RateLimitFilter : Attribute, IActionFilter
{
    private readonly int _limit;
    public RateLimitFilter(int limit)
    {
        _limit = limit;
    }

    public void OnActionExecuting(ActionExecutingContext context)
    {
        var ipAddress = context.HttpContext.Connection.RemoteIpAddress;

        var cacheKey = $"ratelimit:{ipAddress}:{context.ActionDescriptor.DisplayName}";
        var counter = 1;

        if(context.HttpContext.Items.ContainsKey(cacheKey))
        {
            counter = Convert.ToInt32(context.HttpContext.Items[cacheKey]);
            counter ++ ;
        }

        // 超过限制次数就返回 429 Too Many Requests
        if(counter > _limit)
        {
            context.Result = new StatusCodeResult(429);
            return;
        }

        context.HttpContext.Items[cacheKey] = counter;
    }

    public void OnActionExecuted(ActionExecutedContext context)
    {

    }
}

// 使用
[HttpGet("api/rate-limit"), RateLimitFilter(5)]
public IActionResult Get()
{
    // Code
}

以上就是“.NET6自定义WebAPI过滤器”的完整攻略，希望能对你有所帮助。