.Net Core快取元件(MemoryCache)原始碼解析

MicroHeart!發表於2018-08-13

一、介紹

  由於CPU從記憶體中讀取資料的速度比從磁碟讀取快幾個數量級,並且存在記憶體中,減小了資料庫訪問的壓力,所以快取幾乎每個專案都會用到。一般常用的有MemoryCache、Redis。MemoryCache將存入的物件都作為Object物件儲存,Redis分為五種型別儲存,在微軟提供的快取元件中也包含Redis和SQL Server快取,具體下次文章詳細講解。微軟快取元件原始碼在https://github.com/aspnet/Caching

二、簡單使用

  元件的使用很簡單,只需要新增元件,在需要使用的時候,注入快取元件。下面為一個簡單的例子,新建Api專案,修改為下面程式碼

public void ConfigureServices(IServiceCollection services)
{
      services.AddMvc();
      services.AddMemoryCache();//新增MemoryCache元件
}

記憶體快取過期時間有3種,絕對過期時間、相對現在的過期時間和滑動過期時間。

public class ValuesController : Controller
    {
        private readonly IMemoryCache _memoryCache;//注入MemoryCache
        public ValuesController(IMemoryCache memoryCache)
        {
            this._memoryCache = memoryCache;
        }

        [HttpGet]
        public async Task<IEnumerable<string>> Get()
        {
            //1、絕對過期時間 
            _memoryCache.Set("key1", "1", new DateTimeOffset(new DateTime(2018, 8, 11)));
            //2、相對於現在的過期時間 快取相對於現在的時間後兩秒失效
            _memoryCache.Set("key2", "2", new TimeSpan(0, 0, 2));
            //3、滑動過期時間  快取在兩秒內沒有被命中,則失效,命中後快取時間又變為2秒
            _memoryCache.Set("key3", "3", new MemoryCacheEntryOptions()
            {
                SlidingExpiration = new TimeSpan(0, 0, 2),
                Priority = CacheItemPriority.NeverRemove
            });
        
            Thread.Sleep(1500);
            Console.WriteLine($@"value1:{_memoryCache.Get("key1")} value2:{_memoryCache.Get("key2")} value3:{_memoryCache.Get("key3")}");
            //因為在1.5秒被命中 所以key3的值,快取時間重新變為2秒
            Thread.Sleep(1500);
            Console.WriteLine($@"value1:{_memoryCache.Get("key1")} value2:{_memoryCache.Get("key2")} value3:{_memoryCache.Get("key3")}");
       //建立一個相對現在時間2秒的快取ke4,並註冊快取失效時的回撥函式(注意此回撥函式並不是真的當快取失效立馬呼叫,看下面原始碼詳解)
             _memoryCache.GetOrCreate("key4", cacheEntry =>
               {
                   cacheEntry.AbsoluteExpirationRelativeToNow = new TimeSpan(0, 0, 2);
                   cacheEntry.RegisterPostEvictionCallback(Test);//註冊快取過期時的回撥函式
                   return cacheEntry.Value = "4";
               });
            Thread.Sleep(3000);
            _memoryCache.Remove("key4");

            return new string[] { "value1", "value2" };
        }
        //當快取過期時觸發此函式
        public void Test(object key, object value, EvictionReason reason, object state)
        {
            Console.WriteLine($@"快取{key}已經移除");
        }
    }

 輸出結果為:

value1:1 value2:2 value3:3
value1:1 value2:   value3:3  // 注意此處的value2的值為空
快取key4已經移除

  關於絕對過期時間、相對現在的過期時間、滑動過期時間就不必多說了,上面註釋已經寫了。需要注意的是上面key4,設定了2秒後快取過期,觸發回撥函式,但是如果程式碼改為下面形式(註釋掉移除”key4”的程式碼),那麼會一直不觸發回撥函式。

 _memoryCache.GetOrCreate("key4", cacheEntry =>
 {
         cacheEntry.AbsoluteExpirationRelativeToNow = new TimeSpan(0, 0, 2);
         cacheEntry.RegisterPostEvictionCallback(Test);//註冊快取過期時的回撥函式
         return cacheEntry.Value = "4";
 });
  Thread.Sleep(3000);
  //_memoryCache.Remove("key4");

比如上面已經sleep 3秒了,key4的快取時間為2秒,key4快取的已經過期了,如果刪除那一行程式碼,按理應該在第二秒是觸發回撥函式,但是測試不會。只有對key4操作的時候才會觸發回撥函式(後面原始碼詳細分析)。

在MemoryCache類中有CreateEntry,這個方法比較特殊

var entry = _memoryCache.CreateEntry("key5");
entry.Value = "5";
var a = _memoryCache.Get("key5");//這裡輸出為null,並不是我們想象的值

正確的使用方法為:需要entry.Dispose()或者使用using。(具體原因下面原始碼分析)

var entry = _memoryCache.CreateEntry("key5"); 
entry.Value = "5";
entry.Dispose();
var a = _memoryCache.Get("key5");//輸出為5

 三、MemoryCache原始碼解析

  首先看我們在Startup中宣告新增的記憶體快取的對應的原始碼。 

   services.AddMemoryCache();//新增MemoryCache元件
