C# Redis 框架开发技术详解

于 2024-09-12 13:01:30 发布
阅读量1.2k 收藏 30
点赞数 22
分类专栏： 学懂C#-高级编程技术精讲 文章标签： redis 数据库 缓存 c#
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/martian665/article/details/142146337
版权

引言

Redis 是一个高性能的键值存储系统，广泛用于缓存、消息队列和实时分析等场景。在 C# 中，有几个著名的库和框架可以方便地与 Redis 进行交互。以下是几个常用的 C# Redis 库：

  1. StackExchange.Redis: 这是目前最流行、最推荐的 C# Redis 客户端，由 StackExchange 团队（也就是开发 Stack Overflow 的团队）开发和维护。

  2. ServiceStack.Redis: 这是另一个功能齐全的 Redis 客户端，但需要注意的是，ServiceStack 是一个商业产品，对于非开源项目和商业用途可能需要付费。

  3. CSRedis: 这也是一个不错的 Redis 客户端，提供了简单易用的 API。

        其中最常用的是 StackExchange.Redis。本篇文章将深入解析 StackExchange.Redis 的概念、原理、作用、应用场景及应用实例。 

一、概念与原理

什么是 Redis

Redis（Remote Dictionary Server）是一个开源的、基于内存的数据结构存储系统，可以用作数据库、缓存和消息中间件。它支持多种数据结构，如字符串、哈希、列表、集合、有序集合等。Redis 的主要特点是速度快、支持持久化、丰富的数据结构和简单易用的 API。

什么是 StackExchange.Redis

StackExchange.Redis 是一个由 StackExchange 团队开发的 C# 客户端库，用于与 Redis 进行交互。它提供了高效、稳定且功能丰富的 API，适合在 .NET 应用中使用。

StackExchange.Redis 的基本原理

StackExchange.Redis 利用 Redis 的发布/订阅模型和数据结构，通过 TCP 连接与 Redis 服务器进行通信。它内部维护了连接池，以便高效地管理和复用连接，同时提供了丰富的异步操作支持。

二、作用与应用场景

作用

  1. 缓存：通过缓存热点数据，减少数据库的压力，提高系统性能。
  2. 消息队列：利用 Redis 的发布/订阅模型和列表结构，实现消息队列功能。
  3. 分布式锁：利用 Redis 的原子操作和过期时间，实现分布式锁。
  4. 计数器：利用 Redis 的字符串操作，快速实现计数器功能。
  5. 会话存储：将用户会话数据存储在 Redis 中，实现分布式会话管理。
  6. 排行榜：利用 Redis 的有序集合实现高效的排行榜功能。

应用场景

  1. 电商平台：缓存商品信息、库存数据、用户购物车等。
  2. 社交网络：缓存用户信息、好友列表、聊天记录等。
  3. 游戏后台：缓存玩家数据、排行榜、游戏状态等。
  4. 实时分析：缓存实时统计数据、分析结果等。
  5. 内容管理系统：缓存文章、评论、标签等。

三、应用实例

下面将通过一个详细的实例，展示如何在 C# 项目中使用 StackExchange.Redis 进行 Redis 操作。

项目准备

安装 StackExchange.Redis

首先，需要在项目中安装 StackExchange.Redis 包。可以使用 NuGet 包管理器进行安装。

使用 NuGet 命令行安装：

Install-Package StackExchange.Redis

 或者使用 .NET CLI 安装：

dotnet add package StackExchange.Redis

 

基本操作实例

连接 Redis

首先，我们需要连接到 Redis 服务器。以下是连接 Redis 的代码示例：

using System;
using StackExchange.Redis;

class Program
{
    private static ConnectionMultiplexer redis;
    private static IDatabase db;

    static void Main(string[] args)
    {
        // 连接到 Redis 服务器
        redis = ConnectionMultiplexer.Connect("localhost"); // 如果 Redis 运行在本地，使用 "localhost"
        db = redis.GetDatabase();

        Console.WriteLine("Connected to Redis");

        // 关闭连接
        redis.Close();
        Console.WriteLine("Redis connection closed.");
    }
}

