快捷導(dǎo)航

.NET?MemoryCache如何清除全部緩存

更新時(shí)間：2021年12月22日 10:35:39 作者：Agile.Zhou

本文主要介紹了.NET?MemoryCache如何清除全部緩存，文中通過示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下

最近有個(gè)需求需要定時(shí)清理服務(wù)器上所有的緩存。本來以為很簡(jiǎn)單的調(diào)用一下 MemoryCache.Clear 方法就完事了。誰知道 MemoryCache 類以及 IMemoryCache 擴(kuò)展方法都沒有 Clear 方法。這可給難住了，于是想找到所有的 Keys 來一個(gè)個(gè) Remove ，誰知道居然也沒有獲取所有 Key 的方法。于是研究了一下，找到一些方法，下面介紹兩個(gè)方法：

自定義 CacheWrapper 包裝類

MemoryCache 構(gòu)造 Entry 的時(shí)候支持傳入 CancellationChangeToken 對(duì)象，當(dāng) CancellationChangeToken.Cancel 觸發(fā)的時(shí)候會(huì)自動(dòng)使該對(duì)象過期。那么我們只要對(duì) MemoryCache 類包裝一下很容易實(shí)現(xiàn)一個(gè)自己的 Cache 類。

 public class CacheWrapper
    {
        private readonly IMemoryCache _memoryCache;
        private CancellationTokenSource _resetCacheToken = new();

        public CacheWrapper(IMemoryCache memoryCache)
        {
            _memoryCache = memoryCache;
        }

        public void Add(object key, object value, MemoryCacheEntryOptions memoryCacheEntryOptions)
        {
            using var entry = _memoryCache.CreateEntry(key);
            entry.SetOptions(memoryCacheEntryOptions);
            entry.Value = value;

            // add an expiration token that allows us to clear the entire cache with a single method call
            entry.AddExpirationToken(new CancellationChangeToken(_resetCacheToken.Token));
        }

        public object Get(object key)
        {
            return _memoryCache.Get(key);
        }

        public void Remove(object key)
        {
            _memoryCache.Remove(key);
        }

        public void Clear()
        {
            _resetCacheToken.Cancel(); // this triggers the CancellationChangeToken to expire every item from cache

            _resetCacheToken.Dispose(); // dispose the current cancellation token source and create a new one
            _resetCacheToken = new CancellationTokenSource();
        }
    }

然后單元測(cè)試測(cè)試一下：

        [TestMethod()]
        public void ClearTest()
        {
            var memCache = new MemoryCache(new MemoryCacheOptions());
            var wrapper = new CacheWrapper(memCache);

            for (int i = 0; i < 10; i++)
            {
                wrapper.Add(i.ToString(), new object(), new MemoryCacheEntryOptions());
            }

            Assert.IsNotNull(wrapper.Get("1"));
            Assert.IsNotNull(wrapper.Get("9"));

            wrapper.Clear();

            for (int i = 0; i < 10; i++)
            {
                Assert.IsNull(wrapper.Get(i.ToString()));
            }

            for (int i = 0; i < 10; i++)
            {
                wrapper.Add(i.ToString(), new object(), new MemoryCacheEntryOptions());
            }

            Assert.IsNotNull(wrapper.Get("1"));
            Assert.IsNotNull(wrapper.Get("9"));

            wrapper.Clear();

            for (int i = 0; i < 10; i++)
            {
                Assert.IsNull(wrapper.Get(i.ToString()));
            }

        }

測(cè)試通過。

Compact 方法

以上 CacheWrapper 類雖然可以實(shí)現(xiàn)我們想要的功能，但是對(duì)于原來的程序有侵入，需要使用 CacheWrapper 類替換默認(rèn)的 MemoryCache 類，不是太好。于是不死心繼續(xù)研究，后來直接看了 MemoryCache 的代碼（源碼在這），開源真香。發(fā)現(xiàn) MemoryCache 有個(gè) Compact 方法好像在干刪除的勾當(dāng)。也怪我英文不好，這單詞是壓縮的意思，居然才發(fā)現(xiàn)。。。。于是我們的清除所有對(duì)象的需求不就輕而易舉了么？

 /// Remove at least the given percentage (0.10 for 10%) of the total entries (or estimated memory?), according to the following policy:
        /// 1. Remove all expired items.
        /// 2. Bucket by CacheItemPriority.
        /// 3. Least recently used objects.
        /// ?. Items with the soonest absolute expiration.
        /// ?. Items with the soonest sliding expiration.
        /// ?. Larger objects - estimated by object graph size, inaccurate.
MemoryCache.Compact(double percentage);

Compact 方法會(huì)對(duì)緩存的對(duì)象進(jìn)行壓縮，參數(shù)是個(gè)double，0.1 表示壓縮 10% ，那么傳 1.0 就是壓縮 100%，那不就是 Clear All 么。所以我可以使用 Compact(1.0) 來清除所有的緩存對(duì)象。單元測(cè)試跑一下：

[TestMethod()]
        public void CompactTest()
        {
            var memCache = new MemoryCache(new MemoryCacheOptions());

            for (int i = 0; i < 10; i++)
            {
                memCache.Set(i.ToString(), new object(), new MemoryCacheEntryOptions());
            }

            Assert.IsNotNull(memCache.Get("1"));
            Assert.IsNotNull(memCache.Get("9"));

            memCache.Compact(1);

            for (int i = 0; i < 10; i++)
            {
                Assert.IsNull(memCache.Get(i.ToString()));
            }

            for (int i = 0; i < 10; i++)
            {
                memCache.Set(i.ToString(), new object(), new MemoryCacheEntryOptions());
            }

            Assert.IsNotNull(memCache.Get("1"));
            Assert.IsNotNull(memCache.Get("9"));

            memCache.Compact(1);

            for (int i = 0; i < 10; i++)
            {
                Assert.IsNull(memCache.Get(i.ToString()));
            }
        }

完美通過。

這里簡(jiǎn)單介紹下 Compact 方法。根據(jù)注釋它會(huì)按照已下優(yōu)先級(jí)刪除對(duì)象：