• ASP.NET Core 3.1系列（14）——分布式缓存Redis的使用

    1、前言

    前一篇博客介绍了ASP.NET Core中本地缓存MemoryCache的使用方法。相较于本地缓存，分布式缓存更加适合大多数项目应用场景，下面就来介绍一下如何在ASP.NET Core中对Redis缓存进行相关操作。

    2、分布式缓存接口——IDistributedCache

    对于分布式缓存，微软提供了IDistributedCache接口进行相关操作，该接口支持SQL Server、NCache、Redis等多种缓存。其包含的方法如下所示：
    在这里插入图片描述
    虽然IDistributedCache接口提供的方法较少，但对于简单的缓存操作完全够用。本文以Redis为例，因此需要使用Nuget引入如下程序包：

    Microsoft.Extensions.Caching.StackExchangeRedis

    • 1

    在这里插入图片描述
    引入Redis相关组件后，需要在Startup.cs中添加相关服务，代码如下：

    using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

namespace App
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();

            // 添加Redis缓存服务
            services.AddStackExchangeRedisCache(options =>
            {
                options.Configuration = "127.0.0.1:6379";
                options.InstanceName = "App:";
            });
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.UseHttpsRedirection();
            app.UseRouting();
            app.UseAuthorization();
            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
            });
        }
    }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48

    2.1、创建缓存

    创建缓存的代码如下：

    using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Caching.Distributed;

namespace App.Controllers
{
    [Route("api/[controller]/[action]")]
    [ApiController]
    public class HomeController : ControllerBase
    {
        private readonly IDistributedCache cache;

        /// 
        /// 构造函数
        /// 
        /// 
        public HomeController(IDistributedCache cache)
        {
            this.cache = cache;
        }
        
        /// 
        /// 设置缓存
        /// 
        /// 
        [HttpGet]
        public ActionResult<string> SetCache()
        {
            cache.SetString("UserName", "admin");
            cache.SetString("Password", "12345");
            return "设置缓存成功";
        }
    }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34

    运行程序，发现Redis中已经创建了对应缓存，如下图所示：

    在这里插入图片描述

    2.2、读取缓存

    读取缓存的代码如下：

    using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Caching.Distributed;

namespace App.Controllers
{
    [Route("api/[controller]/[action]")]
    [ApiController]
    public class HomeController : ControllerBase
    {
        private readonly IDistributedCache cache;

        /// 
        /// 构造函数
        /// 
        /// 
        public HomeController(IDistributedCache cache)
        {
            this.cache = cache;
        }

        /// 
        /// 获取缓存
        /// 
        /// 
        [HttpGet]
        public ActionResult<string> GetCache()
        {
            string userName = cache.GetString("UserName");
            string password = cache.GetString("Password");
            return $"用户名：{userName}\n密码：{password}";
        }
    }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34

    运行程序，发现能够读取对应缓存，如下图所示：

    在这里插入图片描述

    2.3、删除缓存

    删除缓存的代码如下：

    using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Caching.Distributed;

namespace App.Controllers
{
    [Route("api/[controller]/[action]")]
    [ApiController]
    public class HomeController : ControllerBase
    {
        private readonly IDistributedCache cache;

        /// 
        /// 构造函数
        /// 
        /// 
        public HomeController(IDistributedCache cache)
        {
            this.cache = cache;
        }
        
        /// 
        /// 删除缓存
        /// 
        /// 
        [HttpGet]
        public ActionResult<string> RemoveCache()
        {
            cache.Remove("UserName");
            cache.Remove("Password");
            return "删除缓存成功";
        }
    }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34

    运行程序，发现Redis中已经删除了对应缓存，如下图所示：

    在这里插入图片描述

    3、自定义缓存帮助类——RedisCacheHelper

    3.1、添加Redis配置参数

    在appsettings.json文件中添加配置参数RedisSettings，其中：Connection表示连接字符串，InstanceName表示实例名称，Database表示Redis中的数据库编号，代码如下所示：

