NetCore 的缓存使用详例

关注

发布于: 2021 年 03 月 31 日

关于我

缓存基础知识

缓存可以减少生成内容所需的工作，从而显著提高应用程序的性能和可伸缩性。缓存最适用于不经常更改的 数据，生成 成本很高。通过缓存，可以比从数据源返回的数据的副本速度快得多。应该对应用进行编写和测试，使其永不依赖于缓存的数据。

ASP.NET Core 支持多个不同的缓存。最简单的缓存基于 IMemoryCache。 IMemoryCache 表示存储在 web 服务器的内存中的缓存。在服务器场上运行的应用 (多台服务器) 应确保会话在使用内存中缓存时处于粘滞状态。粘滞会话确保来自客户端的后续请求都将发送到相同的服务器。

内存中缓存可以存储任何对象。分布式缓存接口仅限 byte[] 。内存中和分布式缓存将缓存项作为键值对。

缓存指南

代码应始终具有回退选项，以获取数据，而不是依赖于可用的缓存值。
缓存使用稀有资源内存,限制缓存增长：
不要 使用外部 输入作为缓存键。
使用过期限制缓存增长。
使用 SetSize、Size 和 SizeLimit 限制缓存大小]。 ASP.NET Core 运行时不会根据内存 压力限制缓存 大小。开发人员需要限制缓存大小。

使用

DI 注入

创建一个 NetCore 控制台项目，进行缓存的项目演示。

控制台项目只有一个初始化的 Program.cs 文件。基于 NetCore 进行项目编码，每一步就是创建一个基础模板，使用依赖注入的方式。

nuget install Microsoft.Extensions.Hosting

复制代码

  public static class Program    {        static async void Main(string[] args)        {           var builder = new HostBuilder().ConfigureServices((context, service) =>            {
            });
           await builder.RunConsoleAsync();        }    }

复制代码

注入缓存服务,控制台需要下载库 Microsoft.Extensions.Caching.Memory

nuget install Microsoft.Extensions.Caching.Memory

