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
    }