public static IServiceCollection AddMemoryCache(this IServiceCollection services)
{
      if (services == null)
      {
           throw new ArgumentNullException(nameof(services));
      }

      services.AddOptions();
    //實際上就是注入一個單例的MemoryCache services.TryAdd(ServiceDescriptor.Singleton
<IMemoryCache, MemoryCache>()); return services; }

MemoryCacheOptions類:主要是配置一些引數

  ExpirationScanFrequency:此欄位表明隔一段時間掃描快取,移除過期快取,預設頻率為一分鐘。

  SizeLimit:設定快取的大小。

  CompactionPercentage:壓縮比例 預設為百分之五。

舉例:

 public void ConfigureServices(IServiceCollection services)
 {
       services.AddMvc();
       services.AddMemoryCache(x =>
       {
            x.ExpirationScanFrequency = new TimeSpan(0, 0, 3);//設定掃描頻率為3分鐘
            x.SizeLimit = 500 * 1024 * 1024; //大小為500M
        });
 }

MemoryCache類:

  ConcurrentDictionary<object, CacheEntry> _entries:一個多執行緒安全的字典型別,其實快取的本質就是這個字典,將所有快取都放入這個字典中,然後通過字典的key(字典的key其實和快取實體CacheEntry的key值一樣)獲取CacheEntry實體(CacheEntry實體包含key和value,也就是我們程式碼中設定的key和value)。

  _expirationScanFrequency:Span型別,表示掃描過期快取的頻率時間,此欄位的值來自MemoryCacheOptions類的ExpirationScanFrequency。需要注意的是:假如設定為一分鐘掃描一次快取集合,這個掃描不是主動掃描的,只有當對快取集合操作時才會掃描。比如增刪改查快取集合的時候,會判斷上一次掃描的時間離現在過去多久了,如果超過掃描設定的時間,才會掃描。原始碼如下:

    private void StartScanForExpiredItems()//掃描函式。在新增、查詢、刪除、修改快取的時候,會呼叫此方法掃描過濾過期快取,並不是主動隔一段時間執行
        {
            var now = _clock.UtcNow;
            if (_expirationScanFrequency < now - _lastExpirationScan)//判斷現在的時間和最後一次掃描時間,是不是大於設定的時間段
            {
                _lastExpirationScan = now;
                Task.Factory.StartNew(state => ScanForExpiredItems((MemoryCache)state), this, CancellationToken.None, TaskCreationOptions.DenyChildAttach, TaskScheduler.Default);
            }
        }
        private static void ScanForExpiredItems(MemoryCache cache)
        {
            var now = cache._clock.UtcNow;
            foreach (var entry in cache._entries.Values)//然後遍歷字典集合,移除過期快取
            {
                if (entry.CheckExpired(now))
                {
                    cache.RemoveEntry(entry);
                }
            }
        }

  Action<CacheEntry> _setEntry:此委託就是將快取實體放入上面的字典_entries中,並將字典的key值設定為快取實體的key。

  Action<CacheEntry> _entryExpirationNotification:此委託是移除字典中快取。

CacheEntry類:這個類主要就是儲存快取實體,它包含的key、value欄位就是我們程式中傳入的key、value。對於每一個快取實體都有其過期時間,所以它還包含每種過期型別。它還包含2個重要的委託。

  Action<CacheEntry> _notifyCacheOfExpiration:此委託會在建構函式中被MemoryCache類中的SetEntry(CacheEntry entry)方法賦值。方法的實現將CacheEntry實體放入MemoryCache類字典中,也就是放入快取中。

  Action<CacheEntry> _notifyCacheEntryDisposed:此委託會在建構函式中被MemoryCache類中的EntryExpired(CacheEntry entry)方法賦值,方法的實現是移除快取。

  還包含CacheItemPriority型別的Priority,表示當記憶體不足時,會移除部分記憶體,會按照由低到高移除。所以當設定的某個快取實體使用次數較多時,可以設定為High或NeverRemove。預設設定為Normal。

 public enum CacheItemPriority
    {
        Low,
        Normal,
        High,
        NeverRemove,
    }

   需要注意的是CacheEntry有一個重要的方法Dispose(),因為它繼承IDisposable,在Dispost方法中呼叫了_notifyCacheEntryDisposed委託。

public void Dispose()
{
      if (!_added)
      {
          _added = true;
          _scope.Dispose();
          _notifyCacheEntryDisposed(this);//在此呼叫委託,而此委託是被MemoryCache類中的SetEntry賦值。目的是將CacheEntry實體放入MemoryCache類的字典中,也就是放入快取中。
          PropagateOptions(CacheEntryHelper.Current);
      }
}

這就解釋了為我們上面舉的例子需要Dispose(),它只有呼叫Dispose()才能將快取實體放入字典中。

var entry = _memoryCache.CreateEntry("key5"); 
entry.Value = "5";
entry.Dispose();
var a = _memoryCache.Get("key5");//輸出為5

相關文章