开源地址

Github：https://github.com/2881099/csredis (opens new window)

CSRedis 是一个 .NET 平台下的 Redis 客户端，提供了高效的操作 Redis 数据库的方法。本文将详细介绍如何在 .NET 项目中使用 CSRedis。

环境配置

首先需要安装 CSRedis 包，可以通过 NuGet 包管理器安装，或者通过命令行安装，如下所示：

Install-Package CSRedis

或者

dotnet add package CSRedis

在代码中引入 CSRedis 包：

using CSRedis;

然后创建 RedisClient 对象：

var redis = new RedisClient("localhost:6379");

上述代码中的参数 localhost:6379 表示 Redis 服务器的地址和端口号，如果需要使用 Redis 的认证机制，可以在参数中添加密码信息。

基本操作

写入数据

使用 Set 方法可以向 Redis 中写入数据，方法原型如下：

bool Set<T>(string key, T value);

其中，key 是字符串类型的键，value 可以是任意类型的值。

例如，向 Redis 中写入一个字符串类型的值：

redis.Set("name", "Tom");

向 Redis 中写入一个整型类型的值：

redis.Set("age", 18);

读取数据

使用 Get 方法可以从 Redis 中读取数据，方法原型如下：

T Get<T>(string key);

其中，key 是字符串类型的键，T 是返回值的类型，可以是任意类型。

例如，从 Redis 中读取一个字符串类型的值：

string name = redis.Get<string>("name");

从 Redis 中读取一个整型类型的值：

int age = redis.Get<int>("age");

删除数据

使用 Remove 方法可以从 Redis 中删除数据，方法原型如下：

long Remove(params string[] keys);

其中，keys 是字符串类型的键，可以删除多个键。

例如，从 Redis 中删除一个键：

redis.Remove("name");

从 Redis 中删除多个键：

redis.Remove("name", "age");

高级操作

批量操作

使用 MSet 方法可以向 Redis 中批量写入数据，方法原型如下：

bool MSet(params Tuple<string, string>[] keyValuePairs);

其中，keyValuePairs 是字符串类型的键值对数组，可以一次性向 Redis 中写入多个键值对。

例如，向 Redis 中写入多个键值对：

redis.MSet(new Tuple<string, string>[] {
    new Tuple<string, string>("name", "Tom"),
    new Tuple<string, string>("age", "18"),
    new Tuple<string, string>("gender", "male")
});

使用 MGet 方法可以从 Redis 中批量读取数据，方法原型如下：

T[] MGet<T>(params string[] keys);

其中，keys 是字符串类型的键数组，可以一次性从 Redis 中读取多个键的值。

例如，从 Redis 中读取多个键的值：

string[] values = redis.MGet<string>("name", "age", "gender");

哈希操作

使用 HSet 方法可以向 Redis 中写入哈希表数据，方法原型如下：

bool HSet(string key, string field, string value);

其中，key 是字符串类型的哈希表名，field 是字符串类型的字段名，value 是字符串类型的值。

例如，向 Redis 中写入一个哈希表：

redis.HSet("user", "name", "Tom");
redis.HSet("user", "age", "18");
redis.HSet("user", "gender", "male");

使用 HGet 方法可以从 Redis 中读取哈希表数据，方法原型如下：

string HGet(string key, string field);

其中，key 是字符串类型的哈希表名，field 是字符串类型的字段名。

例如，从 Redis 中读取一个哈希表：

string name = redis.HGet("user", "name");
string age = redis.HGet("user", "age");
string gender = redis.HGet("user", "gender");

使用 HGetAll 方法可以从 Redis 中读取整个哈希表的数据，方法原型如下：

Dictionary<string, string> HGetAll(string key);

其中，key 是字符串类型的哈希表名，返回值是一个包含所有字段和值的字典。

例如，从 Redis 中读取整个哈希表：

Dictionary<string, string> user = redis.HGetAll("user");

集合操作

使用 SAdd 方法可以向 Redis 中添加集合数据，方法原型如下：

long SAdd(string key, params string[] members);

其中，key 是字符串类型的集合名，members 是字符串类型的成员数组。

例如，向 Redis 中添加一个集合：

redis.SAdd("tags", "C#", "ASP.NET", "Redis");

使用 SMembers 方法可以从 Redis 中读取集合数据，方法原型如下：

string[] SMembers(string key);

其中，key 是字符串类型的集合名，返回值是一个包含所有成员的字符串数组。

例如，从 Redis 中读取一个集合：

string[] tags = redis.SMembers("tags");

使用 SRem 方法可以从 Redis 中删除集合数据，方法原型如下：

long SRem(string key, params string[] members);

其中，key 是字符串类型的集合名，members 是字符串类型的成员数组。

例如，从 Redis 中删除一个集合：

redis.SRem("tags", "Redis");

发布订阅操作

使用 Subscribe 方法可以订阅 Redis 的消息通道，方法原型如下：

void Subscribe(string channel, Action<string, string> onMessage);

其中，channel 是字符串类型的通道名，onMessage 是接收消息的回调函数。

例如，订阅 Redis 的消息通道：

redis.Subscribe("news", (channel, message) => {
    Console.WriteLine($"Received message: {message} from channel {channel}");
});

使用 Publish 方法可以向 Redis 的消息通道发布消息，方法原型如下：

long Publish(string channel, string message);

其中，channel 是字符串类型的通道名，message 是字符串类型的消息内容。

例如，向 Redis 的消息通道发布一条消息：

redis.Publish("news", "Hello world!");

高级配置

连接池

默认情况下，CSRedis 使用单个连接与 Redis 服务器通信。可以使用连接池来管理多个连接，提高并发性能。

使用 RedisPool 类可以创建一个连接池：

var pool = new RedisPool("localhost:6379");

使用 GetClient 方法可以从连接池中获取一个 RedisClient 对象：

using (var redis = pool.GetClient())
{
    // 使用 redis 对象进行操作
}

序列化器

默认情况下，CSRedis 使用 JSON 序列化器来序列化和反序列化数据。可以通过设置序列化器来使用其他序列化方法，例如 MessagePack、Protobuf 等。

使用 RedisClient 构造函数可以设置序列化器：

var redis = new RedisClient("localhost:6379", new ProtobufRedisSerializer());

在上述代码中，ProtobufRedisSerializer 是一个实现了 IRedisSerializer 接口的 Protobuf 序列化器。

命名空间

使用命名空间可以在多个 Redis 数据库之间进行区分，避免键名冲突。

使用 RedisClient 构造函数可以设置命名空间：

var redis = new RedisClient("localhost:6379", namespace: "myapp");

在上述代码中，命名空间被设置为 myapp，所有的键名都会以 myapp: 开头。

总结

本文详细介绍了在 .NET 项目中使用 CSRedis 的方法，包括基本操作和高级操作。通过本文的学习，读者可以快速掌握 CSRedis 的使用方法，并在实际项目中灵活运用。