概念

什么是缓存,在项目中,为了提高数据的读取速度,我们会对不经常变更但访问频繁的数据做缓存处理,我们常用的缓存有:

功能

目前,MasaFramework为我们提供了以下能力

入门

分布式缓存

  1. 新建ASP.NET Core 空项目Assignment.DistributedCache,并安装Masa.Contrib.Caching.Distributed.StackExchangeRedis
dotnet new web -o Assignment.DistributedCache
cd Assignment.DistributedCache dotnet add package Masa.Contrib.Caching.Distributed.StackExchangeRedis --version 0.6.0-rc.5
  1. 配置Redis配置信息
{
"RedisConfig":{
"Servers":[
{
"Host":"localhost",
"Port":6379
}
],
"DefaultDatabase":3,
"ConnectionPoolSize":10
}
}
  1. 注册分布式缓存,并使用Redis缓存,修改Program.cs
var builder = WebApplication.CreateBuilder(args);

//注册分布式缓存
builder.Services.AddDistributedCache(distributedCacheOptions =>
{
distributedCacheOptions.UseStackExchangeRedisCache();//使用分布式Redis缓存, 默认使用本地`RedisConfig`下的配置
});

使用分布式缓存的数据来源默认为 IOptionsMonitor<RedisConfigurationOptions>,如果本地未正确在RedisConfig节点配置缓存信息,且项目中也没有通过其它方式配置使其支持选项模式,则默认使用的Redis配置为: 地址: localhost、端口:6379,密码:空,数据库:db0

  1. 新建User类,用于接收用户信息
public class User
{
public string Name { get; set; } public int Age { get; set; }
}
  1. 如何使用IDistributedCacheClient,修改Program.cs
// 设置缓存
app.MapPost("/set/{id}", async (IDistributedCacheClient distributedCacheClient, [FromRoute] string id, [FromBody] User user) =>
{
await distributedCacheClient.SetAsync(id, user);
return Results.Accepted();
}); // 获取缓存
app.MapGet("/get/{id}", async (IDistributedCacheClient distributedCacheClient, [FromRoute] string id) =>
{
var value = await distributedCacheClient.GetAsync<User>(id);
return Results.Ok(value);
});

多级缓存

  1. 新建ASP.NET Core 空项目Assignment.DistributedCache,并安装Masa.Contrib.Caching.MultilevelCacheMasa.Contrib.Caching.Distributed.StackExchangeRedis
dotnet new web -o Assignment.MultilevelCache
cd Assignment.MultilevelCache dotnet add package Masa.Contrib.Caching.MultilevelCache --version 0.6.0-rc.5
dotnet add package Masa.Contrib.Caching.Distributed.StackExchangeRedis --version 0.6.0-rc.5
  1. 注册多级缓存,并使用分布式Redis缓存,修改Program.cs
var builder = WebApplication.CreateBuilder(args);

//注册多级缓存
builder.Services.AddMultilevelCache(distributedCacheOptions =>
{
distributedCacheOptions.UseStackExchangeRedisCache();//使用分布式Redis缓存
});
  1. 新建User类,用于接收用户信息
public class User
{
public string Name { get; set; } public int Age { get; set; }
}
  1. 如何使用IMultilevelCacheClient,修改Program.cs
// 设置缓存
app.MapPost("/set/{id}", async (IMultilevelCacheClient multilevelCacheClient, [FromRoute] string id, [FromBody] User user) =>
{
await multilevelCacheClient.SetAsync(id, user);
return Results.Accepted();
}); // 获取缓存
app.MapGet("/get/{id}", async (IMultilevelCacheClient multilevelCacheClient, [FromRoute] string id) =>
{
var value = await multilevelCacheClient.GetAsync<User>(id);
return Results.Ok(value);
});

测试

借助Postman或者Swagger或者使用其它API测试工具,分别测试设置缓存与获取缓存,以验证分布式缓存以及多级缓存是可以正常使用的。

友情提示:检查Redis缓存,找到刚刚你配置的缓存,确定下它的存储结果是否与你想象的一致!!

规则

经过测试,我们的分布式缓存与多级缓存是可以正常使用的,但查看Redis的存储结果后,发现它们实际的存储与我们心目中的结果好像是有点出入,它们分别是:

  1. 缓存Key不同 (与我们设置的Key不完全一致)
  2. 结构不同 (实际存储的为Hash类型)
  3. 内容不同 (内容经过压缩)

缓存Key的生成规则

缓存Key支持三种规则:

