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

news2024/11/24 2:45:13

1、前言

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

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

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

Microsoft.Extensions.Caching.StackExchangeRedis

在这里插入图片描述
引入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();
            });
        }
    }
}

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;

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

运行程序，发现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;

        /// <summary>
        /// 构造函数
        /// </summary>
        /// <param name="cache"></param>
        public HomeController(IDistributedCache cache)
        {
            this.cache = cache;
        }

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

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

在这里插入图片描述

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;

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

运行程序，发现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
    }
}

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

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

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

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

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

3.3、添加Redis帮助类

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

using System.Collections.Generic;

namespace App
{
    public interface IRedisCacheHelper
    {
        /// <summary>
        /// 获取缓存
        /// </summary>
        /// <typeparam name="TValue">缓存值类型</typeparam>
        /// <param name="key">键</param>
        /// <returns>缓存值</returns>
        TValue Get<TValue>(string key);

        /// <summary>
        /// 获取缓存
        /// </summary>
        /// <typeparam name="TValue">缓存值类型</typeparam>
        /// <param name="keys">键集合</param>
        /// <returns>缓存值集合</returns>
        List<TValue> Get<TValue>(List<string> keys);

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

        /// <summary>
        /// 判断缓存是否存在
        /// </summary>
        /// <param name="key">键</param>
        /// <returns>是否存在</returns>
        bool Exists(string key);

        /// <summary>
        /// 移除缓存
        /// </summary>
        /// <param name="key">键</param>
        /// <returns>是否成功</returns>
        bool Remove(string key);

        /// <summary>
        /// 移除缓存
        /// </summary>
        /// <param name="keys">键集合</param>
        /// <returns>是否成功</returns>
        bool Remove(List<string> keys);
    }
}

创建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;

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

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

        /// <summary>
        /// 获取缓存
        /// </summary>
        /// <typeparam name="TValue">缓存值类型</typeparam>
        /// <param name="keys">键集合</param>
        /// <returns>缓存值集合</returns>
        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;
        }

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

        /// <summary>
        /// 判断缓存是否存在
        /// </summary>
        /// <param name="key">键</param>
        /// <returns>是否存在</returns>
        public bool Exists(string key)
        {
            return database.KeyExists(instanceName + key);
        }

        /// <summary>
        /// 移除缓存
        /// </summary>
        /// <param name="key">键</param>
        /// <returns>是否成功</returns>
        public bool Remove(string key)
        {
            try
            {
                database.KeyDelete(instanceName + key);
                return true;
            }
            catch
            {
                return false;
            }
        }

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

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();
            });
        }
    }
}

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;

        /// <summary>
        /// 构造函数
        /// </summary>
        /// <param name="helper"></param>
        public HomeController(IRedisCacheHelper helper)
        {
            this.helper = helper;
        }

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

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

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

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

在这里插入图片描述

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

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

在这里插入图片描述

4、结语

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

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/25721.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

pytorch深度学习实战24

pytorch深度学习实战24

第二十四课 VGG网络 VGG是Oxford的Visual Geometry Group的组提出的&#xff08;大家应该能看出VGG名字的由来了&#xff09;。该网络是在ILSVRC 2014上的相关工作&#xff0c;主要工作是证明了增加网络的深度能够在一定程度上影响网络最终的性能。VGG有两种结构&#xff0c;分…
阅读更多...
远程重启电脑

远程重启电脑

一、设置电脑允许自动启动 在远程计算机上编辑设置远程注册表 步骤1. 按“WindowsR”键调用运行对话框。输入“services.msc”并点击“确定”。 步骤2. 在“服务”窗口中&#xff0c;双击“RemoteRegistry”以检查其状态。 步骤3. 将启动类型更改为“自动”。 二、查找远程计…
阅读更多...
SPARKSQL3.0-各阶段自定义扩展规则源码剖析

SPARKSQL3.0-各阶段自定义扩展规则源码剖析

一、前言 这一节主要介绍如何自定义扩展各阶段规则 虽然spark内部提供了很多优化规则&#xff0c;但在实际工作中&#xff0c;经常因为业务需求需要自定义扩展优化器或解析器&#xff0c;故自己实现一个优化器才对sparksql有更深的理解 二、扩展范围 spark在扩展方便做的很…
阅读更多...
vue.js毕业设计，基于vue.js前后端分离教室预约小程序系统设计与实现

