本文介绍使用 .Net 客户端连接腾讯云分布式缓存数据库实例的示例。
准备工作
环境要求
.NET Framework 4.6.1及以上版本,或 .NET Core 3.1 及以上版本。
NuGet 包管理器。
安装客户端
推荐使用 StackExchange.Redis 客户端:
Install-Package StackExchange.Redis
或使用 ServiceStack.Redis 客户端:
Install-Package ServiceStack.Redis
获取连接信息
1. 登录 分布式缓存数据库控制台。
2. 在实例列表中,单击目标实例 ID,进入实例详情页。
3. 在网络信息区域,获取实例 VIP 地址和端口(默认6379)。
4. 在配置信息区域,获取实例的连接密码。
默认账号使用
实例 ID:密码 格式,自定义账号使用 用户名@密码 格式;免密认证实例无需密码。连接示例
代理模式下,客户端通过 Proxy 代理层提供的统一 VIP 地址连接实例,Proxy 自动处理请求路由和故障转移,客户端无需感知后端拓扑变化。
说明:
多 DB 使用说明:代理模式服务端支持多 DB(默认分配256个 DB),但 StackExchange.Redis 因自身实现限制可能无法使用
SELECT 命令切换数据库,此时只能使用 DB0。如业务依赖多 DB,请改用支持 SELECT 命令的客户端。StackExchange.Redis 连接示例(推荐)
using System;using StackExchange.Redis;class Program{static void Main(string[] args){string host = "192.xx.xx.2";int port = 6379;string password = "crs-xxxx:密码"; // 默认账号密码格式:实例ID:密码var config = new ConfigurationOptions{EndPoints = { { host, port } },Password = password,DefaultDatabase = 0,ConnectTimeout = 2000, // 连接超时(毫秒)SyncTimeout = 2000, // 同步超时(毫秒)ConnectRetry = 3, // 连接重试次数KeepAlive = 30, // 心跳间隔(秒)AbortOnConnectFail = false // 连接失败不终止};using (var redis = ConnectionMultiplexer.Connect(config)){var db = redis.GetDatabase();// 写入数据db.StringSet("name", "腾讯云分布式缓存数据库");// 读取数据var value = db.StringGet("name");Console.WriteLine($"get name: {value}");// 设置带过期时间的 Keydb.StringSet("session:user123", "session_data", TimeSpan.FromSeconds(3600));// 哈希操作db.HashSet("user:1001", new HashEntry[]{new HashEntry("name", "张三"),new HashEntry("age", "28")});var userName = db.HashGet("user:1001", "name");Console.WriteLine($"user name: {userName}");// 列表操作db.ListLeftPush("queue:tasks", new RedisValue[] { "task1", "task2", "task3" });var task = db.ListRightPop("queue:tasks");Console.WriteLine($"dequeued task: {task}");}}}
ServiceStack.Redis 连接池示例
using System;using ServiceStack.Redis;class Program{static void Main(string[] args){string host = "192.xx.xx.2";int port = 6379;string password = "crs-xxxx:密码";// ServiceStack 4.0 及以上版本连接池var manager = new PooledRedisClientManager(poolSize: 200, // 连接池大小poolTimeOutSeconds: 3, // 获取连接超时(秒)readWriteHosts: new[] { $"{password}@{host}:{port}" });using (var client = manager.GetClient()){// 写入数据client.Set("name", "腾讯云分布式缓存数据库");// 读取数据var value = client.Get<string>("name");Console.WriteLine($"get name: {value}");// 设置带过期时间的 Keyclient.Set("session:user123", "session_data", TimeSpan.FromSeconds(3600));// 哈希操作client.SetEntryInHash("user:1001", "name", "张三");client.SetEntryInHash("user:1001", "age", "28");var userName = client.GetValueFromHash("user:1001", "name");Console.WriteLine($"user name: {userName}");}manager.Dispose();}}
自定义账号连接示例
using System;using StackExchange.Redis;class Program{static void Main(string[] args){var config = new ConfigurationOptions{EndPoints = { { "192.xx.xx.2", 6379 } },Password = "myuser@MyPassword", // 代理模式自定义账号:用户名@密码整体作为密码传入,不单独设置 User(区别于直连模式 ACL 的账号名/密码分离传参)ConnectTimeout = 2000,SyncTimeout = 2000,AbortOnConnectFail = false};using (var redis = ConnectionMultiplexer.Connect(config)){var db = redis.GetDatabase();db.StringSet("key", "value");Console.WriteLine(db.StringGet("key"));}}}
SSL 加密连接示例
using System;using System.Security.Cryptography.X509Certificates;using StackExchange.Redis;class Program{static void Main(string[] args){var config = new ConfigurationOptions{EndPoints = { { "192.xx.xx.2", 6379 } },Password = "crs-xxxx:密码",Ssl = true, // 启用 SSLSslProtocols = System.Security.Authentication.SslProtocols.Tls12,ConnectTimeout = 2000,SyncTimeout = 2000,AbortOnConnectFail = false};// 证书验证回调config.CertificateValidation += (sender, cert, chain, errors) =>{// 加载 CA 证书进行验证var caCert = new X509Certificate2("/path/to/ca.pfx");return cert.Issuer == caCert.Subject;};using (var redis = ConnectionMultiplexer.Connect(config)){var db = redis.GetDatabase();db.StringSet("ssl_test", "encrypted_connection");Console.WriteLine(db.StringGet("ssl_test"));}}}
连接参数说明
StackExchange.Redis 参数
参数 | 说明 | 推荐值 |
EndPoints | 实例连接地址。代理模式为 VIP 地址,直连模式为分片节点地址 | - |
Password | 认证密码 | 默认账号格式: 实例 ID:密码 |
ConnectTimeout | 连接超时(毫秒) | 2000 |
SyncTimeout | 同步操作超时(毫秒) | 2000 |
ConnectRetry | 连接重试次数 | 3 |
KeepAlive | 心跳间隔(秒) | 30 |
AbortOnConnectFail | 连接失败是否终止 | false |
ServiceStack.Redis 参数
参数 | 说明 | 推荐值 |
poolSize | 连接池大小 | 200 |
poolTimeOutSeconds | 获取连接超时(秒) | 3 |
readWriteHosts | 读写节点地址列表 | - |
常见问题
连接超时
确认客户端所在 CVM 与分布式缓存数据库实例在同一 VPC 内。
确认安全组规则已放通对应端口。
确认连接地址和端口正确。
ConnectionMultiplexer 使用建议
ConnectionMultiplexer 是线程安全的,应作为单例全局复用,避免频繁创建和销毁。建议在应用启动时创建一次,应用退出时释放。