如何在 ASP.NET Core 中使用 LazyCache

最新推荐文章于 2024-08-22 09:50:55 发布

dotNET跨平台

最新推荐文章于 2024-08-22 09:50:55 发布

阅读量304

点赞数 1

微软的 ASP.NET Core 已经是一个非常流行的用于构建 高性能, 模块化 并能运行在 Windows, Linux, MacOS 上的 WEB 框架，通常能够让程序保持高性能的一个有效途径就是通过缓存热链上的数据来应对高频的请求。

LazyCache 是一款基于内存的易于使用和线程安全的缓存组件，值得注意的是，这里的 Lazy 指的是 LazyCache 永远不会在 缓存未命中 时触发一次以上的缓存委托函数，因为内置了锁，换句话说，Lazy 减少了不必要的计算开销，这篇文章我们将会讨论如何在 ASP.NET Core 5.0 中使用 LazyCache。

安装 LazyCache

要想在 ASP.NET Core MVC 5 中使用 LazyCache，你需要安装如下两个 nuget 包。

LazyCache
LazyCache.AspNetCore

你可以通过 Nuget 可视化工具安装或者通过如下命令进行安装。


PM> Install-Package LazyCache
PM> Install-Package LazyCache.AspNetCore

为什么要缓存？

缓存是一种 状态管理策略，在web应用程序中，它常常用来缓存一些数据到内存中供后续请求复用，这样就规避了原来不得不走硬盘取数据的尴尬，显而易见，缓存是提高 web 程序性能的一大利器，

虽然 ASP.NET Core 缺少内置的 Cache，但它提供了对三种缓存类型的支持：内存缓存,分布式缓存 和 响应缓存。

为什么要使用 LazyCache

LazyCache 是一个开源的，简单的，线程安全的，可扩展的缓存组件，在底层，LazyCache 使用了 Microsoft.Extensions.Caching 下的 MemoryCache 并使用了 懒锁 来确保 委托 只会执行一次。

如果你想缓存从数据库中取得的数据，复杂的对象图和 web服务调用，那么使用 LazyCache 是一个非常好的选择，通常默认缓存的时间是 20min。

下面简单罗列了 LazyCache 的一些特点。

可扩展性
开源
友好的 API 接口
内置 lazy 锁
底层使用 MemoryCache

配置 LazyCache

要想配置 LazyCache，可以在 ConfigureServices() 方法中通过调用 AddLazyCache() 将 LazyCache 注入到 ServiceContainer 中，如下代码所示：


        public void ConfigureServices(IServiceCollection services)
        {
            services.AddLazyCache();
            services.AddControllers();
        }

这样就可以确保 LazyCache 可以贯穿在你的应用程序中，要想访问 LazyCache 可以通过 IAppCache 接口，定义如下：


    public interface IAppCache
    {
        ICacheProvider CacheProvider { get; }
        CacheDefaults DefaultCachePolicy { get; }

        void Add<T>(string key, T item, MemoryCacheEntryOptions policy);
        T Get<T>(string key);
        Task<T> GetAsync<T>(string key);
        T GetOrAdd<T>(string key, Func<ICacheEntry, T> addItemFactory);
        T GetOrAdd<T>(string key, Func<ICacheEntry, T> addItemFactory, MemoryCacheEntryOptions policy);
        Task<T> GetOrAddAsync<T>(string key, Func<ICacheEntry, Task<T>> addItemFactory);
        Task<T> GetOrAddAsync<T>(string key, Func<ICacheEntry, Task<T>> addItemFactory, MemoryCacheEntryOptions policy);
        void Remove(string key);
        bool TryGetValue<T>(string key, out object value);
    }

将 IAppCache 注入到 Controller 中

一切都配置好之后，接下来就可以将 IAppCache 通过构造函数注入的方式灌到 Controller 中，如下代码所示：


    [ApiController]
    [Route("[controller]")]
    public class WeatherForecastController : ControllerBase
    {
        private readonly IAppCache _lazyCache;

        public WeatherForecastController(IAppCache cache)
        {
            this._lazyCache = cache;
        }
    }

通过 LazyCache 新增,获取数据

考虑如下返回 list 的 GetData() 方法。


private async Task<List<string>> GetData()
{
    return new List<string>()
    {
       "Joydip Kanjilal",
       "Steve Smith",
       "Rick Smith"
    };
}

接下来通过 GetOrAddAsync 方法从缓存获取或添加数据，如下代码所示：


    [ApiController]
    [Route("[controller]")]
    public class WeatherForecastController : ControllerBase
    {
        private readonly IAppCache _lazyCache;

        public WeatherForecastController(IAppCache cache)
        {
            this._lazyCache = cache;
        }

        [HttpGet]
        public async Task<IEnumerable<string>> Get()
        {
            var data = await _lazyCache.GetOrAddAsync("Authors", GetData, DateTimeOffset.Now.AddMinutes(30));

            return data;
        }

        private async Task<List<string>> GetData()
        {
            return new List<string>()
                   {
                      "Joydip Kanjilal",
                      "Steve Smith",
                      "Rick Smith"
                   };
        }
    }