枚举 描述
None 1 不做处理,传入的Key即为实际的缓存Key
TypeName 2 实际的缓存Key = $"{GetTypeName(T)}.{传入缓存Key}" (默认)
TypeAlias 3 根据TypeName得到对应的别名与Key的组合,Format: ${TypeAliasName}{:}{key}

详细规则可查看

存储结构与规则

Masa.Contrib.Caching.Distributed.StackExchangeRedis使用的是Hash存储,通过使用Hash存储,支持缓存的绝对过期以及相对过期,其中:

描述 详细 特殊
absexp 绝对过期时间的Ticks 自公历 0001-01-01 00:00:00:000 到绝对过期时间的计时周期数 (1周期 = 100ns 即 1/10000 ms) -1 为永不过期
sldexp 滑动过期时间的Ticks 自公历 0001-01-01 00:00:00:000 到滑动过期时间的计时周期数 (1周期 = 100ns 即 1/10000 ms,每次获取数据时会刷新滑动过期时间) -1 为永不过期
data 数据 存储用户设置的缓存数据

内容压缩规则

  1. 当存储值类型为以下类型时,不对数据进行压缩:
  • Byte
  • SByte
  • UInt16
  • UInt32
  • UInt64
  • Int16
  • Int32
  • Int64
  • Double
  • Single
  • Decimal
  1. 当存储值类型为字符串时,对数据进行压缩
  2. 当存储值类型不满足以上条件时,对数据进行序列化并进行压缩

分布式Redis缓存示例

分布式缓存注册

方案一. 通过本地配置文件注册

  1. 修改appsettings.json文件
{
"RedisConfig":{
"Servers":[
{
"Host":"localhost",
"Port":6379
}
],
"DefaultDatabase":3,
"ConnectionPoolSize":10
}
}
  1. 注册分布式Redis缓存
builder.Services.AddDistributedCache(distributedCacheOptions =>
{
distributedCacheOptions.UseStackExchangeRedisCache();
});

方案二. 手动指定Redis配置注册

builder.Services.AddDistributedCache(distributedCacheOptions =>
{
distributedCacheOptions.UseStackExchangeRedisCache(options =>
{
options.Servers = new List<RedisServerOptions>()
{
new("localhost", 6379)
};
options.DefaultDatabase = 3;
options.ConnectionPoolSize = 10;
options.GlobalCacheOptions = new CacheOptions()
{
CacheKeyType = CacheKeyType.None //全局禁用缓存Key格式化处理
};
});
});

方案三. 通过选项模式注册

  1. 通过Configure方法使其支持选项模式
builder.Services.Configure<RedisConfigurationOptions>(redisConfigurationOptions =>
{
redisConfigurationOptions.Servers = new List<RedisServerOptions>()
{
new("localhost", 6379)
};
redisConfigurationOptions.DefaultDatabase = 3;
redisConfigurationOptions.ConnectionPoolSize = 10;
redisConfigurationOptions.GlobalCacheOptions = new CacheOptions()
{
CacheKeyType = CacheKeyType.None
};
});
  1. 注册分布式Redis缓存
builder.Services.AddDistributedCache(distributedCacheOptions =>
{
distributedCacheOptions.UseStackExchangeRedisCache();
});

方案四. 通过指定Configuration注册

  1. 在Redis缓存的配置存储到本地appsettings.json文件
{
"RedisConfig":{
"Servers":[
{
"Host": "localhost",
"Port": 6379
}
],
"DefaultDatabase": 3,
"ConnectionPoolSize": 10
}
}
  1. 指定Configuration注册分布式Redis缓存
var builder = WebApplication.CreateBuilder(args);

//注册分布式缓存
builder.Services.AddDistributedCache(distributedCacheOptions =>
{
// 使用存储Redis配置的Configuration
distributedCacheOptions.UseStackExchangeRedisCache(builder.Configuration.GetSection("RedisConfig"));
});

方案五. 将配置存储到Dcc上,并通过Configuration提供的手动映射功能,实现选项模式

  1. 使用Dcc,并手动指定映射
builder.AddMasaConfiguration(configurationBuilder =>
{
configurationBuilder.UseDcc();//使用Dcc 扩展Configuration能力,支持远程配置 configurationBuilder.UseMasaOptions(options =>
{
//通过手动映射RedisConfigurationOptions的配置,实现选项模式
options.MappingConfigurationApi<RedisConfigurationOptions>("{替换为Dcc中配置所属的AppId}", "{替换为Redis配置的对象名称}");
});
});
  1. 注册分布式Redis缓存
builder.Services.AddDistributedCache(distributedCacheOptions =>
{
distributedCacheOptions.UseStackExchangeRedisCache();
});