    {
    "Logging": {
        "LogLevel": {
            "Default": "Information",
            "Microsoft": "Warning",
            "Microsoft.Hosting.Lifetime": "Information"
        }
    },
    "AllowedHosts": "*",
    "RedisSettings": {
        "Connection": "127.0.0.1:6379",
        "InstanceName": "App:",
        "Database": 2
    }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15

    3.2、添加实体类映射配置参数

    创建一个实体类RedisSettings.cs，该类用以映射配置参数，代码如下所示：

    namespace App
{
    public class RedisSettings
    {
        /// 
        /// 连接字符串
        /// 
        public string Connection { get; set; }

        /// 
        /// 实例名称
        /// 
        public string InstanceName { get; set; }

        /// 
        /// 数据库编号
        /// 
        public int Database { get; set; }
    }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20

    3.3、添加Redis帮助类

    创建IRedisCacheHelper接口，代码如下所示：

    using System.Collections.Generic;

namespace App
{
    public interface IRedisCacheHelper
    {
        /// 
        /// 获取缓存
        /// 
        /// 缓存值类型
        /// 键
        /// 缓存值
        TValue Get<TValue>(string key);

        /// 
        /// 获取缓存
        /// 
        /// 缓存值类型
        /// 键集合
        /// 缓存值集合
        List<TValue> Get<TValue>(List<string> keys);

        /// 
        /// 设置缓存
        /// 
        /// 缓存值类型
        /// 键
        /// 值
        /// 过期时间
        /// 是否滑动过期
        /// 是否成功
        bool Set<TValue>(string key, TValue value, int expires = 0, bool isSliding = false);

        /// 
        /// 判断缓存是否存在
        /// 
        /// 键
        /// 是否存在
        bool Exists(string key);

        /// 
        /// 移除缓存
        /// 
        /// 键
        /// 是否成功
        bool Remove(string key);

        /// 
        /// 移除缓存
        /// 
        /// 键集合
        /// 是否成功
        bool Remove(List<string> keys);
    }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50
    • 51
    • 52
    • 53
    • 54
    • 55

    创建RedisCacheHelper类实现IRedisCacheHelper接口，这里的代码会把数据全部以JSON的形式存入Redis，因此需要引入Newtonsoft.Json组件，代码如下所示：

    using Microsoft.Extensions.Caching.StackExchangeRedis;
using Newtonsoft.Json;
using StackExchange.Redis;
using System.Collections.Generic;

namespace App
{
    public class RedisCacheHelper : IRedisCacheHelper
    {
        private readonly IDatabase database;
        private readonly ConnectionMultiplexer connection;
        private readonly string instanceName;

        /// 
        /// 构造函数
        /// 
        /// 
        /// 
        public RedisCacheHelper(RedisCacheOptions options, int database = 0)
        {
            this.connection = ConnectionMultiplexer.Connect(options.Configuration);
            this.database = connection.GetDatabase(database);
            this.instanceName = options.InstanceName;
        }

        /// 
        /// 获取缓存
        /// 
        /// 缓存值类型
        /// 键
        /// 缓存值
        public TValue Get<TValue>(string key)
        {
            string json = database.StringGet(instanceName + key);
            return JsonConvert.DeserializeObject<TValue>(json);
        }

        /// 
        /// 获取缓存
        /// 
        /// 缓存值类型
        /// 键集合
        /// 缓存值集合
        public List<TValue> Get<TValue>(List<string> keys)
        {
            List<TValue> list = new List<TValue>();
            foreach (string key in keys)
            {
                TValue value = JsonConvert.DeserializeObject<TValue>(database.StringGet(instanceName + key));
                list.Add(value);
            }
            return list;
        }

        /// 
        /// 设置缓存
        /// 
        /// 缓存值类型
        /// 键
        /// 值
        /// 过期时间
        /// 是否滑动过期
        /// 是否成功
        public bool Set<TValue>(string key, TValue value, int expires = 0, bool isSliding = false)
        {
            return database.StringSet(instanceName + key, JsonConvert.SerializeObject(value));
        }

        /// 
        /// 判断缓存是否存在
        /// 
        /// 键
        /// 是否存在
        public bool Exists(string key)
        {
            return database.KeyExists(instanceName + key);
        }

        /// 
        /// 移除缓存
        /// 
        /// 键
        /// 是否成功
        public bool Remove(string key)
        {
            try
            {
                database.KeyDelete(instanceName + key);
                return true;
            }
            catch
            {
                return false;
            }
        }

        /// 
        /// 移除缓存
        /// 
        /// 键集合
        /// 是否成功
        public bool Remove(List<string> keys)
        {
            try
            {
                foreach (string key in keys)
                {
                    database.KeyDelete(instanceName + key);
                }
                return true;
            }
            catch
            {
                return false;
            }
        }
    }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50
    • 51
    • 52
    • 53
    • 54
    • 55
    • 56
    • 57
    • 58
    • 59
    • 60
    • 61
    • 62
    • 63
    • 64
    • 65
    • 66
    • 67
    • 68
    • 69
    • 70
    • 71
    • 72
    • 73
    • 74
    • 75
    • 76
    • 77
    • 78
    • 79
    • 80
    • 81
    • 82
    • 83
    • 84
    • 85
    • 86
    • 87
    • 88
    • 89
    • 90
    • 91
    • 92
    • 93
    • 94
    • 95
    • 96
    • 97
    • 98
    • 99
    • 100
    • 101
    • 102
    • 103
    • 104
    • 105
    • 106
    • 107
    • 108
    • 109
    • 110
    • 111
    • 112
    • 113
    • 114
    • 115
    • 116
    • 117
    • 118

    3.4、注册Redis帮助类

    配置参数、实体类、帮助类已经定义完毕，接下来就是在Startup.cs文件中注册了，代码如下：

    using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Caching.StackExchangeRedis;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

namespace App
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();

            // 获取实体类
            var settings = Configuration.GetSection("RedisSettings").Get<RedisSettings>();

            // 设置配置参数
            var options = new RedisCacheOptions
            {
                InstanceName = settings.InstanceName,
                Configuration = settings.Connection
            };

            // 实例化帮助类
            var helper = new RedisCacheHelper(options, settings.Database);
            services.AddSingleton<IRedisCacheHelper>(helper);
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.UseHttpsRedirection();
            app.UseRouting();
            app.UseAuthorization();
            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
            });
        }
    }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50
    • 51
    • 52
    • 53
    • 54
    • 55
    • 56

