Dnc.Api.Throttle

適用於Dot Net Core的WebApi介面限流框架

使用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