方案三、四、五的本质都是通过支持选项模式来注册分布式Redis缓存

修改缓存Key映射规则

修改缓存Key映射规则十分简单,我们在配置时更改CacheKeyType为对应的规则即可,但当 CacheKeyType = 3 需要注意,它需要额外提供类型名与别名的对应关系,完整例子如下:

  1. 修改appsettings.json, 将CacheKeyType的值改为 3
{
"RedisConfig":{
"Servers":[
{
"Host":"localhost",
"Port":6379
}
],
"DefaultDatabase":3,
"ConnectionPoolSize":10,
"GlobalCacheOptions": {
"CacheKeyType": 3 //CacheKeyType为3时启用别名格式化缓存Key,可节省缓存Key的键长度
}
}
}
  1. 注册分布式缓存并配置类型名与别名的对应关系
builder.Services.AddDistributedCache(distributedCacheOptions =>
{
distributedCacheOptions.UseStackExchangeRedisCache();
}, typeAliasOptions =>
{
typeAliasOptions.GetAllTypeAliasFunc = () => new Dictionary<string, string>()
{
{ "String", "s" }//当类型为String时,格式化后的Key为 s:key
};
});

通过指定类型与别名的对应关系,从而使得最终形成较短的缓存Key,以达到节省存储空间的目的,缓存Key生成规则可查看

多级缓存示例

多级缓存注册

方案一. 通过本地配置文件注册

  1. 修改appsettings.json文件,分别配置多级缓存配置以及Redis缓存配置
{
// 多级缓存全局配置,非必填
"MultilevelCache": {
"SubscribeKeyPrefix": "masa",//默认订阅方key前缀,用于拼接channel
"SubscribeKeyType": 3, //默认订阅方key的类型,默认ValueTypeFullNameAndKey,用于拼接channel
"CacheEntryOptions": {
"AbsoluteExpirationRelativeToNow": "00:00:30",//绝对过期时长(距当前时间)
"SlidingExpiration": "00:00:50"//滑动过期时长(距当前时间)
}
}, // Redis分布式缓存配置
"RedisConfig": {
"Servers": [
{
"Host": "localhost",
"Port": 6379
}
],
"DefaultDatabase": 3
}
}
  1. 添加多级缓存并使用分布式Redis缓存
builder.Services.AddMultilevelCache(distributedCacheOptions =>
{
distributedCacheOptions.UseStackExchangeRedisCache();
});

方案二. 通过手动指定配置

builder.Services.AddMultilevelCache(distributedCacheOptions =>
{
distributedCacheOptions.UseStackExchangeRedisCache(RedisConfigurationOptions);
});

未配置内存缓存时,默认内存缓存永久有效

除了上述两种方式以外,多级缓存的内存缓存配置也同样支持选项模式,我们可以通过Dcc或者利用 builder.Services.Configure<MultilevelCacheOptions>(builder.Configuration)来支持选项模式

修改缓存Key映射规则

源码解读

IDistributedCacheClient (分布式缓存客户端)

IDistributedCacheClient接口提供以下方法来处理分布式缓存

以下方法会根据全局缓存Key的规则配置以及传入缓存Key的规则配置,检测是否需要格式化缓存Key,对需要格式化Key的操作按照缓存Key格式化规则进行处理,详细查看:

  • Get<T>GetAsync<T>: 根据缓存Key返回类型为T的结果 (如果缓存不存在,则返回Null)
  • GetList<T>GetListAsync<T>: 根据缓存Key集合返回对应的缓存值的集合 (针对不存在的缓存key,其值返回Null)
  • GetOrSet<T>GetOrSetAsync<T>: 如果在缓存中找到,则返回类型为T的结果,如果缓存未找到,则执行Setter,并返回Setter的结果
  • Set<T>SetAsync<T>: 将指定的缓存Key以及缓存值添加到缓存
  • SetList<T>SetListAsync<T>: 将指定的缓存Key、Value集合添加缓存
  • Remove<T>RemoveAsync<T>: 将指定的缓存Key (缓存Key集合) 从缓存中移除
  • Refresh<T>RefreshAsync<T>: 刷新指定的缓存Key (缓存Key集合) 的生命周期
    • 适用于未被删除、绝对过期时间没有到,但相对过期时间快到的缓存 (延长滑动过期时间)
  • Exists<T>ExistsAsync<T>: 如果在缓存中找到,则返回true,否则返回false
  • GetKeys<T>GetKeysAsync<T>: 根据key pattern 得到符合规则的所有缓存Key
  • GetByKeyPattern<T>GetByKeyPatternAsync<T>: 根据key pattern 得到符合规则的所有缓存Key、Value集合
  • HashIncrementAsync: 将指定的缓存Key的值增加Value,并返回增长后的结果
  • HashDecrementAsync: 将指定的缓存Key的值减少Value,并返回减少后的结果
    • 支持设置最小的Value,避免减少后的值低于设置的最小值,执行失败则返回: -1
  • KeyExpire<T>KeyExpireAsync<T>: 设置缓存Key的生命周期

