.NET Core 2.0遷移技巧之MemoryCache問題修復

對於傳統的.NET Framework專案而言，System.Runtime.Caching名稱空間是常用的工具了，其中MemoryCache類則常被用於實現記憶體快取。

.NET Core 2.0暫時還不支援System.Runtime.Caching dll，這也就意味著MemoryCache相關程式碼不再起作用了。

但是好訊息是，我們可以使用.NET Core 2.0的新API實現記憶體快取功能，簡單修改程式碼，解決不相容問題。

 

解決方案

---

 

　　1.將舊程式碼匯入專案中，如下：

 

using System;
using System.Runtime.Caching;

namespace TestWebApp.Service
{
    public class MemoryCacheService
    {
        static ObjectCache cache = MemoryCache.Default;
        /// <summary>
        /// 獲取快取值
        /// </summary>
        /// <param name="key"></param>
        /// <returns></returns>
        private object GetCacheValue(string key)
        {
            if (key != null && cache.Contains(key))
            {
                return cache[key];
            }
            return default(object);
        }
        /// <summary>
        /// 新增快取內容
        /// </summary>
        /// <param name="key"></param>
        /// <param name="value"></param>
        public static void SetChacheValue(string key, object value)
        {
            if (key != null)
            {
                CacheItemPolicy policy = new CacheItemPolicy
                {
                    SlidingExpiration = TimeSpan.FromHours(1)
                    
                };
                cache.Set(key, value, policy);
            }
        }
    }
}

 

　　匯入後你會發現VS會提示無法找到System.Runtime.Caching名稱空間，原有的程式碼無法直接編譯使用。

 

　　2.新增對Microsoft.Extensions.Caching.Memory名稱空間的引用，它提供了.NET Core預設實現的MemoryCache類，以及全新的記憶體快取API

　　

using Microsoft.Extensions.Caching.Memory;

 

　　3.改寫程式碼，使用新的API實現記憶體快取功能

　　初始化快取物件方式改寫前：

static ObjectCache cache = MemoryCache.Default;

 

　　初始化快取物件方式改寫後：

static MemoryCache cache = new MemoryCache(new MemoryCacheOptions());

 

　　讀取記憶體快取值方式變化：

private object GetCacheValue(string key)
{
    if (key != null && cache.Contains(key))
    {
        return cache[key];
    }
    return default(object);
}

 

　　改寫後：

private object GetCacheValue(string key)
{
    object val = null;
    if (key != null && cache.TryGetValue(key, out val))
    {
        return val;
    }
    else
    {
        return default(object);
    }
}

 

　　設定記憶體快取內容方式變化：

public static void SetChacheValue(string key, object value)
{
    if (key != null)
    {
        CacheItemPolicy policy = new CacheItemPolicy
        {
            SlidingExpiration = TimeSpan.FromHours(1)
        };
        cache.Set(key, value, policy);
    }
}

 

　　修改後：

 public static void SetChacheValue(string key, object value)
{
    if (key != null)
    {
        cache.Set(key, value, new MemoryCacheEntryOptions
        {
            SlidingExpiration = TimeSpan.FromHours(1)
        });
    }
}

 

結論

---

 

在使用了Microsoft.Extensions.Caching.Memory下的新API改寫了舊程式碼後，你會發現原有的各種記憶體快取超時策略全都是有對應新API的，包括AbsoluteExpiration， SlidingExpiration等等。

所以我們還是可以很輕鬆的使用.NET Core新API簡單改動下下就能重用現有絕大部分舊程式碼，將其遷移過來繼續起作用。

 

遷移後的完整程式碼如下：

using Microsoft.Extensions.Caching.Memory;
using System;

namespace TestMemoryCacheWebApp.Services
{
    public class MemoryCacheService
    {
        static MemoryCache cache = new MemoryCache(new MemoryCacheOptions());
        /// <summary>
        /// 獲取快取值
        /// </summary>
        /// <param name="key"></param>
        /// <returns></returns>
        private object GetCacheValue(string key)
        {
            object val = null;
            if (key != null && cache.TryGetValue(key, out val))
            {

                return val;
            }
            else
            {
                return default(object);
            }
        }
        /// <summary>
        /// 新增快取內容
        /// </summary>
        /// <param name="key"></param>
        /// <param name="value"></param>
        public static void SetChacheValue(string key, object value)
        {
            if (key != null)
            {
                cache.Set(key, value, new MemoryCacheEntryOptions
                {
                    SlidingExpiration = TimeSpan.FromHours(1)
                });
            }
        }
    }
}