在上面的代码中，我们使用 ConnectionMultiplexer.Connect 方法连接到 Redis 服务器，并使用 GetDatabase 方法获取一个 Redis 数据库实例。

字符串操作

下面展示了如何进行字符串类型键值对的操作：

// 设置一个键值对
db.StringSet("mykey", "Hello, Redis!");

// 获取键对应的值
string value = db.StringGet("mykey");
Console.WriteLine("mykey: " + value);

// 设置一个带过期时间的键
db.StringSet("mykey_expire", "This key will expire in 10 seconds", TimeSpan.FromSeconds(10));

// 获取带过期时间的键的值
value = db.StringGet("mykey_expire");
Console.WriteLine("mykey_expire: " + value);

// 等待 10 秒后再次尝试获取
System.Threading.Thread.Sleep(10000);
value = db.StringGet("mykey_expire");
Console.WriteLine("mykey_expire after 10 seconds: " + value);

 

哈希操作

下面展示了如何进行哈希类型数据的操作：

// 设置哈希字段值
db.HashSet("user:1", new HashEntry[]
{
    new HashEntry("name", "Alice"),
    new HashEntry("age", 30)
});

// 获取哈希字段值
string name = db.HashGet("user:1", "name");
int age = (int)db.HashGet("user:1", "age");
Console.WriteLine($"User: name={name}, age={age}");

// 获取所有哈希字段值
HashEntry[] hashEntries = db.HashGetAll("user:1");
foreach (var entry in hashEntries)
{
    Console.WriteLine($"{entry.Name}: {entry.Value}");
}

 

列表操作

下面展示了如何进行列表类型数据的操作：

// 添加元素到列表
db.ListRightPush("mylist", "item1");
db.ListRightPush("mylist", "item2");
db.ListRightPush("mylist", "item3");

// 获取列表长度
long length = db.ListLength("mylist");
Console.WriteLine($"List length: {length}");

// 获取列表中的所有元素
for (long i = 0; i < length; i++)
{
    string item = db.ListGetByIndex("mylist", i);
    Console.WriteLine($"List item {i}: {item}");
}

// 移除并获取列表中的第一个元素
string firstItem = db.ListLeftPop("mylist");
Console.WriteLine($"First item: {firstItem}");

 

集合操作

下面展示了如何进行集合类型数据的操作：

// 添加元素到集合
db.SetAdd("myset", "item1");
db.SetAdd("myset", "item2");
db.SetAdd("myset", "item3");

// 获取集合中的所有元素
RedisValue[] setItems = db.SetMembers("myset");
foreach (var item in setItems)
{
    Console.WriteLine($"Set item: {item}");
}

// 判断元素是否在集合中
bool isMember = db.SetContains("myset", "item2");
Console.WriteLine($"Is item2 in set: {isMember}");

有序集合操作

下面展示了如何进行有序集合类型数据的操作：

// 添加元素到有序集合
db.SortedSetAdd("myzset", "item1", 1.0);
db.SortedSetAdd("myzset", "item2", 2.0);
db.SortedSetAdd("myzset", "item3", 3.0);

// 获取有序集合中的所有元素
SortedSetEntry[] zsetItems = db.SortedSetRangeByRankWithScores("myzset");
foreach (var item in zsetItems)
{
    Console.WriteLine($"ZSet item: {item.Element}, score: {item.Score}");
}

// 获取元素的分数
double score = db.SortedSetScore("myzset", "item2");
Console.WriteLine($"Score of item2: {score}");

高级操作实例

发布/订阅

Redis 的发布/订阅模型非常适合用于消息队列和事件通知。下面是发布/订阅的示例：

using System;
using StackExchange.Redis;

class Program
{
    // 定义 Redis 连接和数据库实例
    private static ConnectionMultiplexer redis;
    private static IDatabase db;