以下方法不执行缓存Key格式化, 应传入缓存完整Key:

  • RemoveRemoveAsync: 将指定的缓存Key (缓存Key集合) 从缓存中移除
  • RefreshRefreshAsync: 刷新指定的缓存Key (缓存Key集合) 的生命周期
    • 适用于未被删除、绝对过期时间没有到,但相对过期时间快到的缓存
  • ExistsExistsAsync: 如果在缓存中找到,则返回true,否则返回false
  • GetKeysGetKeysAsync: 根据key pattern 得到符合规则的所有缓存Key
    • 例: 传入User*,可得到缓存中以User开头的所有缓存Key
  • KeyExpireKeyExpireAsync: 设置缓存Key的生命周期

IMultilevelCacheClient (多级缓存客户端)

  • Get<T>GetAsync<T>: 根据缓存Key返回类型为T的结果 (如果缓存不存在,则返回Null) (支持监控缓存变更)
  • GetList<T>GetListAsync<T>: 根据缓存Key集合返回对应的缓存值的集合 (针对不存在的缓存key,其值返回Null)
  • GetOrSet<T>GetOrSetAsync<T>: 如果在缓存中找到,则返回类型为T的结果,如果缓存未找到,则执行Setter,并返回Setter的结果
  • Set<T>SetAsync<T>: 将指定的缓存Key以及缓存值添加到缓存
  • SetList<T>SetListAsync<T>: 将指定的缓存Key、Value集合添加缓存
  • Remove<T>RemoveAsync<T>: 将指定的缓存Key (缓存Key集合) 从缓存中移除
  • Refresh<T>RefreshAsync<T>: 刷新指定的缓存Key (缓存Key集合) 的生命周期
    • 适用于未被删除、绝对过期时间没有到,但相对过期时间快到的缓存 (延长滑动过期时间)

IDistributedCacheClientFactory (分布式缓存工厂)

  • Create: 返回指定Name的分布式缓存客户端

IMultilevelCacheClientFactory (多级缓存工厂)

  • Create: 返回指定Name的多级缓存客户端

如果Name为空字符串时,可直接使用IDistributedCacheClientIMultilevelCacheClient, 默认注册不指定Name时,则其Name为空字符串,可不通过Factory创建

总结

Masa Framework提供了分布式缓存以及多级缓存的实现,其中有几个优秀的功能:

  • 多级缓存提供了缓存更新后同步更新内存缓存功能

    • 当我们的服务是多副本时,不必担心会缓存更新后其它副本由于内存缓存未过期,导致获取到过期的缓存数据,大大提升我们的用户体验
  • 支持滑动过期以及绝对过期混合使用
    • 避免无用的缓存长时间被持久化,但对于热点数据又可以避免打到Redis或者数据库
  • 配置支持热更新,配置更新后同步生效,无需重启项目
  • 缓存Key支持格式化,可根据当前缓存值类型与传入缓存Key结合形成新的缓存Key,提高了开发效率以及代码可读性
    • 比如获取用户id为1的数据,可通过Client.Get<User>("1"),而无需:Client.Get<User>("User.1")

本章源码

Assignment16

https://github.com/zhenlei520/MasaFramework.Practice

开源地址

MASA.Framework:https://github.com/masastack/MASA.Framework

MASA.EShop:https://github.com/masalabs/MASA.EShop

MASA.Blazor:https://github.com/BlazorComponent/MASA.Blazor

如果你对我们的 MASA Framework 感兴趣,无论是代码贡献、使用、提 Issue,欢迎联系我们

