CSRedisClient 链接字符串介绍

1. 什么是CSRedisClient?

CSRedisClient是一个用于连接Redis数据库的.NET客户端库。它提供了一套简单易用的API,使开发者可以轻松地与Redis数据库进行交互。CSRedisClient支持常见的Redis数据类型(字符串、哈希、列表、集合、有序集合等),并提供了诸多方便的方法和功能。

2. 连接字符串格式

在使用CSRedisClient连接Redis数据库之前,我们需要先设置好连接字符串。连接字符串是一个包含了连接Redis所需的信息的字符串,它的格式如下:

redis://[password@]host:port[/db][?option=value]
  • redis://:连接协议,固定为redis。
  • password@:可选部分,连接密码。
  • host:Redis服务器的主机名或IP地址。
  • port:Redis服务器的端口号。
  • /db:可选部分,指定连接的数据库,默认为0。
  • option=value:可选部分,用于设置其他的连接选项。

3. 示例代码

下面是一个使用CSRedisClient连接Redis数据库的示例代码:

using CSRedis;

// 设置连接字符串
string connectionString = "redis://localhost:6379";

// 创建CSRedisClient实例
using var redis = new CSRedisClient(connectionString);

// 连接Redis数据库
redis.Connect();

// 执行Redis命令
redis.Set("key", "value");
string result = redis.Get("key");
Console.WriteLine(result);

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

在上面的示例代码中,我们首先设置了连接字符串redis://localhost:6379,这表示连接到本地的Redis数据库,默认端口号为6379。然后创建了一个CSRedisClient实例,并调用Connect方法连接Redis数据库。接着我们执行了一个Redis命令,Set用于设置一个键值对,Get用于获取指定键的值。最后使用Close方法关闭了与Redis的连接。

4. 连接选项

CSRedisClient支持一些连接选项,可以通过连接字符串的参数来设置。下表列出了常用的连接选项及其说明:

选项 说明
defaultDatabase 设置默认的数据库编号,默认为0。
abortConnect 在连接失败时是否抛出异常,默认为true。
password 连接Redis数据库的密码。
connectTimeout 连接超时时间(毫秒),默认为5000毫秒。
syncTimeout 同步操作超时时间(毫秒),默认为2000毫秒。
poolSize 连接池最大连接数,默认为50。
ssl 是否使用SSL加密连接,默认为false。
writeBuffer 写入缓冲区大小(字节),默认为8KB。
prefix 设置所有键的前缀。
preheat 是否在连接池初始化时创建指定数量的连接,默认为false。
name 连接池的名称,默认为null。
raw 是否使用原生Redis命令,默认为false。
idleTimeout 连接空闲多长时间后断开(毫秒),默认为-1,表示不自动断开。
allowAdmin 是否允许发送ADMIN命令,默认为false。
tiebreaker 用于在连接失败时选择新连接的负载均衡策略,默认为null。
version 连接Redis数据库的版本号,用于在连接池初始化时自动分配连接,默认为null。

例如,我们可以使用以下连接字符串来设置连接选项:

string connectionString = "redis://localhost:6379?defaultDatabase=1&password=123456&poolSize=100&ssl=true&writeBuffer=4096";

在上面的连接字符串中,我们设置了默认的数据库编号为1,连接密码为123456,连接池最大连接数为100,启用了SSL加密连接,写入缓冲区大小为4KB。

5. 总结

本文介绍了CSRedisClient的链接字符串的格式和用法