    static void Main(string[] args)
    {
        // 连接到 Redis 服务器
        redis = ConnectionMultiplexer.Connect("localhost"); // 这里假设 Redis 运行在本地
        db = redis.GetDatabase(); // 获取 Redis 数据库实例
        ISubscriber sub = redis.GetSubscriber(); // 获取 Redis 发布/订阅实例

        // 订阅频道 "mychannel"
        sub.Subscribe("mychannel", (channel, message) =>
        {
            // 当收到消息时，打印消息内容
            Console.WriteLine($"Received message: {message}");
        });

        // 发布 5 条消息到频道 "mychannel"
        for (int i = 0; i < 5; i++)
        {
            sub.Publish("mychannel", $"Hello, Redis! {i}"); // 发布消息
            // 等待 1 秒再发布下一条消息
            System.Threading.Thread.Sleep(1000);
        }

        // 关闭 Redis 连接
        redis.Close();
    }
}

代码详解

  1. 定义 Redis 连接和数据库实例：

    private static ConnectionMultiplexer redis;
private static IDatabase db;
    • ConnectionMultiplexer redis: 用于管理 Redis 连接。
    • IDatabase db: 用于执行 Redis 数据库操作。

  2. 连接到 Redis 服务器：

    redis = ConnectionMultiplexer.Connect("localhost");
db = redis.GetDatabase();
ISubscriber sub = redis.GetSubscriber();
    • ConnectionMultiplexer.Connect("localhost"): 连接到本地运行的 Redis 服务器。
    • redis.GetDatabase(): 获取 Redis 数据库实例。
    • redis.GetSubscriber(): 获取 Redis 发布/订阅实例。

  3. 订阅频道 "mychannel"：

    sub.Subscribe("mychannel", (channel, message) =>
{
    Console.WriteLine($"Received message: {message}");
});
    • sub.Subscribe("mychannel", ...)：订阅频道 "mychannel"。
    • 当收到消息时，匿名委托 (channel, message) => { ... } 会被调用，打印消息内容。

  4. 发布消息到频道 "mychannel"：

    for (int i = 0; i < 5; i++)
{
    sub.Publish("mychannel", $"Hello, Redis! {i}");
    System.Threading.Thread.Sleep(1000);
}
    • 使用 for 循环发布 5 条消息。
    • sub.Publish("mychannel", ...)：发布消息到频道 "mychannel"。
    • System.Threading.Thread.Sleep(1000)：每次发布后等待 1 秒。

  5. 关闭 Redis 连接：

    redis.Close();
    • redis.Close()：关闭 Redis 连接。

 

在这个示例中，我们使用 Subscribe 方法订阅了一个频道，并通过 Publish 方法发布消息。

分布式锁

下面展示了如何使用 Redis 实现分布式锁：

using System;
using StackExchange.Redis;

public class RedisLock
{
    // 定义 Redis 数据库实例、锁的键、锁的值及锁的超时时间
    private readonly IDatabase db;
    private readonly string lockKey;
    private readonly string lockValue;
    private readonly TimeSpan lockTimeout;

    /// <summary>
    /// 构造函数，初始化 RedisLock 实例
    /// </summary>
    /// <param name="db">Redis 数据库实例</param>
    /// <param name="lockKey">锁的键</param>
    /// <param name="lockTimeout">锁的超时时间</param>
    public RedisLock(IDatabase db, string lockKey, TimeSpan lockTimeout)
    {
        this.db = db; // 设置 Redis 数据库实例
        this.lockKey = lockKey; // 设置锁的键
        this.lockValue = Guid.NewGuid().ToString(); // 生成一个唯一的锁值
        this.lockTimeout = lockTimeout; // 设置锁的超时时间
    }

    /// <summary>
    /// 尝试获取锁
    /// </summary>
    /// <returns>如果成功获取锁，返回 true；否则返回 false</returns>
    public bool Acquire()
    {
        // 尝试设置锁的键和值，并指定超时时间，只有键不存在时才能设置成功
        return db.StringSet(lockKey, lockValue, lockTimeout, When.NotExists);
    }

    /// <summary>
    /// 释放锁
    /// </summary>
    /// <returns>如果成功释放锁，返回 true；否则返回 false</returns>
    public bool Release()
    {
        // 只有当前实例持有的锁值与 Redis 中存储的锁值相同时，才删除锁
        if (db.StringGet(lockKey) == lockValue)
        {
            return db.KeyDelete(lockKey); // 删除锁的键
        }
        return false;
    }
}