    3.5、Controller中注入Redis帮助类

    在HomeController中添加如下代码：

    using Microsoft.AspNetCore.Mvc;

namespace App.Controllers
{
    [Route("api/[controller]/[action]")]
    [ApiController]
    public class HomeController : ControllerBase
    {
        private readonly IRedisCacheHelper helper;

        /// 
        /// 构造函数
        /// 
        /// 
        public HomeController(IRedisCacheHelper helper)
        {
            this.helper = helper;
        }

        /// 
        /// 设置缓存
        /// 
        /// 
        [HttpGet]
        public ActionResult<string> SetCache()
        {
            helper.Set<string>("UserName", "admin");
            helper.Set<string>("Password", "12345");
            return "设置缓存成功";
        }

        /// 
        /// 获取缓存
        /// 
        /// 
        [HttpGet]
        public ActionResult<string> GetCache()
        {
            return helper.Get<string>("UserName") + "\n" +
                   helper.Get<string>("Password");
        }

        /// 
        /// 删除缓存
        /// 
        /// 
        [HttpGet]
        public ActionResult<string> RemoveCache()
        {
            if (helper.Exists("UserName"))
            {
                helper.Remove("UserName");
            }
            if (helper.Exists("Password"))
            {
                helper.Remove("Password");
            }
            return "删除缓存成功";
        }
    }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50
    • 51
    • 52
    • 53
    • 54
    • 55
    • 56
    • 57
    • 58
    • 59
    • 60
    • 61

    当执行SetCache方法时，运行结果如下所示，可以发现在编号为2的数据库中添加了两个缓存：

    在这里插入图片描述

    当执行GetCache方法时，运行结果如下所示，可以发现能够正确读取对应缓存：

    在这里插入图片描述
    当执行RemoveCache方法时，运行结果如下所示，可以发现2号数据库已经清除了对应缓存：

    在这里插入图片描述

    4、结语

    本文主要介绍了ASP.NET Core中Redis缓存的简单使用方法，在实际开发中Redis的应用相当广泛，有兴趣的同志可自行深入研究其用法。

  • 相关阅读:
    Apache Paimon 使用之 Querying Tables
    微信小程序关闭首页广告
    YOLOv3&YOLOv5输出结果说明
    软件测试全套教程，软件测试自学线路图
    什么是代理模式，用 Python 如何实现 Proxy（代理 或 Surrogate）对象结构型模式？
    Jmeter系列-Jmeter面板介绍和常用配置（2）
    多进程间通信学习之有名管道
    阿里DataX极简教程
    12.4泛型 map set
    【浙大版《Python 程序设计》题目集（解）】第6章-6 求指定层的元素个数（40分）
  • 原文地址：https://blog.csdn.net/HerryDong/article/details/126866280