WebApi接口访问频率控制的实现

2023-05-22,,

关于限流的文章,博客园内还是有挺多的。本文做了一个基于Filter限流的例子,算是对WebApiThrottle使用的一个具体的实例。

实现方法:

1、使用Nuget,对WebAPI项目添加WebApiThrottle的引用

2、进行注册,一般是在WebApiConfig的Register方法里添加,代码如下:

         config.Filters.Add(new CustomThrottlingFilter()
{
Policy = new ThrottlePolicy()
{
//ip配置区域
IpThrottling = true,
ClientThrottling = true, //端点限制策略配置会从EnableThrottling特性中获取。
EndpointThrottling = true
}
});

其中CustomThrottlingFilter是自己重写的ThrottlingFilter,也可以直接用默认配置。我自定义的CustomThrottlingFilter如下:

     public class CustomThrottlingFilter: ThrottlingFilter
{
/// <summary>
/// Sets the indentity.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>RequestIdentity.</returns>
protected override RequestIdentity SetIndentity(HttpRequestMessage request)
{
var sessionId = string.Empty;
try
{
var requestCookie = request.Headers.GetCookies().FirstOrDefault();
if (requestCookie != null)
{
foreach (var item in requestCookie.Cookies.Where(item => item.Name == "Session_Id"))
{
sessionId = item.Value;
break;
}
}
}
catch (Exception)
{
sessionId = string.Empty;
}
return new RequestIdentity()
{
ClientKey = string.IsNullOrWhiteSpace(sessionId) ? sessionId : "anon",
ClientIp = base.GetClientIp(request).ToString(),
Endpoint = request.RequestUri.AbsolutePath.ToLowerInvariant()
};
}
}

3、对需要控制接口或者控制器加上头标示

  [EnableThrottling(PerMinute = )]//控制访问频率,每分钟最多12次

不需要控制访问频率的可以不加或者加上

 [DisableThrotting]

这样就实现了使用过滤器控制特定API的访问频率,更多的使用方法可以参考下面的地址。

参考资料:

WebApiThrottle限流框架使用手册  http://www.cnblogs.com/mushroom/p/4659200.html

控制ASP.NET Web API 调用频率与限流 http://www.cnblogs.com/Irving/p/4664786.html

控制ASP.NET Web API 调用频率 http://www.cnblogs.com/shanyou/p/3194802.html

WebApi接口访问频率控制的实现的相关教程结束。

《WebApi接口访问频率控制的实现.doc》

下载本文的Word格式文档,以方便收藏与打印。