MVC WebAPI Action缓存类

最新推荐文章于 2026-07-03 12:11:22 发布

原创最新推荐文章于 2026-07-03 12:11:22 发布 · 1.1k 阅读

0 ·

本内容遵循CC 4.0 BY-SA版权协议

收录于

.net技术

本文介绍了一种基于ASP.NET Web API的缓存过滤器实现方式，该过滤器能够根据请求方法、用户认证状态等因素智能地决定是否启用缓存，并设置合适的缓存过期时间。

using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Runtime.Caching;
using System.Threading;
using System.Web;
using System.Web.Http.Controllers;
using System.Web.Http.Filters;
using HB.Common;

namespace HB.Management.WebApi
{
    /// <summary>
    /// 缓存过滤器
    /// </summary>
    public class ManagementCacheFilter : ActionFilterAttribute
    {
        // 缓存时间 /秒
        private int _timespan;
        // 客户端缓存时间 /秒
        private int _clientTimeSpan;
        // 是否为匿名用户缓存
        private bool _anonymousOnly;
        // 缓存索引键
        private string _cachekey;
        // 缓存仓库
        private static readonly ObjectCache WebApiCache = MemoryCache.Default;


        /// <summary>
        /// 
        /// </summary>
        /// <param name="timespan"></param>
        /// <param name="clientTimeSpan"></param>
        /// <param name="anonymousOnly"></param>
        public ManagementCacheFilter(int timespan, int clientTimeSpan, bool anonymousOnly)
        {
            _timespan = timespan;
            _clientTimeSpan = clientTimeSpan;
            _anonymousOnly = anonymousOnly;
        }

        //是否缓存
        private bool _isCacheable(HttpActionContext ac)
        {
            if (_timespan > 0 && _clientTimeSpan > 0)
            {
                if (_anonymousOnly)
                    if (Thread.CurrentPrincipal.Identity.IsAuthenticated)
                        return false;
                if (ac.Request.Method == HttpMethod.Post) return true;
            }
            else
            {
                throw new InvalidOperationException("Wrong Arguments");
            }
            return false;
        }

        private CacheControlHeaderValue SetClientCache()
        {
            var cachecontrol = new CacheControlHeaderValue
            {
                MaxAge = TimeSpan.FromSeconds(_clientTimeSpan),
                MustRevalidate = true
            };
            return cachecontrol;
        }


        /// <summary>
        /// Action调用前执行的方法
        /// </summary>
        /// <param name="ac"></param>
        public override void OnActionExecuting(HttpActionContext ac)
        {
            if (ac != null)
            {
                if (_isCacheable(ac))
                {
                    HttpContextBase context = (HttpContextBase)ac.Request.Properties["MS_HttpContext"];//获取传统context
                    HttpRequestBase request = context.Request;//定义传统request对象       
                    _cachekey = string.Join(":", request.FilePath, request.Form.ToPostString());
                    if (WebApiCache.Contains(_cachekey))
                    {
                        var val = (string)WebApiCache.Get(_cachekey);
                        if (val != null)
                        {
                            ac.Response = ac.Request.CreateResponse();
                            ac.Response.Content = new StringContent(val);
                            var contenttype = (MediaTypeHeaderValue)WebApiCache.Get(_cachekey + ":response-ct") ??
                                              new MediaTypeHeaderValue(_cachekey.Split(':')[1]);
                            ac.Response.Content.Headers.ContentType = contenttype;
                            ac.Response.Headers.CacheControl = SetClientCache();
                            return;
                        }
                    }
                }
            }
            else
            {
                throw new ArgumentNullException("ac");
            }
        }


        /// <summary>
        /// Action调用后执行方法
        /// </summary>
        /// <param name="actionExecutedContext"></param>
        public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
        {
            if (_cachekey != null && !WebApiCache.Contains(_cachekey))
            {
                var body = actionExecutedContext.Response.Content.ReadAsStringAsync().Result;
                WebApiCache.Add(_cachekey, body, DateTime.Now.AddSeconds(_timespan));
                WebApiCache.Add(_cachekey + ":response-ct", actionExecutedContext.Response.Content.Headers.ContentType, DateTime.Now.AddSeconds(_timespan));
            }
            if (_isCacheable(actionExecutedContext.ActionContext))
                actionExecutedContext.ActionContext.Response.Headers.CacheControl = SetClientCache();
        }
    }
}

使用案例：

        [ManagementCacheFilter(60, 120, false)]
        public Common.OperateResult<List<SelectResponse>> GetProvinceForSelect(CommonRequest request)
        {
            return result;
        }