使用 Dnc.Api.Throttle 可以使您轻松实现 webApi 接口的限流管理. Dnc.Api.Throttle 支持 IP, 用户身份, Request Header,Request QueryString 等多种限流策略, 支持黑名单和白名单功能, 支持全局拦截和单独 Api 拦截.
Dnc.Api.Throttle 暂时只支持 Redis 作为缓存和存储库, 后续会进行扩展.
开始使用
安装 Dnc.Api.Throttle
- NuGet:
- PM> Install-Package Dnc.Api.Throttle
基本配置
- Startup.cs:
- public void ConfigureServices(IServiceCollection services)
- {
- //Api 限流
- services.AddApiThrottle(options => {
- // 配置 redis
- // 如果 Cache 和 Storage 使用同一个 redis, 则可以按如下配置
- options.UseRedisCacheAndStorage(opts => {
- opts.ConnectionString = "localhost,connectTimeout=5000,allowAdmin=false,defaultDatabase=0";
- //opts.KeyPrefix = "apithrottle"; // 指定给所有 key 加上前缀, 默认为 apithrottle
- });
- // 如果 Cache 和 Storage 使用不同 redis 库, 可以按如下配置
- //options.UseRedisCache(opts => {
- // opts.ConnectionString = "localhost,connectTimeout=5000,allowAdmin=false,defaultDatabase=0";
- //});
- //options.UseRedisStorage(opts => {
- // opts.ConnectionString = "localhost,connectTimeout=5000,allowAdmin=false,defaultDatabase=1";
- //});
- });
- services.AddMvc(opts => {
- // 这里添加 ApiThrottleActionFilter 拦截器
- opts.Filters.Add(typeof(ApiThrottleActionFilter));
- }).SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
- }
- public void Configure(IApplicationBuilder app, IHostingEnvironment env)
- {
- ...
- //Api 限流
- app.UseApiThrottle();
- app.UseMvc();
- }
给 Api 添加一个限流阀门(Valve)
- ValuesController.cs:
- // GET api/values
- [HttpGet]
- [RateValve(Policy = Policy.Ip, Limit = 10, Duration = 30)]
- public ActionResult<IEnumerable<string>> Get()
- {
- return new string[] { "value1", "value2" };
- }
以上特性代表给 Get 接口添加一个速率阀门, 指定每个 IP,30 秒内最多调用 10 次该接口.
通过以上配置, 最简单的一个接口限流就完成了.
当 Api 被拦截时, 接口不会执行, context.Result 会返回一个
new ApiThrottleResult { Content = "访问过于频繁, 请稍后重试!" }
, ApiThrottleResult 继承于 ContentResult, 你可以不继续处理, 也可以在自己的 ResultFilter 中拦截 ApiThrottleResult 并处理.
更多 Valve 范例
[RateValve(Policy = Policy.UserIdentity, Limit = 1, Duration = 60)]
代表根据用户身份, 每 60 秒可访问 1 次该接口. 关于用户身份, 默认是如下取得的:
return context.User?.FindFirst(ClaimTypes.NameIdentifier)?.Value;
如果需要自定义, 则可以在 Startup.cs 中如下配置:
- //Api 限流
- services.AddApiThrottle(options => {
- ...
- options.OnUserIdentity = (httpContext) =>
- {
- // 这里根据自己需求返回用户唯一身份
- return httpContext.User?.FindFirst(ClaimTypes.NameIdentifier)?.Value;
- };
- ...
- });
- [RateValve(Policy = Policy.Header, PolicyKey = "hkey", Limit = 1, Duration = 30, WhenNull = WhenNull.Intercept)]
代表根据 Request Header 中 hkey 对应的值, 每 30 秒可访问 1 次该接口. 如果无法取得 Header 中的值或取得的值为空, 则进行拦截.
关于 WhenNull:
WhenNull = WhenNull.Pass
: 对应策略取得的识别值为空时, 不进行拦截.
WhenNull = WhenNull.Intercept
: 对应策略取得的识别值为空时, 进行拦截.
[RateValve(Policy = Policy.Query, PolicyKey = "mobile", Limit = 1, Duration = 30, WhenNull = WhenNull.Pass)]
代表根据 Request Query 中 mobile 对应的值, 每 30 秒可访问 1 次该接口. 如果无法取得识别值或取得的值为空, 则不进行拦截.
[BlackListValve(Policy = Policy.Query, PolicyKey = "mobile")]
黑名单拦截, 代表根据 Request Query 中 mobile 对应的值, 如果在黑名单中, 则进行拦截. 关于如何添加黑名单, 请参照后面关于 IApiThrottleService 部分.
[WhiteListValve(Policy = Policy.Ip)]
白名单拦截, 代表根据客户端 IP 地址, 如果在白名单中, 则不进行拦截(如果同一个 Api 上有多个 Valve, 按序当检查到白名单符合时, 则代表检查通过, 不进行后续 Valve 的拦截检查). 关于如何添加白名单, 请参照后面关于 IApiThrottleService 部分.
一个 Api 多个 Valve
- // POST api/values
- [HttpPost]
- [WhiteListValve(Policy = Policy.Ip, Priority = 3)]
- [BlackListValve(Policy = Policy.UserIdentity, Priority = 2)]
- [RateValve(Policy = Policy.Header, PolicyKey = "hkey", Limit = 1, Duration = 30, WhenNull = WhenNull.Pass)]
- public void Post([FromBody] string value)
- {
- }
多个 Valve 根据 Priority 值从大到小进行拦截, 如果被拦截, 则不进行后续 Valve 拦截检查.
全局限流配置
以上都是对单个 Api 进行限流管理的, 如果需要对全局进行限流管理, 可在 `Startup.cs` 中进行如下配置:
- //Api 限流
- services.AddApiThrottle(options => {
- ...
- options.Global.AddValves(new BlackListValve
- {
- Policy = Policy.Ip,
- Priority = 99
- }, new WhiteListValve
- {
- Policy = Policy.UserIdentity,
- Priority = 88
- },
- new BlackListValve
- {
- Policy = Policy.Header,
- PolicyKey = "throttle"
- }, new RateValve
- {
- Policy = Policy.Ip,
- Limit = 5,
- Duration = 10,
- WhenNull = WhenNull.Pass
- });
- ...
- });
以上代表给全局添加了 4 个 Valve 进行拦截, 如果被拦截, 则不进行后续操作.
白名单检查通过时, 代表全局拦截通过, 不进行后续全局 Valve 检查(后续单独 Api 的检查还会进行).
相同识别策略 (Policy+PolicyKey) 的 Valve 只能添加一个, 重复不会添加.
全局限流拦截在 Middlewarez 中进行, 单独 Api 限流拦截在 IAsyncActionFilter 中进行, 当然也支持 Razor Page, 在 IAsyncPageFilterz 中进行限流.
其他自定义配置项
自定义 IP 地址取得方法:
- //Api 限流
- services.AddApiThrottle(options => {
- ...
- // 以下是 Dnc.Api.Throttle 默认取得 Ip 地址的方法, 可进行自定义
- options.OnIpAddress = (context) => {
- var ip = context.Request.Headers["X-Forwarded-For"].FirstOrDefault();
- if (string.IsNullOrEmpty(ip))
- {
- ip = context.Connection.RemoteIpAddress.ToString();
- }
- return ip;
- };
- ...
- });
自定义拦截后处理:
- //Api 限流
- services.AddApiThrottle(options => {
- ...
- options.onIntercepted = (context, valve, where) =>
- {
- //valve: 引发拦截的 valve
- //where: 拦截发生的地方, 有 ActionFilter,PageFilter,Middleware(全局)
- if (where == IntercepteWhere.Middleware)
- {
- // 注意: Middleware 中返回的 ActionResult 无法在 ResultFilter 中拦截处理.
- return new JsonResult(new { code = 99, message = "访问过于频繁, 请稍后重试!" });
- }
- else
- {
- return new ApiThrottleResult { Content = "访问过于频繁, 请稍后重试!" };
- }
- };
- ...
- });
- IApiThrottleService
使用 IApiThrottleService 接口可实现黑名单, 白名单的管理维护等其他功能.
使用范例:
- /// <summary>
- /// Api 限流管理服务
- /// </summary>
- private readonly IApiThrottleService _service;
- public ValuesController(IApiThrottleService service)
- {
- _service = service;
- }
- [HttpPost]
- [BlackListValve(Policy = Policy.Ip)]
- public async Task AddBlackList()
- {
- var ip = GetIpAddress(HttpContext);
- // 添加 IP 黑名单
- await _service.AddRosterAsync(RosterType.BlackList,
- "WebApiTest.Controllers.ValuesController.AddBlackList",
- Policy.Ip, null, TimeSpan.FromSeconds(60), ip);
- }
- /// <summary>
- /// 取得客户端 IP 地址
- /// </summary>
- private static string GetIpAddress(HttpContext context)
- {
- var ip = context.Request.Headers["X-Forwarded-For"].FirstOrDefault();
- if (string.IsNullOrEmpty(ip))
- {
- ip = context.Connection.RemoteIpAddress.ToString();
- }
- return ip;
- }
AddBlackList 中针对 WebApiTest.Controllers.ValuesController.AddBlackList 方法添加了一个有效期 60 的 IP 黑名单, 当前 IP 调用该接口会被 IP 黑名单拦截.
IApiThrottleService 现有接口:
- #region 黑名单 & 白名单
- /// <summary>
- /// 添加名单
- /// </summary>
- /// <param name="rosterType">名单类型</param>
- /// <param name="api">Api</param>
- /// <param name="policy">策略</param>
- /// <param name="policyKey">策略 Key</param>
- /// <param name="expiry">过期时间</param>
- /// <param name="item">项目</param>
- Task AddRosterAsync(RosterType rosterType, string api, Policy policy, string policyKey, TimeSpan? expiry, params string[] item);
- /// <summary>
- /// 删除名单中数据
- /// </summary>
- /// <param name="rosterType">名单类型</param>
- /// <param name="api">API</param>
- /// <param name="policy">策略</param>
- /// <param name="policyKey">策略 Key</param>
- /// <param name="expiry">过期时间</param>
- /// <param name="item">项目</param>
- Task RemoveRosterAsync(RosterType rosterType, string api, Policy policy, string policyKey, params string[] item);
- /// <summary>
- /// 取得名单列表(分页)
- /// </summary>
- /// <param name="rosterType">名单类型</param>
- /// <param name="api">API</param>
- /// <param name="policy">策略</param>
- /// <param name="policyKey">策略 Key</param>
- Task<(long count, IEnumerable<ListItem> items)> GetRosterListAsync(RosterType rosterType, string api, Policy policy, string policyKey, long skip, long take);
- /// <summary>
- /// 取得名单列表
- /// </summary>
- /// <param name="rosterType">名单类型</param>
- /// <param name="api">API</param>
- /// <param name="policy">策略</param>
- /// <param name="policyKey">策略 Key</param>
- Task<IEnumerable<ListItem>> GetRosterListAsync(RosterType rosterType, string api, Policy policy, string policyKey);
- /// <summary>
- /// 添加全局名单
- /// </summary>
- /// <param name="rosterType">名单类型</param>
- /// <param name="policy">策略</param>
- /// <param name="policyKey">策略 Key</param>
- /// <param name="expiry">过期时间</param>
- /// <param name="item">项目</param>
- Task AddGlobalRosterAsync(RosterType rosterType, Policy policy, string policyKey, TimeSpan? expiry, params string[] item);
- /// <summary>
- /// 移除全局名单
- /// </summary>
- /// <param name="policy">策略</param>
- /// <param name="item">项目</param>
- Task RemoveGlobalRosterAsync(RosterType rosterType, Policy policy, string policyKey, params string[] item);
- /// <summary>
- /// 取得全局名单列表(分页)
- /// </summary>
- /// <param name="rosterType">名单类型</param>
- /// <param name="policy">策略</param>
- /// <param name="policyKey">策略 Key</param>
- Task<(long count, IEnumerable<ListItem> items)> GetGlobalRosterListAsync(RosterType rosterType, Policy policy, string policyKey, long skip, long take);
- /// <summary>
- /// 取得全局名单列表
- /// </summary>
- /// <param name="rosterType">名单类型</param>
- /// <param name="policy">策略</param>
- /// <param name="policyKey">策略 Key</param>
- Task<IEnumerable<ListItem>> GetGlobalRosterListAsync(RosterType rosterType, Policy policy, string policyKey);
- #endregion
- Github:https://github.com/kulend/Dnc.Api.Throttle
- NuGet:https://www.nuget.org/packages/Dnc.Api.Throttle
来源: https://www.cnblogs.com/kulend/p/9435095.html