// 使用示例
class Program
{
    static void Main(string[] args)
    {
        // 连接到 Redis 服务器
        var redis = ConnectionMultiplexer.Connect("localhost"); // 这里假设 Redis 运行在本地
        var db = redis.GetDatabase(); // 获取 Redis 数据库实例

        // 创建 RedisLock 实例，指定锁的键和超时时间
        var redisLock = new RedisLock(db, "mylock", TimeSpan.FromSeconds(30));

        // 尝试获取锁
        if (redisLock.Acquire())
        {
            Console.WriteLine("Lock acquired");

            // 执行需要锁保护的代码
            System.Threading.Thread.Sleep(5000); // 模拟需要锁保护的代码执行

            // 释放锁
            redisLock.Release();
            Console.WriteLine("Lock released");
        }
        else
        {
            Console.WriteLine("Failed to acquire lock");
        }

        // 关闭 Redis 连接
        redis.Close();
    }
}

在这个示例中，我们使用 StringSet 方法和 When.NotExists 条件来实现分布式锁的获取，使用 KeyDelete 方法来释放锁。

事务操作

Redis 支持事务操作，可以通过 IDatabase.CreateTransaction 方法来创建一个事务，并通过 ITransaction.Execute 方法来执行事务。下面是一个事务操作的示例：

using System;
using StackExchange.Redis;

class Program
{
    static void Main(string[] args)
    {
        // 连接到 Redis 服务器
        var redis = ConnectionMultiplexer.Connect("localhost"); // 这里假设 Redis 运行在本地
        var db = redis.GetDatabase(); // 获取 Redis 数据库实例

        // 创建一个事务
        var tran = db.CreateTransaction();

        // 在事务中设置键值对
        tran.StringSetAsync("key1", "value1");
        tran.StringSetAsync("key2", "value2");

        // 提交事务
        bool committed = tran.Execute();

        // 检查事务是否成功提交
        if (committed)
        {
            Console.WriteLine("Transaction committed");
        }
        else
        {
            Console.WriteLine("Transaction failed");
        }

        // 关闭 Redis 连接
        redis.Close();
    }
}

在这个示例中，我们在事务中设置了两个键值对，并通过 Execute 方法提交事务。

四、结论

        通过上面的讲解和示例，我们深入了解了 C# 中使用 StackExchange.Redis 进行 Redis 操作的基本概念、原理、作用、应用场景及具体应用实例。Redis 作为一个高性能的内存数据库，广泛应用于各种场景中，而 StackExchange.Redis 则提供了一个强大且易用的 API，可以帮助我们在 C# 项目中方便地使用 Redis。

        通过合理利用 Redis 的强大功能，可以大幅提升系统的性能和稳定性，希望本文能对你在 C# 项目中使用 Redis 提供一些帮助和参考。

 

