.Net Core緩存組件(MemoryCache)源碼解析

一、介紹由於CPU從記憶體中讀取數據的速度比從磁碟讀取快幾個數量級，並且存在記憶體中，減小了資料庫訪問的壓力，所以緩存幾乎每個項目都會用到。一般常用的有MemoryCache、Redis。MemoryCache將存入的對象都作為Object對象存儲，Redis分為四種類型存儲，在微軟提供的緩存組件中也 ...

一、介紹

　　由於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