复制代码

  public static class Program    {        static async void Main(string[] args)        {           var builder = new HostBuilder().ConfigureServices((context, service) =>            {            service.AddMemoryCache();                          service.AddScoped<CacheService>();//实际测试服务
              service.AddHostedService<BackgroundJob>();//后台执行方法            });
           await builder.RunConsoleAsync();        }    }

复制代码

后台服务

public class BackgroundJob : IHostedService    {        private readonly CacheService _cacheService;
        public BackgroundJob(CacheService cacheService)        {            _cacheService = cacheService;        }
        public Task StartAsync(CancellationToken cancellationToken)        {            _cacheService.Action();
            return Task.CompletedTask;        }
        public Task StopAsync(CancellationToken cancellationToken)        {            return Task.CompletedTask;        }    }

复制代码

MemoryCache 使用总结

通过构造函数自动注入 IMemoryCache

public class CacheService{    private readonly IMemoryCache _memoryCache;
    public CacheService(IMemoryCache memoryCache)    {        _memoryCache = memoryCache;    }}

复制代码

最基本的使用

Set 方法根据 Key 设置缓存，默认缓存不过期

Get 方法根据 Key 取出缓存

/// <summary>/// 缓存设置/// </summary>public void BaseCache(){    string cacheKey = "timestamp";    //set cache    _memoryCache.Set(cacheKey, DateTime.Now.ToString());
    //get cache    Console.WriteLine(_memoryCache.Get(cacheKey));}

复制代码

IMemoryCache 提供一些好的语法糖供开发者使用，具体内容看下方文档

/// <summary>/// 特殊方法的使用/// </summary>public void ActionUse(){    //场景-如果缓存存在，取出。如果缓存不存在，写入    //原始写法    string cacheKey = "timestamp";    if (_memoryCache.Get(cacheKey) != null)    {        _memoryCache.Set(cacheKey, DateTime.Now.ToString());    }    else    {        Console.WriteLine(_memoryCache.Get(cacheKey));    }
    //新写法    var dataCacheValue = _memoryCache.GetOrCreate(cacheKey, entry =>     {         return DateTime.Now.ToString();     });    Console.WriteLine(dataCacheValue);
    //删除缓存    _memoryCache.Remove(cacheKey);
    //场景 判断缓存是否存在的同时取出缓存数据    _memoryCache.TryGetValue(cacheKey, out string cacheValue);    Console.WriteLine(cacheValue);
}

复制代码

缓存过期策略

设置缓存常用的方式主要是以下二种

绝对到期（指定在一个固定的时间点到期）
滑动到期（在一个时间长度内没有被命中则过期）
组合过期 (绝对过期+滑动过期）

绝对到期

过期策略 5 秒后过期

//set absolute cachestring cacheKey = "absoluteKey";_memoryCache.Set(cacheKey, DateTime.Now.ToString(), TimeSpan.FromSeconds(5));
//get absolute cachefor (int i = 0; i < 6; i++){    Console.WriteLine(_memoryCache.Get(cacheKey));    Thread.Sleep(1000);}

复制代码

滑动到期

过期策略 2 秒的滑动过期时间，如果 2 秒内有访问，过期时间延后。当 2 秒的区间内没有访问，缓存过期

//set slibing cachestring cacheSlibingKey = "slibingKey";MemoryCacheEntryOptions options = new MemoryCacheEntryOptions();options.SlidingExpiration = TimeSpan.FromSeconds(2);
_memoryCache.Set(cacheSlibingKey, DateTime.Now.ToString(), options);
//get slibing cachefor (int i = 0; i < 2; i++){    Console.WriteLine(_memoryCache.Get(cacheSlibingKey));    Thread.Sleep(1000);}for (int i = 0; i < 2; i++){    Thread.Sleep(2000);    Console.WriteLine(_memoryCache.Get(cacheSlibingKey));}

复制代码

组合过期

过期策略

6 秒绝对过期+2 秒滑动过期

满足任意一个缓存都将失效

string cacheCombineKey = "combineKey";MemoryCacheEntryOptions combineOptions = new MemoryCacheEntryOptions();combineOptions.SlidingExpiration = TimeSpan.FromSeconds(2);combineOptions.AbsoluteExpiration = DateTime.Now.AddSeconds(6);
_memoryCache.Set(cacheCombineKey, DateTime.Now.ToString(), combineOptions);
//get slibing cachefor (int i = 0; i < 2; i++){    Console.WriteLine(_memoryCache.Get(cacheCombineKey));    Thread.Sleep(1000);}
for (int i = 0; i < 6; i++){    Thread.Sleep(2000);    Console.WriteLine(i+"|" + _memoryCache.Get(cacheCombineKey));}
Console.WriteLine("------------combineKey End----------------");

复制代码

缓存状态变化事件

当缓存更新、删除时触发一个回调事件，记录缓存变化的内容。

/// <summary>/// cache状态变化回调/// </summary>public void CacheStateCallback(){    MemoryCacheEntryOptions options = new MemoryCacheEntryOptions();    options.AbsoluteExpiration = DateTime.Now.AddSeconds(3        );    options.RegisterPostEvictionCallback(MyCallback, this);
    //show callback console    string cacheKey = "absoluteKey";    _memoryCache.Set(cacheKey, DateTime.Now.ToString(), options);
    Thread.Sleep(500);    _memoryCache.Set(cacheKey, DateTime.Now.ToString(), options);
    _memoryCache.Remove(cacheKey);
}
private static void MyCallback(object key, object value, EvictionReason reason, object state){    var message = $"Cache entry state change:{key} {value} {reason} {state}";    ((CacheService)state)._memoryCache.Set("callbackMessage", message);
    Console.WriteLine(message);}

复制代码

缓存依赖策略

设置一个缓存 A 设置一个缓存 B,依赖于缓存 A 如果缓存 A 失效,缓存 B 也失效

/// <summary>/// 缓存依赖策略/// </summary>public void CacheDependencyPolicy(){    string DependentCTS = "DependentCTS";    string cacheKeyParent = "CacheKeys.Parent";    string cacheKeyChild = "CacheKeys.Child";
    var cts = new CancellationTokenSource();    _memoryCache.Set(DependentCTS, cts);
    //创建一个cache策略    using (var entry = _memoryCache.CreateEntry(cacheKeyParent))    {        //当前key对应的值        entry.Value = "parent" + DateTime.Now;
        //当前key对应的回调事件        entry.RegisterPostEvictionCallback(MyCallback, this);
        //基于些key创建一个依赖缓存        _memoryCache.Set(cacheKeyChild, "child" + DateTime.Now, new CancellationChangeToken(cts.Token));    }
    string ParentCachedTime = _memoryCache.Get<string>(cacheKeyParent);    string ChildCachedTime = _memoryCache.Get<string>(cacheKeyChild);    string callBackMsg = _memoryCache.Get<string>("callbackMessage");    Console.WriteLine("第一次获取");    Console.WriteLine(ParentCachedTime + "|" + ChildCachedTime + "|" + callBackMsg);
    //移除parentKey    _memoryCache.Get<CancellationTokenSource>(DependentCTS).Cancel();    Thread.Sleep(1000);
    ParentCachedTime = _memoryCache.Get<string>(cacheKeyParent);    ChildCachedTime = _memoryCache.Get<string>(cacheKeyChild);    callBackMsg = _memoryCache.Get<string>("callbackMessage");    Console.WriteLine("第二次获取");    Console.WriteLine(ParentCachedTime + "|" + ChildCachedTime + "|" + callBackMsg);}