猿享天开
关注
专栏目录
MySQL和Redis实现二级缓存的方法详解
09-09
主要给大家介绍了关于MySQL和Redis实现二级缓存的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
Redis在C#中的使用
01-17
Redis是一款开源的、高性能的键-值存储（key-value store）。它常被称作是一款数据结构服务器（data structure server）。Redis的键值可以包括字符串（strings）、哈希（hashes）、列表（lists）、集合（sets）和 有序集合（sorted sets）等数据类型。 对于这些数据类型，你可以执行原子操作。例如：对字符串进行附加操作（append）；递增哈希中的值；向列表中增加元素；计算集合的交集、并集与差集等。
C#操作redis（StackExchange.Redis）
08-27 990
/注意，如果您有一个从0到100的数字列表，LRANGE list 0 10将返回11个元素，也就是说，包含最右边的项。//偏移量start和stop是从零开始的索引，0是列表的第一个元素（列表的头），1是下一个元素，依此类推。//读出list的长度。原文链接：https://blog.csdn.net/zhiqingcn/article/details/137996641。
C# Redis
weixin_34324081的博客
04-10 280
概念 　　Redis是一个开源的使用ANSIC语言编写、支持网络、可基于内存亦可持久化的日志型、Key-Value数据库，和Memcached类似，它支持存储的value类型相对更多，包括string(字符串)、list(链表)、set(集合)、zset(sorted set --有序集合)和hash（哈希类型）。在此基础上，redis支持各种不同方式的排序。与memcached一样，为了保证...
C#-操作redis
cxu123321的博客
03-16 944
C#操作redis Redis 是一个非关系型高性能的key-value数据库。在部分场合可以对关系数据库起到很好的补充作用。它提供了Java，C/C++，C#，PHP，JavaScript，Perl，Object-C，Python，Ruby，Erlang等客户端，使用很方便。 redis提供五种数据类型:string，hash，list，set及zset(sorted set)。...
C# Redis客户端库在.NET平台的应用详解
在实际开发中，.NET的开发者通常会通过NuGet包管理器来获取所需的C# Redis客户端库，因为这样操作简单且能够自动处理依赖关系。但是，如果开发者需要将客户端库集成到一个单独的解决方案或项目中，或者需要将客户端...
【ASP.NET编程知识】.net core使用redis基于StackExchange.Redis.docx
05-15
ASP.NET Core 是一个开源的、跨平台的框架，使用 C# 语言开发。Redis 是一个基于内存的数据存储系统，可以用来存储和处理大量数据。StackExchange.Redis 是一个 Redis 客户端库，提供了对 Redis 的访问和操作。 一...
C#开发的一个远程工具
09-17
《C#技术构建远程工具详解》 在信息技术领域，远程工具是不可或缺的一部分，它使得用户可以在不同的设备之间进行有效的通信和协作。C#作为一种强大的面向对象的编程语言，以其丰富的库支持、高效的性能以及易读性强...
redis-blazor-experiments:使用Redis和Blazor组件进行实验
03-14
`redis-blazor-experiments`项目将两个重要的技术——Redis（一个高性能的键值数据库）和Blazor（一个用于构建客户端Web应用的.NET框架）结合在一起，为开发者提供了丰富的实验素材。本文将深入探讨这两个技术的集成...
C#使用Redis示例（DEMO）
12-26
主要是对于初学者有用，讲述C#使用Redis的五种类型方法示例。 本资源的图文介绍，在博客文章上有说明。 http://blog.csdn.net/ybb350680013/article/details/53884971
C#连接redis
03-01
C#连接redis，并能成功运行，希望对鞋同有帮助。连接文件也是从网上找的，但是大多数不能用，这个绝对能用。
Redis C#入门
dongfushu7972的博客
01-14 96
redis-cli.exe 为客户端 redis-server.exe 为服务端 进行操作都是在客户端上操作,先随便添加一组 key value试一下： 再输入Get "键"名称，取出值: 在C#下操作Redis，可以借助现成的类库，ServiceStack.Redis。在Nuget下直接可以下载到 ...
C#使用redis
花开莫与流年错_的博客
04-03 430
C#使用redis
在C#中使用Redis
最新发布
代码改变世界
08-30 1251
在C#中使用Redis 简单介绍下Redis的使用和WPF中的应用场景
C#使用Redis
weixin_52505520的博客
09-25 3697
Redis是一种key-value型数据库，与Sqlserver、Mysql等关系型数据库有着很大的区别，如Redis存储的数据结构不相同，还有Redis数据存于内存中，它也与Mongodb、Azure Cosmos Db、Azure TableStorage等非关系型数据库有着很大区别，Redis存在内存中，读取速度快，另外如果想通过Value来Key，Redis需要查询全部数据，然后在进行过滤等等
c#中使用redis
热门推荐
故里2130
04-24 1万+
1.在官网http://download.redis.io/releases/下载，下载后解压是这样的 2.用cd命令进入该文件夹中，然后输入redis-server redis.windows.conf，回车后，看到这个界面就是成功的 3.我这里安装了一个客户端redis-desktop-manager-0.9.0.559，有界面的管理Redis。 这里要注意一下：如果没有增加到服务中，必须打开Redis命令窗口，否则测试连接不成功。下图是增加到了服务，可以用系统path，直接运....
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

猿享天开

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值