Volo.Abp.Caching Package

Volo.Abp.Caching是缓存系统的核心包, 可以通过Nuget PMC安装到项目:

Install-Package Volo.Abp.Caching

IDistributedCache

ASP.NET Core 定义了 IDistributedCache 接口用于 get/set 缓存值 . 但是会有以下问题:

• 它适用于 byte 数组 而不是 .NET 对象. 因此你需要对缓存的对象进行序列化/反序列化.
• 它为所有的缓存项提供了单个 key 池 , 因此你需要注意区分不同类型的对象.

IDistributedCache 定义在 Microsoft.Extensions.Caching.Abstractions 包中.

接口的默认实现是 MemoryDistributedCache,它使用内存工作.

IDistributedCache<TCacheItem>

ABP在Volo.Abp.Caching包中定义了通用的泛型接口IDistributedCache<TCacheItem>, TCacheItem是存储在缓存中的对象类型, 其使用方法与ASP.NET Core的IDistributedCache 接口相同.

IDistributedCache<TCacheItem, TCacheKey>

IDistributedCache<TCacheItem> 中的Key默认是 string 类型, 如果你的Key不是string类型, 需要进行手动类型转换, IDistributedCache<TCacheItem, TCacheKey> 将Key的类型泛型化, 以简化手动转换的操作, 其使用方法与ASP.NET Core的IDistributedCache 接口相同.

解决的痛点

IDistributedCache<TCacheItem>和IDistributedCache<TCacheItem, TCacheKey> 解决了IDistributedCache中存在的问题;

• 它在内部 序列化/反序列化 缓存对象. 默认使用 JSON 序列化, 但可以替换依赖注入系统中 IDistributedCacheSerializer 服务的实现来覆盖默认的处理.
• 它根据缓存中对象类型自动向缓存key添加 缓存名称 前缀. 默认缓存名是缓存对象类的全名(如果你的类名以CacheItem 结尾, 那么CacheItem 会被忽略,不应用到缓存名称上). 你也可以在缓存类上使用 CacheName 设置换缓存的名称.
• 它自动将当前的租户id添加到缓存键中, 以区分不同租户的缓存项 (只有在你的应用程序是多租户的情况下生效). 在缓存类上应用 IgnoreMultiTenancy attribute, 可以在所有的租户间共享缓存.
• 允许为每个应用程序定义 全局缓存键前缀 ,不同的应用程序可以在共享的分布式缓存中拥有自己的隔离池.

使用方法

定义缓存中存储项的示例类, 通常根据自身业务定义类中的各个属性.

public class BookCacheItem
{
        public string Name { get; set; }

        public decimal Price { get; set; }
}

将IDistributedCache<BookCacheItem>注入到需要的Service中

public class BookService:ITransientDependency
{
        private readonly IDistributedCache<BookCacheItem> _cache;

        public BookService(IDistributedCache<BookCacheItem> cache)
        {
            _cache = cache;
        }

        public async Task<BookCacheItem> GetAsycn(Guid bookId)
        {
            return await _cache.GetOrAddAsync(
                bookId.ToString(),
                async ()=>await GetBookFromDatabaseAsync(bookId),
                ()=>new DistributedCacheEntryOptions
                {
                    AbsoluteExpiration = DateTimeOffset.Now.AddHours(1)
                });
        }

        public async Task<BookCacheItem> GetBookFromDatabaseAsync(Guid bookId)
        {
            //TODO: get from database
        }
}

• 示例Service中的 GetOrAddAsync() 方法从缓存中获取数据.
• 如果没有在缓存中找到数据,它会调用工厂方法 (本示例中是 GetBookFromDatabaseAsync)从原始数据源中获取数据.
• GetOrAddAsync 有一个可选参数 DistributedCacheEntryOptions , 可用于设置缓存的生命周期.

如果缓存项中Key的类型是Guid, 则将IDistributedCache<BookCacheItem,Guid>注入到需要的Service中

public class BookService : ITransientDependency
{
    private readonly IDistributedCache<BookCacheItem, Guid> _cache;

    public BookService(IDistributedCache<BookCacheItem, Guid> cache)
    {
        _cache = cache;
    }

    public async Task<BookCacheItem> GetAsync(Guid bookId)
    {
        return await _cache.GetOrAddAsync(
            bookId, //Guid type used as the cache key
            async () => await GetBookFromDatabaseAsync(bookId),
            () => new DistributedCacheEntryOptions
            {
                AbsoluteExpiration = DateTimeOffset.Now.AddHours(1)
            }
        );
    }
    private Task<BookCacheItem> GetBookFromDatabaseAsync(Guid bookId)
    {
        //TODO: get from database
    }
}

• 示例服务中 GetOrAddAsync() 方法获取缓存的数据.
• 我们采用了 Guid 作为Key, 在 _cache.GetOrAddAsync() 方法中传入 Guid 类型的bookid

IDistributedCache<TCacheItem, TCacheKey> 在内部使用Key对象的 ToString() 方法转换类型为string. 如果你的将复杂对象作为Key,那么需要重写类的 ToString 方法.

public class UserInOrganizationCacheKey
{
    public Guid UserId { get; set; }
 
    public Guid OrganizationId { get; set; }

    //构建缓存key
    public override string ToString()
    {
        return #34;{UserId}_{OrganizationId}";
    }
}

public class BookService : ITransientDependency
{
    private readonly IDistributedCache<UserCacheItem, UserInOrganizationCacheKey> _cache;

    public BookService(
        IDistributedCache<UserCacheItem, UserInOrganizationCacheKey> cache)
    {
        _cache = cache;
    }

    ...
}

写在结尾

每次看到这样的文章, 总想自己着手建个项目(Web或者Console)把代码run一遍, 但是文章中的代码总是松散不完整的. 等到自己去解读一些框架时,才发现原因可能有以下几点:

1. 文章需要建立关注点, 如果写得大而全, 往往会让读者失去关注点,导致容易忽视作者要透露的关键信息.
2. 知识点的牵扯面较多, 比如我想写个控制台项目去run一遍代码的时候, 发现如何注入IDistributedCache<TCacheItem>时, 就牵扯到了module, 咱们下一篇继续解读.

class Program
{
        static async Task Main(string[] args)
        {
            using var host = CreateHostBuilder(args).Build();
            
            var bookService = host.Services.GetRequiredService<BookService>();
            var book = await bookService.GetAsycn(Guid.Parse("7a56d60b-3c2b-46de-b280-ba3ceae51d3d"));

            await host.RunAsync();
        }

        static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureServices((_, services)=>
                    services.AddTransient<BookService>()
                       .AddApplication<AbpCachingModule>());//引入缓存模块
 }

3. 当从数据库中读取出测试数据时, 需要把Entity的属性值赋值给EntityCacheItem时, 又牵扯到了AutoMapper这类对象到对象的映射工具, 如果都按照我下面这样写代码的话, 就太累了...

public class BookCacheItem
{
        public string Name { get; set; }
        public decimal Price { get; set; }

        public static BookCacheItem FromBook(Book item)
        {
            return new BookCacheItem
            {
                Name = item.Name,
                Price = item.Price
            };
        }
}

4. 如果不run一遍代码的话, 也可以通过单元测试的方式测试.