vue.js毕业设计，基于vue.js前后端分离教室预约小程序系统设计与实现

功能介绍 【后台管理功能模块】 系统设置&#xff1a;设置关于我们、联系我们、加入我们、法律声明 广告管理&#xff1a;设置小程序首页轮播图广告和链接 留言列表&#xff1a;所有用户留言信息列表&#xff0c;支持删除 会员列表&#xff1a;查看所有注册会员信息&#xff0…
阅读更多...
从零开始学前端：DOM、BOM、焦点事件 --- 今天你学习了吗？（JS：Day20）

从零开始学前端：DOM、BOM、焦点事件 --- 今天你学习了吗？（JS：Day20）

从零开始学前端&#xff1a;程序猿小白也可以完全掌握&#xff01;—今天你学习了吗&#xff1f;&#xff08;JS&#xff09; 复习&#xff1a;从零开始学前端&#xff1a;CSSOM视图模式 — 今天你学习了吗&#xff1f;&#xff08;JS&#xff1a;Day19&#xff09; 文章目录从…
阅读更多...
java8 (jdk 1.8) 新特性——Stream ApI

java8 (jdk 1.8) 新特性——Stream ApI

在java8 中&#xff0c;有两个最重要的改变&#xff0c;一个就是之前了解的Lmbda java8 (jdk 1.8) 新特性——Lambda ,还有一个就是Stream Api 1. 什么是Stream API 简单来说就是一个类库&#xff0c;里边有一些方法方便我们对集合数据进行操作&#xff0c;就好像使用 SQL 语…
阅读更多...
Windows cmd 命令及Linux 环境下导入导入mysql 数据库

Windows cmd 命令及Linux 环境下导入导入mysql 数据库

文章目录一、背景二、Windows cmd 导入导出mysql 数据库1.导出数据库三种方式&#xff08;导出数据库时不需要连接数据库&#xff09;2. 操作步骤2.导入数据库三、linux 环境下导入导出数据库一、背景 最近在本机上安装了一个WMware 虚拟机&#xff0c;需要从本机&#xff08;…
阅读更多...
从三层架构说起，谈谈对历史项目的小改造

从三层架构说起，谈谈对历史项目的小改造

项目背景说明 最近接手一个 “老” 项目的需求修改&#xff0c;项目整体基于 .net core 3.1 平台&#xff0c;以传统的三层架构为基础构建。了解需求后&#xff0c;逐步对原有项目框架进行大概的了解&#xff0c;主要是熟悉一些框架的开发规范&#xff0c;基本工具类库的使用&…
阅读更多...
寒亭5.8万亩盐碱稻 国稻种芯·中国水稻节：山东潍坊插秧期

寒亭5.8万亩盐碱稻 国稻种芯·中国水稻节：山东潍坊插秧期

寒亭5.8万亩盐碱稻 国稻种芯中国水稻节&#xff1a;山东潍坊插秧期 新京报讯&#xff08;记者赵利新&#xff09;新闻中国采编网 中国新闻采编网 谋定研究中国智库网 中国农民丰收节国际贸易促进会 国稻种芯中国水稻节 中国三农智库网-功能性农业农业大健康大会报道&#xff…
阅读更多...
MMRotate 全面升级，新增 BoxType 设计

MMRotate 全面升级，新增 BoxType 设计

引言&#xff1a;大大降低水平框检测器改旋转框检测器的难度 MMRotate 是一个基于 PyTorch 和 MMDetection 的开源旋转框目标检测工具箱。它将目标检测从水平框扩展到旋转框&#xff0c;为场景文字、遥感影像、自动驾驶等领域的应用打下了基础&#xff0c;为学术界和产业界提供…
阅读更多...
瞄准镜-第12届蓝桥杯Scratch选拔赛真题精选

瞄准镜-第12届蓝桥杯Scratch选拔赛真题精选

[导读]&#xff1a;超平老师计划推出Scratch蓝桥杯真题解析100讲&#xff0c;这是超平老师解读Scratch蓝桥真题系列的第82讲。 蓝桥杯选拔赛每一届都要举行4~5次&#xff0c;和省赛、国赛相比&#xff0c;题目要简单不少&#xff0c;再加上篇幅有限&#xff0c;因此我精挑细选…
阅读更多...
数据结构——单链表

数据结构——单链表

