Redis的发布订阅模式是一种消息通信模式,发送者将消息发送到指定频道,订阅该频道的所有客户端都能收到消息,非常适合实时消息广播、事件通知等场景。在C#项目中我们可以通过StackExchange.Redis库快速实现该模式。

环境准备
首先需要在C#项目中引入StackExchange.Redis库,如果你使用的是Visual Studio,可以通过NuGet包管理器搜索StackExchange.Redis安装,也可以通过命令行执行以下命令安装:
// 使用NuGet命令行安装依赖 Install-Package StackExchange.Redis
安装完成后,需要先准备一个可用的Redis服务,本地测试可以使用默认配置的Redis实例,端口为6379,无密码即可。
Redis连接管理
在C#中操作Redis首先需要创建连接对象,为了避免重复创建连接造成资源浪费,我们可以封装一个单例的连接管理类:
using StackExchange.Redis;
using System;
public class RedisManager
{
// 单例实例
private static readonly Lazy<ConnectionMultiplexer> _instance = new Lazy<ConnectionMultiplexer>(() =>
{
// Redis连接字符串,本地默认实例配置
string redisConnection = "127.0.0.1:6379";
return ConnectionMultiplexer.Connect(redisConnection);
});
// 获取连接对象
public static ConnectionMultiplexer Instance => _instance.Value;
// 获取数据库对象,默认使用0号库
public static IDatabase GetDatabase(int dbIndex = 0)
{
return Instance.GetDatabase(dbIndex);
}
}
实现消息发布功能
发布消息的逻辑比较简单,只需要获取到Redis的订阅者对象,调用Publish方法向指定频道发送消息即可:
using StackExchange.Redis;
using System;
public class RedisPublisher
{
// 发布消息到指定频道
public static void PublishMessage(string channel, string message)
{
// 获取订阅者对象
ISubscriber subscriber = RedisManager.Instance.GetSubscriber();
// 向指定频道发布消息,返回接收到消息的客户端数量
long receiveCount = subscriber.Publish(channel, message);
Console.WriteLine($"消息已发布到频道[{channel}],共有{receiveCount}个客户端收到消息");
}
}
实现消息订阅功能
订阅功能需要注册频道的回调方法,当频道有新消息时,回调方法会自动触发处理消息:
using StackExchange.Redis;
using System;
public class RedisSubscriber
{
// 订阅指定频道的消息
public static void SubscribeChannel(string channel, Action<string, string> messageHandler)
{
// 获取订阅者对象
ISubscriber subscriber = RedisManager.Instance.GetSubscriber();
// 注册频道订阅回调
subscriber.Subscribe(channel, (redisChannel, value) =>
{
// 将RedisValue转换为字符串,调用外部传入的处理逻辑
string message = value.ToString();
messageHandler(redisChannel, message);
});
Console.WriteLine($"已成功订阅频道[{channel}],等待接收消息...");
}
}
完整示例演示
下面我们编写一个控制台程序,模拟一个发布者和两个订阅者的场景,验证发布订阅功能是否正常:
using System;
using System.Threading;
class Program
{
static void Main(string[] args)
{
// 定义两个订阅者,订阅同一个频道
RedisSubscriber.SubscribeChannel("realtime_notice", (channel, message) =>
{
Console.WriteLine($"订阅者1收到频道[{channel}]的消息:{message}");
});
RedisSubscriber.SubscribeChannel("realtime_notice", (channel, message) =>
{
Console.WriteLine($"订阅者2收到频道[{channel}]的消息:{message}");
});
// 等待订阅注册完成
Thread.Sleep(1000);
// 发布者向频道发送三条消息
for (int i = 1; i <= 3; i++)
{
string message = $"实时通知第{i}条,发送时间:{DateTime.Now:HH:mm:ss}";
RedisPublisher.PublishMessage("realtime_notice", message);
Thread.Sleep(500);
}
Console.WriteLine("消息发送完成,按任意键退出");
Console.ReadKey();
}
}
注意事项
- Redis发布订阅模式没有消息持久化能力,如果客户端在消息发布时未订阅该频道,就会错过这条消息,如果需要持久化消息可以考虑使用Redis的Stream结构。
- 订阅回调中的逻辑尽量不要执行耗时操作,避免阻塞消息接收线程,如果有耗时操作可以放到单独的线程中处理。
- 当Redis连接断开时,订阅会自动取消,实际生产环境中需要添加重连机制,重新订阅之前的频道。
常见问题说明
如果发布消息后订阅者没有收到消息,可以先检查以下几点:
- 确认发布和订阅使用的是同一个Redis实例,频道名称是否完全一致,区分大小写。
- 确认订阅者是在消息发布之前就完成了订阅注册,避免消息发送时订阅还未生效。
- 检查Redis服务是否正常运行,连接字符串配置是否正确。