MasaFramework -- 缓存入门与规则配置的更多相关文章

  1. MasaFramework -- 缓存入门与设计

    概念 什么是缓存,在项目中,为了提高数据的读取速度,我们会对不经常变更但访问频繁的数据做缓存处理,我们常用的缓存有: 本地缓存 内存缓存:IMemoryCache 分布式缓存 Redis: Stack ...

  2. Varnish缓存服务器的搭建配置手册

    Varnish缓存服务器的搭建配置手册 1.Varnish官方环境依赖提示 Installing Varnish Cache is as simple as enabling our package ...

  3. Memcached缓存入门篇

    Asp.Net中使用Couchbase——Memcached缓存入门篇 前言 本文的主要目的就是简单的进行使用Memcached.这是Memchahed的官网http://memcached.org/ ...

  4. Spring入门4.AOP配置深入

    Spring入门4.AOP配置深入 代码下载 链接: http://pan.baidu.com/s/11mYEO 密码: x7wa 前言: 之前学习AOP中的一些概念,包括连接点.切入点(pointc ...

  5. ehcache缓存入门学习

    ehcache缓存入门学习 1,概念 特性 EhCache 是一个纯Java的进程内缓存框架,具有快速.精干等特点,是Hibernate中默认的CacheProvider. 主要的特性有:1. 快速2 ...

  6. ASP.NET 5 入门 (2) – 自定义配置

    ASP.NET 5 入门 (2) – 自定义配置 ASP.NET 5 理解和入门 建立和开发ASP.NET 5 项目 初步理解ASP.NET5的配置 正如我的第一篇文章ASP.NET 5 (vNext ...

  7. Debian 入门安装与配置2

    Debian 入门安装与配置2 1. C/C++开发必装软件 atp-get install gcc    这个不用说,用来编译C程序 apt-get install g++ 用来编译C++程序 ap ...

  8. Debian 入门安装与配置1

    Debian 入门安装与配置1 最近安装了多个发行版本的Linux,包括Ubuntu.Fedora.Centos和Debian,发现只有Debian在界面和稳定性等综合特性上表现最优,自己也最喜欢,所 ...

  9. EHCache分布式缓存集群环境配置

    EHCache分布式缓存集群环境配置 ehcache提供三种网络连接策略来实现集群,rmi,jgroup还有jms.同时ehcache可以可以实现多播的方式实现集群,也可以手动指定集群主机序列实现集群 ...

随机推荐

  1. 针对多个球体的World类

    World类其他都一样的,就修改build函数就行了,以后测试所有代码,都是基于两个或多个球体的,不再重复阐述. void World::build() { vp.set_hres(200); vp. ...

  2. ApacheCon 2020 参会指南

    每年一度的 Apache 北美大会因为疫情的原因转到线上来举行了, 这次会议的主题是 ApacheCon@Home, 也就是说借助网络我们可以足不出户就可以参加 Apache 大会了.今年的会议为了针 ...

  3. FormData 和表单元素(form)的区别

    Form 元素 <form>元素表示文档中的一个区域,此区域包含交互控件,用于向 Web 服务器提交信息(文件.字符).下面称之为表单元素或表单. 要向 Web 服务器提交信息,我们必须要 ...

  4. Rust实战系列-基本语法

    本文是<Rust in action>学习总结系列的第二部分,更多内容请看已发布文章: 一.Rust实战系列-Rust介绍 " 主要介绍 Rust 的语法.基本类型和数据结构,通 ...

  5. [CF1386C] Joker (IOI 赛制,分治,整体二分+可回退并查集)

    题面 给一个 N N N 点 M M M 边的简单无向图,询问 Q Q Q 次,每次问你把编号在 [ l i , r i ] [l_i,r_i] [li​,ri​] 之间的边删掉后,该图是否存在奇数环 ...

  6. JWT漏洞学习

    JWT漏洞学习 什么是JWT? JWT是JSON Web Token的缩写,它是一串带有声明信息的字符串,由服务端使用加密算法对信息签名,以保证其完整性和不可伪造性.Token里可以包含所有必要的信息 ...

  7. 【SwiftUI】学习笔记1-创建第一个iOS应用

    本系列将会开发大量实际的项目. 系列为本人学习笔记,资料:<SwiftUI自学成长笔记>-刘铭 资源源代码下载资源:可以在gitee上下载,搜索刘铭即可. 第一章:创建项目 也可以在菜单栏 ...

  8. 【java】学习路径38-数学模型分析:不同方式复制文件所需的时间

    测试文件:一段72kb的文本.约5.6MB大小的pdf论文.约38.9MB大小的无损音频文件. demo001 论<到灯塔去>的凝视主题.pdf irreplaceable.movpkg ...

  9. 创建deploymen的几种方式

    创建deployment方式有两种,一种是命令直接创建,一种是使用yaml文件 1. 直接使用命令方式: --record 参数用来记录版本,也可以忽略,建议带上 kubectl create dep ...

  10. Vmware虚拟主机访问外网设置

    本手册使用10.4.7.0/24网段 重点在于虚拟主机的网关和宿主机上的Vmnet8的IP和虚拟网络编辑器的NET网关保持一致 1.设置宿主机网络适配器 选择允许Vmware网络共享 配置VMnet8 ...