一.简介 上一篇文章&#xff0c;我们介绍了线性表中的顺序表。 而顺序表拥有一些缺陷 1.空间不够时需要增容&#xff0c;增容需要付出代价 2.为避免重复扩容&#xff0c;我们进行指数扩容&#xff0c;可能会造成空间浪费 3.顺序表从开始位置连续存储&#xff0c;插入删除数…
阅读更多...
卡特尔世界杯来了，只喝精酿啤酒不玩望京扑克，其实也是一种缺失

卡特尔世界杯来了，只喝精酿啤酒不玩望京扑克，其实也是一种缺失

北京时间2022年11月20日&#xff0c;卡特尔世界杯正式拉开了序幕&#xff0c;全球都进入了世界杯时间。世界杯的开幕&#xff0c;最高兴的还是球迷朋友&#xff0c;大家可以欢聚一堂&#xff0c;喝着精酿啤酒看着足球&#xff0c;那滋味别提多舒服了。 世界杯对于广大球迷来说&…
阅读更多...
表的增删查改

表的增删查改

目录 插入数据 基本查询 更新数据 清空数据 聚合函数 group by子句 内置函数 基本查询练习 多表查询 子查询 合并查询 表的内外连接 插入数据 单行—全列插入 如下图&#xff0c;全列插入可以省略要在哪些列插入&#xff01; 多行—指定列插入 如下图&#xff0…
阅读更多...
安装 Red Hat Enterprise Linux 9.1 虚拟机

安装 Red Hat Enterprise Linux 9.1 虚拟机

目录1. 官方下载链接与新闻2. 安装提示3. 系统安装步骤&#xff08;1&#xff09;进入系统引导界面&#xff08;2&#xff09;进入【系统语言选择】界面&#xff08;3&#xff09;进入【安装信息摘要】界面① 设置【root密码】② 设置【安装目的地】&#xff08;4&#xff09;进…
阅读更多...
【python】使用python将多个视频合并、延长视频的时间

【python】使用python将多个视频合并、延长视频的时间

今天做知识分享的时候&#xff0c;最后保存的视频时长是58分钟&#xff0c;那么如何改变视频的时长&#xff0c;将视频时长改为一个小时呢&#xff1f; 下面提供3个方案&#xff1a; 方案1&#xff0c;重新录&#xff0c;很显然&#xff0c;不合理&#xff1b; 方案2&#xf…
阅读更多...
蓝屏page_fault_in_nonpaged_area的解决办法

蓝屏page_fault_in_nonpaged_area的解决办法

用户在操作电脑的过程中&#xff0c;难免会遇到蓝屏问题&#xff0c;最近就有用户遇到电脑蓝屏重启无限循环&#xff0c;提示代码page_fault_in_nonpaged_area&#xff0c;这要如何解决呢&#xff1f;下面就来看看详细的解决办法。 page_fault_in_nonpaged_area蓝屏代码解决方法…
阅读更多...
【MySQL篇】第一篇——数据库基础

【MySQL篇】第一篇——数据库基础

目录 什么是数据库 主流数据库 基本使用 MySQL安装 连接服务器 服务器管理 服务器&#xff0c;数据库&#xff0c;表关系 使用案例 创建数据库 使用数据库 创建数据库表 表中插入数据 查询表中的数据 数据逻辑存储 MySQL架构原理 MySQL整体逻辑架构 MySQL逻辑…
阅读更多...
Eureka架构篇 - 服务发现

Eureka架构篇 - 服务发现

前言 从客户端与服务端两个角度概述一下Eureka服务发现的原理&#xff0c;如下&#xff1a; 客户端 依赖自动装配机制&#xff0c;客户端启动时就会从Eureka服务端全量获取服务实例的注册信息并缓存到本地。之后每隔30秒向Eureka服务端发起增量获取的请求&#xff0c;如果增…
阅读更多...
云原生周刊 | 波音公司允许员工给开源项目做贡献

云原生周刊 | 波音公司允许员工给开源项目做贡献

如果你要问谁对开源项目的贡献最小&#xff0c;那一定是保密等级很高的国防工业机构&#xff0c;但这个魔咒最近被波音公司给打破了。在最近的一次 Linux 基金会成员峰会 keynote 演讲中&#xff0c;波音公司提到他们会在 2022 年成立一个开源办公室&#xff0c;并且从即日起&a…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023