C# StackExchange.Redis 用法汇总

StackExchange.Redis 是 StackExchange（Stack Overflow 所属公司）开发的一款 Redis 客户端库。它是基于 .NET Standard 的，所以可以在各种平台上使用。StackExchange.Redis 有着良好的性能和低延迟，被广泛使用。本文将详细介绍 StackExchange.Redis 的用法和示例。

安装

StackExchange.Redis 可以使用 NuGet 包管理器安装，也可以手动下载并添加引用。

使用 NuGet 安装：

Install-Package StackExchange.Redis

手动下载：StackExchange.Redis GitHub Releases

连接 Redis 数据库

连接 Redis 需要至少一个可用的 Redis 主机和端口号。以下代码演示了如何创建连接：

using StackExchange.Redis;

// ...

// 尝试连接本地 Redis 服务器。
ConnectionMultiplexer redis = ConnectionMultiplexer.Connect("localhost");

// 连接成功后获取一个实例：通过 ConnectionMultiplexer 的 GetDatabase 方法。
IDatabase db = redis.GetDatabase();

这里创建了一个 ConnectionMultiplexer 实例，并通过 GetDatabase 方法获取了 IDatabase 实例。

操作 Redis 数据库中的 Key/Value

在 Redis 中储存的数据是以 Key/Value 的形式存在的。StackExchange.Redis 提供了许多方法，可以让我们方便地操作这些 Key/Value 对。

Set 和 Get

以下代码演示了如何向 Redis 中写入一个字符串：

string key = "message";
string value = "Hello, Redis!";

db.StringSet(key, value);

这里使用了 StringSet 方法，将字符串 "Hello, Redis!" 写入到 Redis 中的 "message" 键中。

接下来，我们可以使用 Get 方法获取这个键对应的值：

string message = db.StringGet(key);
Console.WriteLine(message);  // 输出 "Hello, Redis!"

下面的示例演示如何存储和获取一个对象：

string key = "person";
Person person = new Person() { Name = "Alice", Age = 25 };

// 序列化并存储对象。
byte[] bytes = Serialize(person);
db.StringSet(key, bytes);

// 反序列化并获取对象。
byte[] result = db.StringGet(key);
Person deserialized = Deserialize<Person>(result);

Console.WriteLine(deserialized.Name);  // 输出 "Alice"
Console.WriteLine(deserialized.Age);   // 输出 25

这里需要一个名为 Serialize 和 Deserialize 的方法，负责将对象序列化和反序列化。下面是一个示例实现：

public static byte[] Serialize<T>(T obj)
{
    if (obj == null) return null;
    BinaryFormatter formatter = new BinaryFormatter();
    using (MemoryStream stream = new MemoryStream())
    {
        formatter.Serialize(stream, obj);
        return stream.ToArray();
    }
}

public static T Deserialize<T>(byte[] data)
{
    if (data == null) return default(T);
    BinaryFormatter formatter = new BinaryFormatter();
    using (MemoryStream stream = new MemoryStream(data))
    {
        return (T)formatter.Deserialize(stream);
    }
}

注意：在生产环境中，要使用更高效的序列化方式比如 Protobuf 或 MessagePack。

删除 Key

可以使用 KeyDelete 方法删除一个键：

db.KeyDelete(key);

发布和订阅

Redis 提供了发布和订阅机制，可以让不同的客户端之间实时通信。以下代码演示了如何使用 StackExchange.Redis 进行发布和订阅：

发布者

string channel = "news";

// 创建一个 Subscriber 实例。
ISubscriber sub = redis.GetSubscriber();

// 在指定的频道发布消息。
sub.Publish(channel, "Hello, subscribers!");

这里使用了 GetSubscriber 方法创建了一个 ISubscriber 实例，并使用 Publish 方法在 "news" 频道发布了一条消息。

订阅者

string channel = "news";

// 创建一个 Subscriber 实例。
ISubscriber sub = redis.GetSubscriber();

// 订阅指定的频道，并在收到消息时输出。
sub.Subscribe(channel, (channel, message) => {
    Console.WriteLine($"Received message: {message}");
});

这里同样使用了 GetSubscriber 方法创建了一个 ISubscriber 实例，并使用 Subscribe 方法订阅了 "news" 频道。在收到消息时，用一个 lambda 表达式将消息输出到控制台。

总结

StackExchange.Redis 提供了丰富的功能，可以方便地对 Redis 数据库进行操作，同时也支持发布和订阅机制。通过本文的介绍，您应该了解了 StackExchange.Redis 的基本用法和原理，可以尝试在自己的项目中使用它了。