api接口訪問限制

1.場景描述

     在日常開發接口的時候，尤其是restfull接口，肯定會考慮安全或者是做一些自定義的限制，用來界定並維護代碼。那么，我們都會采用什么方法那？通常來講，我們可以通過session的形式，以訪問者的ip為鍵來記錄用戶對某接口訪問的次數，並對其作出限制。在.net中還可以將session或者是MemoryCache來替換session來實現（另外也可以用第三方nosql：如redis、Mongodb等）。本文結合redis予以實現。

2.實現分析

     通常來說，我們會可以在每一個需要被限制的接口使用redis來存儲記錄當前來訪客戶端訪問的次數，這樣，便可以實現我們想要的效果。但是，少啦可以，如果說，日后很多接口都需要限制該怎么辦吶，我們該如何去整理並統籌規划吶？答案就是：可以采用Action過濾器標簽的的形式，這樣，我們只需封裝這樣可以限制訪問的一個公用的過濾器標簽，在需要被限制的地方加上標簽，便可以得到我們想要的效果。廢話不多說，直接上代碼！！！

public class ApiLimitFilter : ActionFilterAttribute
    {
        #region 可配參數
        //標識前綴（唯一）
        private string redisKeyPrefix;
        public string RedisKeyPrefix
        {
            get
            {
                if (string.IsNullOrEmpty(redisKeyPrefix))
                {
                    redisKeyPrefix = "Api_limit";
                }

                return redisKeyPrefix;
            }
            set { redisKeyPrefix = value; }
        }
        //顯示時間長度
        private TimeSpan? timeSpan { get; set; }
        public TimeSpan? TimeSpan
        {
            get
            {
                if (timeSpan == null)
                {
                    timeSpan = System.TimeSpan.FromDays(1);
                }
                return timeSpan;
            }
            set { timeSpan = value; }
        }
        //顯示次數
        private int limitCount;
        public int LimitCount
        {
            get
            {
                if (limitCount <= 0)
                {
                    limitCount = 5;
                }

                return limitCount;
            }
            set { limitCount = value; }
        }
        //提示語
        private string notify;
        public string Notify
        {
            get
            {
                if (string.IsNullOrEmpty(notify))
                {
                    notify = "請求受限";
                }

                return notify;
            }
            set { notify = value; }
        }
        #endregion
        #region 內部私用
        private string RedisKey
        {
            get { return string.Format("{0}_{1}", redisKeyPrefix, IpUtil.GetHostAddress()); }
        }
        private int currentCount = 0;
        #endregion
        #region Limit
        /// <summary>
        /// 限制過濾
        /// </summary>
        /// <param name="actionContext"></param>
        public override void OnActionExecuting(HttpActionContext actionContext)
        {
            //獲取接口訪問次數（redis封裝的工具類/可切換自己想要的東西）
            currentCount = RedisCacheHelper.Instance.Get<int>(RedisKey);
            if (currentCount > LimitCount)
            {
                var resultModel = new ResultModel(200, Notify);
                actionContext.Response=actionContext.Request.CreateResponse(HttpStatusCode.OK, resultModel);
             
            }
            base.OnActionExecuting(actionContext);
        }
        /// <summary>
        /// 限制追記
        /// </summary>
        /// <param name="actionExecutedContext"></param>
        public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
        {
            currentCount++;
            //記住訪問痕跡（redis封裝的工具類/可切換自己想要的東西）
            RedisCacheHelper.Instance.Set(RedisKey, currentCount, TimeSpan);
            base.OnActionExecuted(actionExecutedContext);
        }
        #endregion
    }