.net core 使用 AspectCore 實現簡易的AopCache。

（第一次寫博客，好緊張！！！）

源碼地址：傳送門

項目中有很多緩存的需求，能自己定義緩存key和時間，能根據key去清理緩存。

網上找了一圈，有很多基於aop的緩存組件，但是都不滿足我的需求。故造了個輪子。

新建web項目 .net core mvc TestAopCache

安裝 AopCache

Install-Package AopCache -Version 0.1.1

屬性說明

AopCache一共3個屬性：

Key：緩存的鍵值，字元串，可以包含占位符 如 {userId}。如果key為空，將用類名+方法名作為鍵值

Type：表示時間類型，枚舉。秒、分、小時、天 四種。預設秒

Length：時間長度，0 表示永不過去。預設 0

標記方式有兩種

1、在介面的方法上加 [AopCache]

2、沒有介面，直接在類的方法上加 [AopCache]，前提是此方法必須用 virtual修飾

存儲方式

預設是 MemoryCache，不過你可以實現 IAopCacheProvider 介面，實現自己的存儲。

新建 ITestService，在方法上加 [AopCache]

public interface ITestService
     {
         //預設時間單位是秒，長度為0，即永不過期
         [AopCache(Key = "aaa")]
         string GetByKey();

        //設置3秒過期 這裡的“{userId}”，占位符。用參數 userId 的值去替換
         [AopCache(Key = "bbb_{userId}", Length = 3)]
         string GetByKeyAndParamter(int userId);

        //設置十分鐘過期 這裡的“{req:Id}”，占位符。用參數 req裡面的Id 的值去替換
         [AopCache(Key = "ccc_{req:Id}_{type}", Type = CacheTimeType.Minute, Length = 10)]
         Task<UserInfo> GetUserInfo(int type, Req req);
     }

//實現介面

public class TestService : ITestService
     {
         public string GetByKey()
         {
             return Guid.NewGuid().ToString("N");
         }

        public string GetByKeyAndParamter(int userId)
         {
             return Guid.NewGuid().ToString("N") + "---" + userId;
         }

        public async Task<UserInfo> GetUserInfo(int type, Req req)
         {
             return new UserInfo()
             {
                 Id = new Random().Next(1, 100),
                 Name = Guid.NewGuid().ToString("N")
             };
         }
     }

直接在類的方法上加標簽

public class TestSingleClass
    {
        [AopCache(Key = "TestSingleClassKey")]
        public virtual string Get()
        {
            return Guid.NewGuid().ToString("N");
        }
    }

Startup中配置註入

public IServiceProvider ConfigureServices(IServiceCollection services)
        {
            services.Configure<CookiePolicyOptions>(options =>
            {
                //...


            //註入打了標簽的Service
            services.AddTransient<ITestService, TestService>();
            services.AddTransient<TestSingleClass>();


            //自定義存儲 這裡xxx表示 IAopCacheProvider 的實現            
            //services.AddAopCache<xxx>();    


            //預設記憶體存儲
            //返回IServiceProvider，由 AspectCore接管
            return services.AddAopCacheUseDefaultMemoryProvider();

            //此方法的內部實現，這裡包裝一層
            //if (setupAction == null)
            //{
            //    services.AddMemoryCache();
            //}
            //else
            //{
            //    services.AddMemoryCache(setupAction);
            //}
            //services.AddSingleton<IAopCacheProvider, DefaultAopCacheProvider>();
            //services.ConfigureDynamicProxy();
            //return services.BuildAspectInjectorProvider();
        }

直接在HomeController 中使用

public class HomeController : Controller
    {
        private ITestService TestService { get; set; }

        private TestSingleClass TestSingleClass { get; set; }

        private IAopCacheProvider AopCacheProvider { get; set; }

        public HomeController(ITestService testService, TestSingleClass testSingleClass, IAopCacheProvider aopCacheProvider)
        {
            TestService = testService;

            TestSingleClass = testSingleClass;

            AopCacheProvider = aopCacheProvider;
        }


        public IActionResult Index()
        {
            //在這裡清除某個key
            //清除 GetUserInfo
            AopCacheProvider.Remove("ccc_1000_1");

            return View();
        }

        public async Task<IActionResult> Privacy()
        {
            //第一次獲取值 生成的key是  aaa
            var v1 = TestService.GetByKey();

            //生成的key是 bbb_1，占位符被替換：bbb_{userId} => bbb_1  
            var v2 = TestService.GetByKeyAndParamter(1);

            //生成的key是 ccc_1000_1，占位符被替換：ccc_{req:Id}_{type} => ccc_1000_1
            var v3 = await TestService.GetUserInfo(1, new Req() { Id = 1000 });


            //直接在類的方法上加標記，但是方法必須加 virtual
            //生成的key是  TestSingleClassKey
            var v4 = TestSingleClass.Get();


            //第二次獲取值
            var v1New = TestService.GetByKey();

            var v2New = TestService.GetByKeyAndParamter(1);

            var v3New = await TestService.GetUserInfo(1, new Req() { Id = 1000 });

            var v4New = TestSingleClass.Get();


            var sb = new StringBuilder();
            sb.AppendLine($"GetByKey（永不過期）：第一次=> {v1}");
            sb.AppendLine($"GetByKey（永不過期）：第二次=> {v1New}");

            sb.AppendLine($"GetByKeyAndParamter（3秒）：第一次=> {v2}");
            sb.AppendLine($"GetByKeyAndParamter（3秒）：第二次=> {v2New}");

            sb.AppendLine($"GetUserInfo（十分鐘）：第一次=> {Newtonsoft.Json.JsonConvert.SerializeObject(v3)}");
            sb.AppendLine($"GetUserInfo（十分鐘）：第二次=> {Newtonsoft.Json.JsonConvert.SerializeObject(v3New)}");

            sb.AppendLine($"TestSingleClass.Get（永不過期）：第一次=> {v4}");
            sb.AppendLine($"TestSingleClass.Get（永不過期）：第二次=> {v4New}");

            return Content(sb.ToString());
        }

        [ResponseCache(Duration = 0, Location = ResponseCacheLocation.None, NoStore = true)]
        public IActionResult Error()
        {
            return View(new ErrorViewModel { RequestId = Activity.Current?.Id ?? HttpContext.TraceIdentifier });
        }
    }

F5運行

點擊 “Privacy”，瘋狂刷新，查看效果。

切換迴首頁，清除 GetUserInfo 的緩存，再切換到Privacy，發現 GetUserInfo 的緩存已改變。

到此結束，如果你剛好有這需求，可以參考此文章。源碼傳到gayhub，求輕拍 ==