ASP.NET Core MVC 从入门到精通之缓存

[删除（380066935@qq.com或微信通知）]

更好的阅读体验请查看原文:https://www.cnblogs.com/hsiang/archive/2023/06/23/17498355.html

随着技术的发展，ASP.NET Core MVC也推出了好长时间，经过不断的版本更新迭代，已经越来越完善，本系列文章主要讲解ASP.NET Core MVC开发B/S系统过程中所涉及到的相关内容，适用于初学者，在校毕业生，或其他想从事ASP.NET Core MVC 系统开发的人员。

经过前几篇文章的讲解，初步了解ASP.NET Core MVC项目创建，启动运行，以及命名约定，创建控制器，视图，模型，接收参数，传递数据ViewData，ViewBag，路由，页面布局，wwwroot和客户端库，Razor语法，EnityFrameworkCore与数据库，HttpContext，Request，Response，Session，序列化，文件上传，自动映射，Html辅助标签，模型校验，鉴权、授权基础，Identity入门，日志管理，Filter(筛选器)等内容，今天继续讲解ASP.NET Core MVC 中缓存等相关内容，仅供学习分享使用。

缓存的优点

在应用程序中，使用缓存，具有如下优点：

提高应用程序的访问速度
适用于不易改变的数据

缓存分类

根据缓存的应用范围和存储方式，可以分为以下几种：

内存缓存：这种方式是将内容缓存到Web服务器内存在，主要适用于单服务器程序，且在服务器重启后，缓存中的数据也会丢失。
缓存服务器：对于分布式部署的Web系统，缓存与内存中的方式会造成各个Web服务器中的缓存内容不一致，一般都会有独立的缓存服务器，如Redis，SQL Server等存储缓存的地方。缓存服务器中的内容，不会随着Web服务器的重启而变化。
客户端：缓存于客户端一般通过Header实现，也可以通过localStorage，Cookie等方式。

内存缓存

In-Memory缓存，将数据缓存在Web服务器内存中，适用于单服务器部署的程序。在ASP.NET Core MVC程序中，使用内存缓存的步骤如下

1. 添加缓存服务

在Program.cs启动程序中，增加非分布式内存缓存服务，如下所示：

1 //内存缓存
2 builder.Services.AddMemoryCache();

2. 注入缓存接口

在需要用到的内存缓存的控制器中，添加内存缓存接口IMemoryCache注入，如下所示：

1 private readonly ILogger<HomeController> _logger;
2 
3 private readonly IMemoryCache _memoryCache;//内存缓存接口
4 
5 public HomeController(ILogger<HomeController> logger,IMemoryCache memoryCache)
6 {
7     _logger = logger;
8     _memoryCache = memoryCache;
9 }

3. 获取/设置缓存

在使用缓存的地方，获取和设置缓存如下所示：

 1 public IActionResult Index()
 2 {
 3     
 4     if(!_memoryCache.TryGetValue("citys",out List<City> cityList))
 5     {
 6         cityList = GetCitys();
 7         var memoryCacheEntryOptions = new MemoryCacheEntryOptions();
 8         memoryCacheEntryOptions.SetAbsoluteExpiration(TimeSpan.FromSeconds(10));
 9         memoryCacheEntryOptions.RegisterPostEvictionCallback((object key, object value, EvictionReason reason, object state) =>
10         {
11             //在被清除缓存时，重新回调，重新填充
12             _logger.LogInformation("缓存被清除了.");
13         }, this);
14         _memoryCache.Set("citys", cityList, memoryCacheEntryOptions);
15     }
16     ViewBag.Citys = cityList;
17     return View();
18 }

4. 参数说明

示例中MemoryCacheEntryOptions，主要用于设置内存缓存参数，主要有以下几个参数可以设置：

AbsoluteExpiration 设置绝对过期时间
SlidingExpiration 滑动过期时间
PostEvictionCallbacks 缓存清除时的回调函数

分布式缓存

分布式缓存是由多个应用服务器共享的缓存，通常作为访问它的应用服务器的外部服务进行维护。分布式缓存可以提高 ASP.NET Core 应用的性能和可伸缩性，尤其是当应用由云服务或服务器场托管时。

与其他将缓存数据存储在单个应用服务器上的缓存方案相比，分布式缓存具有多个优势。分布式缓存的优点

无需Sticky Session
可扩展，适用于多台Web服务器部署的情况。
独立存储，Web服务器重启不会影响缓存
性能更好

1. 分布式缓存先决条件

为使用的分布式缓存提供程序添加包引用：

对于 Redis 分布式缓存， Microsoft.Extensions.Caching.StackExchangeRedis。
对于 SQL Server，请参阅 Microsoft.Extensions.Caching.SqlServer。
对于 NCache 分布式缓存， NCache.Microsoft.Extensions.Caching.OpenSource。

本示例主要介绍Redis分布式缓存。

2. 环境搭建

使用Redis进行缓存，首先需要搭建Redis环境。关于Redis环境，可参考之前的文章：

Redis安装与启动：https://www.cnblogs.com/hsiang/p/14224484.html
Redis基础命令：https://www.cnblogs.com/hsiang/p/14269906.html
Redis配置文件：https://www.cnblogs.com/hsiang/p/14287098.html
Redis事务：https://www.cnblogs.com/hsiang/p/14311126.html

3. 安装依赖包

Redis的分布式缓存，需要安装第三方依赖包Microsoft.Extensions.Caching.StackExchangeRedis，如下所示：

4. 添加分布式缓存服务

添加StackExchangeRedisCache服务，通过Configruation配置Redis连接信息和InstanceName实例名称。如下所示：

1 //分布式缓存
2 builder.Services.AddStackExchangeRedisCache(options =>
3 {
4     options.Configuration = "192.168.1.6:6379";
5     options.InstanceName = "redis";
6 });

5. 注入分布式缓存接口

在Controller中，注入分布式缓存接口IDistributedCache，如下所示：

1 private readonly IDistributedCache _distributedCache;
2 
3 public HomeController(ILogger<HomeController> logger ,IDistributedCache distributedCache)
4 {
5     _logger = logger;
6     _distributedCache = distributedCache;
7 }

6. 获取/设置缓存

在使用缓存的地方，获取GetString和设置SetString缓存如下所示：

 1 public IActionResult Index()
 2 {
 3     var cityList = new List<City>();
 4     var obj = _distributedCache.GetString("citys");
 5     if (string.IsNullOrEmpty(obj))
 6     {
 7         cityList = GetCitys();
 8         DistributedCacheEntryOptions options = new DistributedCacheEntryOptions();
 9         options.SetAbsoluteExpiration(TimeSpan.FromSeconds(60));
10         obj = JsonConvert.SerializeObject(cityList);
11         _distributedCache.SetString("citys", obj,options);
12     }
13     cityList = JsonConvert.DeserializeObject<List<City>>(obj);
14     ViewBag.Citys = cityList;
15     return View();
16 }

7. 运行测试

运行程序，在浏览器中默认打开Home/Index，城市列表信息首次从数据库获取，再次获取时，则会从缓存获取。如下所示：

在Redis服务器上进行查看，可以发现：

1. 缓存服务器中存储的Key是加了配置的InstanceName前缀。

2. 虽然代码中是通过SetString进行存储，由于存储的JSON序列化对象，所以Redis自动识别对象类型为hash。

3. 存储的中文在缓存服务器中是转码后的。

参考文章

官方文档：https://learn.microsoft.com/zh-cn/aspnet/core/performance/caching/overview?view=aspnetcore-6.0

以上就是ASP.NET Core MVC 从入门到精通之缓存的全部内容。