云數據庫 Tair(兼容 Redis)實例與原生Redis完全兼容,支持所有原生Redis支持的客戶端,連接數據庫的方式也基本相同,您可以根據自身應用特點選用任何兼容Redis協議的客戶端程序。
免費試用
阿里云免費試用面向符合條件的新用戶,提供一定時間段的免費試用阿里云產品的權益,更多信息請參見免費試用。
前提條件
根據客戶端程序的部署位置,完成下述操作:
客戶端程序部署位置 | 需完成的操作 |
ECS實例(推薦) |
|
本地 |
注意事項
如何獲取連接信息
在使用客戶端程序連接Tair(以及Redis開源版)實例時,通常您需要獲取以下信息并設置在代碼中:
需獲取的信息 | 獲取方式 |
實例的連接地址 | 實例支持多種連接地址,推薦使用專有網絡連接,可獲得更高的安全性和更低的網絡延遲。更多信息,請參見查看連接地址。 |
端口號 | 端口號默認為6379,您也可以自定義端口號。具體操作,請參見修改連接地址或端口。 |
實例的賬號(部分客戶端程序無需設置) | 實例默認會創建一個以實例ID命名的賬號(例如r-bp10noxlhcoim2****),您也可以創建一個新的賬號并賦予權限。更多信息,請參見創建與管理賬號。 |
賬號的密碼 | 根據選取賬號的不同,密碼的填寫格式有一定區別:
說明
|
常見客戶端示例
關于Tair(以及Redis開源版)支持的客戶端列表請參見Redis Clients。
本文僅列舉常見客戶端程序的代碼示例,幫助您快速連接。
Jedis
本示例使用Maven方式進行構建,您也可以手動下載Jedis客戶端。
打開編譯器,新建項目。
添加下述
pom
文件。本示例的Jedis版本為4.3.0。
<dependency> <groupId>redis.clients</groupId> <artifactId>jedis</artifactId> <version>4.3.0</version> </dependency>
在編輯器中輸入下述代碼,然后根據注釋提示修改代碼。
import redis.clients.jedis.Jedis; import redis.clients.jedis.JedisPool; import redis.clients.jedis.JedisPoolConfig; public class JedisExample { public static void main(String[] args) { JedisPoolConfig config = new JedisPoolConfig(); // 最大空閑連接數,需自行評估,不超過Redis實例的最大連接數。 config.setMaxIdle(200); // 最大連接數,需自行評估,不超過Redis實例的最大連接數。 config.setMaxTotal(300); config.setTestOnBorrow(false); config.setTestOnReturn(false); // 分別將host和password的值替換為實例的連接地址、密碼。 String host = "r-bp1s1bt2tlq3p1****pd.redis.rds.aliyuncs.com"; String password = "r-bp1s1bt2tlq3p1****:Database123"; JedisPool pool = new JedisPool(config, host, 6379, 3000, password); Jedis jedis = null; try { jedis = pool.getResource(); // 執行相關操作,示例如下。 jedis.set("foo10", "bar"); System.out.println(jedis.get("foo10")); jedis.zadd("sose", 0, "car"); jedis.zadd("sose", 0, "bike"); System.out.println(jedis.zrange("sose", 0, -1)); } catch (Exception e) { // 超時或其他異常處理。 e.printStackTrace(); } finally { if (jedis != null) { jedis.close(); } } pool.destroy(); // 當應用退出,需銷毀資源時,調用此方法。此方法會斷開連接、釋放資源。 } }
運行上述Project,預期會返回如下結果:
bar [bike, car]
重要在使用Jedis的過程中,如果設置了一些不合理的參數或錯誤使用某些功能可能會引起報錯,關于如何排查,請參見常見報錯。
PhpRedis
下載并安裝PhpRedis客戶端。
在PHP編輯器中輸入下述代碼,然后根據注釋提示修改代碼。
本示例的PHP版本為8.2.1、PhpRedis版本為5.3.7。
<?php /* 分別將host和port的值替換為實例的連接地址、端口號。 */ $host = "r-bp10noxlhcoim2****.redis.rds.aliyuncs.com"; $port = 6379; /* 分別將user和pwd的值替換為實例的賬號和密碼 */ $user = "testaccount"; $pwd = "Rp829dlwa"; $redis = new Redis(); if ($redis->connect($host, $port) == false) { die($redis->getLastError()); } if ($redis->auth([$user, $pwd]) == false) { die($redis->getLastError()); } /* 完成認證后可執行數據庫操作,下述代碼為您提供SET與GET的使用示例。 */ if ($redis->set("foo", "bar") == false) { die($redis->getLastError()); } $value = $redis->get("foo"); echo $value; ?>
執行上述代碼。
說明常見報錯與解決方法:
Cannot assign requested address
,原因分析及排查方法,請參見使用短連接訪問Redis出現“Cannot assign requested address”錯誤。redis protocol error, got ' ' as reply type byte
,請升級您的PhpRedis客戶端版本,參見GitHub issue。
redis-py
下載并安裝redis-py客戶端。
在Python編輯器中輸入下述代碼,然后根據注釋提示修改代碼。
本示例的Python版本為3.9、redis-py版本為4.4.1。
#!/usr/bin/env python #-*- coding: utf-8 -*- import redis # 分別將host和port的值替換為實例的連接地址、端口號。 host = 'r-bp10noxlhcoim2****.redis.rds.aliyuncs.com' port = 6379 # 將pwd的值替換為實例的密碼。 pwd = 'testaccount:Rp829dlwa' r = redis.Redis(host=host, port=port, password=pwd) # 連接建立后即可執行數據庫操作,下述代碼為您提供SET與GET的使用示例。 r.set('foo', 'bar') print(r.get('foo'))
執行上述代碼。
Spring Data Redis
本示例使用Maven方式進行構建,您也可以手動下載Lettuce或Jedis客戶端。
打開編譯器,新建項目。
添加下述
pom
文件,并下載Lettuce或Jedis。若使用Lettuce,不建議使用Lettuce 6.3.0以下的版本。<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.4.2</version> <relativePath/> <!-- lookup parent from repository --> </parent> <groupId>com.aliyun.tair</groupId> <artifactId>spring-boot-example</artifactId> <version>0.0.1-SNAPSHOT</version> <name>spring-boot-example</name> <description>Demo project for Spring Boot</description> <properties> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> </dependency> <dependency> <groupId>redis.clients</groupId> <artifactId>jedis</artifactId> </dependency> <dependency> <groupId>io.lettuce</groupId> <artifactId>lettuce-core</artifactId> <version>6.3.0.RELEASE</version> </dependency> <dependency> <groupId>io.netty</groupId> <artifactId>netty-transport-native-epoll</artifactId> <version>4.1.100.Final</version> <classifier>linux-x86_64</classifier> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project>
在Spring Data Redis編輯器中輸入下述代碼,然后根據注釋提示修改代碼。
本示例的Spring Data Redis版本為2.4.2。
Spring Data Redis With Jedis
@Bean JedisConnectionFactory redisConnectionFactory() { RedisStandaloneConfiguration config = new RedisStandaloneConfiguration("host", port); JedisPoolConfig jedisPoolConfig = new JedisPoolConfig(); // 最大連接數, 根據業務需要設置,不能超過實例規格規定的最大連接數。 jedisPoolConfig.setMaxTotal(30); // 最大空閑連接數, 根據業務需要設置,不能超過實例規格規定的最大連接數。 jedisPoolConfig.setMaxIdle(20); // 關閉 testOn[Borrow|Return],防止產生額外的PING。 jedisPoolConfig.setTestOnBorrow(false); jedisPoolConfig.setTestOnReturn(false); JedisClientConfiguration jedisClientConfiguration = JedisClientConfiguration.builder().usePooling().poolConfig( jedisPoolConfig).build(); return new JedisConnectionFactory(config, jedisClientConfiguration); }
Spring Data Redis With Lettuce
@Configuration public class BeanConfig { /** * TCP_KEEPALIVE打開,并且配置三個參數分別為: * TCP_KEEPIDLE = 30 * TCP_KEEPINTVL = 10 * TCP_KEEPCNT = 3 */ private static final int TCP_KEEPALIVE_IDLE = 30; /** * TCP_USER_TIMEOUT參數可以避免在故障宕機場景下,Lettuce持續超時的問題。 * refer: https://github.com/lettuce-io/lettuce-core/issues/2082 */ private static final int TCP_USER_TIMEOUT = 30; @Bean LettuceConnectionFactory redisConnectionFactory() { RedisStandaloneConfiguration config = new RedisStandaloneConfiguration(); config.setHostName("r-bp1y4is8svonly****pd.redis.rds.aliyuncs.com"); config.setPort(6379); config.setUsername("r-bp1y4is8svonly****"); config.setPassword("Da****3"); // Config TCP KeepAlive SocketOptions socketOptions = SocketOptions.builder() .keepAlive(KeepAliveOptions.builder() .enable() .idle(Duration.ofSeconds(TCP_KEEPALIVE_IDLE)) .interval(Duration.ofSeconds(TCP_KEEPALIVE_IDLE / 3)) .count(3) .build()) .tcpUserTimeout(TcpUserTimeoutOptions.builder() .enable() .tcpUserTimeout(Duration.ofSeconds(TCP_USER_TIMEOUT)) .build()) .build(); LettuceClientConfiguration lettuceClientConfiguration = LettuceClientConfiguration.builder().clientOptions( ClientOptions.builder().socketOptions(socketOptions).build()).build(); return new LettuceConnectionFactory(config, lettuceClientConfiguration); } @Bean RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory connectionFactory) { RedisTemplate<String, Object> template = new RedisTemplate<>(); template.setConnectionFactory(connectionFactory); return template; } }
執行上述代碼。
C或C++
下載并安裝C客戶端。
在C或C++編輯器中輸入下述代碼,然后根據注釋提示修改代碼。
本示例的HiRedis版本為1.1.0。
#include <stdio.h> #include <stdlib.h> #include <string.h> #include <hiredis.h> int main(int argc, char **argv) { unsigned int j; redisContext *c; redisReply *reply; if (argc < 4) { printf("Usage: example r-bp10noxlhcoim2****.redis.rds.aliyuncs.com 6379 instance_id password\n"); exit(0); } const char *hostname = argv[1]; const int port = atoi(argv[2]); const char *instance_id = argv[3]; const char *password = argv[4]; struct timeval timeout = { 1, 500000 }; // 1.5 seconds c = redisConnectWithTimeout(hostname, port, timeout); if (c == NULL || c->err) { if (c) { printf("Connection error: %s\n", c->errstr); redisFree(c); } else { printf("Connection error: can't allocate redis context\n"); } exit(1); } /* AUTH */ reply = redisCommand(c, "AUTH %s", password); printf("AUTH: %s\n", reply->str); freeReplyObject(reply); /* PING server */ reply = redisCommand(c,"PING"); printf("PING: %s\n", reply->str); freeReplyObject(reply); /* Set a key */ reply = redisCommand(c,"SET %s %s", "foo", "hello world"); printf("SET: %s\n", reply->str); freeReplyObject(reply); /* Set a key using binary safe API */ reply = redisCommand(c,"SET %b %b", "bar", (size_t) 3, "hello", (size_t) 5); printf("SET (binary API): %s\n", reply->str); freeReplyObject(reply); /* Try a GET and two INCR */ reply = redisCommand(c,"GET foo"); printf("GET foo: %s\n", reply->str); freeReplyObject(reply); reply = redisCommand(c,"INCR counter"); printf("INCR counter: %lld\n", reply->integer); freeReplyObject(reply); /* again ... */ reply = redisCommand(c,"INCR counter"); printf("INCR counter: %lld\n", reply->integer); freeReplyObject(reply); /* Create a list of numbers, from 0 to 9 */ reply = redisCommand(c,"DEL mylist"); freeReplyObject(reply); for (j = 0; j < 10; j++) { char buf[64]; snprintf(buf,64,"%d",j); reply = redisCommand(c,"LPUSH mylist element-%s", buf); freeReplyObject(reply); } /* Let's check what we have inside the list */ reply = redisCommand(c,"LRANGE mylist 0 -1"); if (reply->type == REDIS_REPLY_ARRAY) { for (j = 0; j < reply->elements; j++) { printf("%u) %s\n", j, reply->element[j]->str); } } freeReplyObject(reply); /* Disconnects and frees the context */ redisFree(c); return 0; }
編譯上述代碼。
gcc -o example -g example.c -I /usr/local/include/hiredis -lhiredis
測試運行,完成連接。
example r-bp10noxlhcoim2****.redis.rds.aliyuncs.com 6379 r-bp10noxlhcoim2**** password
.NET
請下載并安裝StackExchange.Redis 2.7.20及以上版本客戶端,更多信息請參見StackExchange.Redis升級公告。
重要不推薦使用ServiceStack.Redis或CSRedis客戶端:
若使用ServiceStack.Redis客戶端時遇到客戶端的相關問題,您需要向該公司購買相關技術支持服務。
CSRedis客戶端的原開發者已停止維護。
在StackExchange.Redis編輯器中輸入下述代碼,然后根據注釋提示修改下述示例代碼。
本示例的StackExchange.Redis版本為2.7.20。
using StackExchange.Redis; // 分別設置實例的連接地址、端口號和密碼。 private static ConfigurationOptions configurationOptions = ConfigurationOptions.Parse("r-bp10noxlhcoim2****.redis.rds.aliyuncs.com:6379,password=testaccount:Rp829dlwa,connectTimeout=2000"); //the lock for singleton private static readonly object Locker = new object(); //singleton private static ConnectionMultiplexer redisConn; //singleton public static ConnectionMultiplexer getRedisConn() { if (redisConn == null) { lock (Locker) { if (redisConn == null || !redisConn.IsConnected) { redisConn = ConnectionMultiplexer.Connect(configurationOptions); } } } return redisConn; }
說明ConfigurationOptions是StackExchange.Redis的核心,它被整個應用程序共享和重用,應該設置為單例,相關參數設置說明,請參見ConfigurationOptions。
由于
GetDatabase()
返回的對象是輕量級的,每次用的時候從ConnectionMultiplexer對象中獲取即可。redisConn = getRedisConn(); var db = redisConn.GetDatabase();
通過客戶端程序操作常見的數據結構,示例如下:
String
//set get string strKey = "hello"; string strValue = "world"; bool setResult = db.StringSet(strKey, strValue); Console.WriteLine("set " + strKey + " " + strValue + ", result is " + setResult); //incr string counterKey = "counter"; long counterValue = db.StringIncrement(counterKey); Console.WriteLine("incr " + counterKey + ", result is " + counterValue); //expire db.KeyExpire(strKey, new TimeSpan(0, 0, 5)); Thread.Sleep(5 * 1000); Console.WriteLine("expire " + strKey + ", after 5 seconds, value is " + db.StringGet(strKey)); //mset mget KeyValuePair<RedisKey, RedisValue> kv1 = new KeyValuePair<RedisKey, RedisValue>("key1", "value1"); KeyValuePair<RedisKey, RedisValue> kv2 = new KeyValuePair<RedisKey, RedisValue>("key2", "value2"); db.StringSet(new KeyValuePair<RedisKey, RedisValue>[] {kv1,kv2}); RedisValue[] values = db.StringGet(new RedisKey[] {kv1.Key, kv2.Key}); Console.WriteLine("mget " + kv1.Key.ToString() + " " + kv2.Key.ToString() + ", result is " + values[0] + "&&" + values[1]);
Hash
string hashKey = "myhash"; //hset db.HashSet(hashKey,"f1","v1"); db.HashSet(hashKey,"f2", "v2"); HashEntry[] values = db.HashGetAll(hashKey); //hgetall Console.Write("hgetall " + hashKey + ", result is"); for (int i = 0; i < values.Length;i++) { HashEntry hashEntry = values[i]; Console.Write(" " + hashEntry.Name.ToString() + " " + hashEntry.Value.ToString()); } Console.WriteLine();
List
//list key string listKey = "myList"; //rpush db.ListRightPush(listKey, "a"); db.ListRightPush(listKey, "b"); db.ListRightPush(listKey, "c"); //lrange RedisValue[] values = db.ListRange(listKey, 0, -1); Console.Write("lrange " + listKey + " 0 -1, result is "); for (int i = 0; i < values.Length; i++) { Console.Write(values[i] + " "); } Console.WriteLine();
Set
//set key string setKey = "mySet"; //sadd db.SetAdd(setKey, "a"); db.SetAdd(setKey, "b"); db.SetAdd(setKey, "c"); //sismember bool isContains = db.SetContains(setKey, "a"); Console.WriteLine("set " + setKey + " contains a is " + isContains );
Sorted Set
string sortedSetKey = "myZset"; //sadd db.SortedSetAdd(sortedSetKey, "xiaoming", 85); db.SortedSetAdd(sortedSetKey, "xiaohong", 100); db.SortedSetAdd(sortedSetKey, "xiaofei", 62); db.SortedSetAdd(sortedSetKey, "xiaotang", 73); //zrevrangebyscore RedisValue[] names = db.SortedSetRangeByRank(sortedSetKey, 0, 2, Order.Ascending); Console.Write("zrevrangebyscore " + sortedSetKey + " 0 2, result is "); for (int i = 0; i < names.Length; i++) { Console.Write(names[i] + " "); } Console.WriteLine();
node-redis
下載并安裝node-redis客戶端。
在node-redis客戶端中輸入下述代碼,然后根據注釋提示修改代碼。
本示例的Node.js版本為19.4.0、node-redis版本為4.5.1。
import { createClient } from 'redis'; // 分別設置實例的端口號、連接地址、賬號、密碼 const client = createClient({ // redis[s]://[[username][:password]@][host][:port][/db-number] url: 'redis://testaccount:Rp829dlwa@r-bp10noxlhcoim2****.redis.rds.aliyuncs.com:6379' }); client.on('error', (err) => console.log('Redis Client Error', err)); await client.connect(); await client.set('foo', 'bar'); const value = await client.get('foo'); console.log("get foo: %s", value); await client.disconnect();
說明若提示
SyntaxError: Cannot use import statement outside a module
,請將.js
文件的后綴改為.mjs
,并在調用時增加--experimental-modules
選項,例如node --experimental-modules redis.mjs
。執行上述代碼。
Go-redis
下載并安裝Go-Redis客戶端。
在Go-redis編輯器中輸入下述代碼,然后根據注釋提示修改代碼。
本示例的Go版本為1.18.5、Go-redis版本為8.11.5。
package main import ( "github.com/go-redis/redis" "fmt" ) func ExampleClient() { client := redis.NewClient(&redis.Options{ // 替換為實例的連接地址和端口 Addr: "r-bp10noxlhcoim2****.redis.rds.aliyuncs.com:6379", // 替換為實例的密碼 Password: "testaccount:Rp829dlwa", DB: 0, // use default DB }) // 下述代碼為您提供SET與GET的使用示例。 err := client.Set("foo", "bar", 0).Err() if err != nil { panic(err) } val, err := client.Get("foo").Result() if err != nil { panic(err) } fmt.Println("set : foo -> ", val) } func main() { ExampleClient() }
執行上述代碼。
Lettuce
本示例使用Maven方式進行構建,您也可以手動下載Lettuce客戶端。
打開編譯器,新建項目。
添加下述
pom
文件,并下載Lettuce 6.3.0,不建議使用Lettuce 6.3.0以下的版本。本示例的Lettuce版本為6.3.0。
<<dependencies> <dependency> <groupId>io.lettuce</groupId> <artifactId>lettuce-core</artifactId> <version>6.3.0.RELEASE</version> </dependency> <dependency> <groupId>io.netty</groupId> <artifactId>netty-transport-native-epoll</artifactId> <version>4.1.100.Final</version> <classifier>linux-x86_64</classifier> </dependency> </dependencies>
在編輯器中輸入下述代碼,然后根據注釋提示修改代碼。
import io.lettuce.core.ClientOptions; import io.lettuce.core.RedisClient; import io.lettuce.core.RedisURI; import io.lettuce.core.SocketOptions; import io.lettuce.core.SocketOptions.KeepAliveOptions; import io.lettuce.core.SocketOptions.TcpUserTimeoutOptions; import io.lettuce.core.api.StatefulRedisConnection; import io.lettuce.core.api.sync.RedisCommands; import java.time.Duration; public class LettuceExample { /** * TCP_KEEPALIVE打開,并且配置三個參數分別為: * TCP_KEEPIDLE = 30 * TCP_KEEPINTVL = 10 * TCP_KEEPCNT = 3 */ private static final int TCP_KEEPALIVE_IDLE = 30; /** * TCP_USER_TIMEOUT參數可以避免在故障宕機場景下,Lettuce持續超時的問題。 * refer: https://github.com/lettuce-io/lettuce-core/issues/2082 */ private static final int TCP_USER_TIMEOUT = 30; private static RedisClient client = null; private static StatefulRedisConnection<String, String> connection = null; public static void main(String[] args) { // 分別將host、user、password和port的值替換為實際的實例信息。 String host = "r-bp1s1bt2tlq3p1****.redis.rds.aliyuncs.com"; String user = "r-bp1s1bt2tlq3p1****"; String password = "Da****3"; int port = 6379; // Config RedisURL RedisURI uri = RedisURI.Builder .redis(host, port) .withAuthentication(user, password) .build(); // Config TCP KeepAlive SocketOptions socketOptions = SocketOptions.builder() .keepAlive(KeepAliveOptions.builder() .enable() .idle(Duration.ofSeconds(TCP_KEEPALIVE_IDLE)) .interval(Duration.ofSeconds(TCP_KEEPALIVE_IDLE/3)) .count(3) .build()) .tcpUserTimeout(TcpUserTimeoutOptions.builder() .enable() .tcpUserTimeout(Duration.ofSeconds(TCP_USER_TIMEOUT)) .build()) .build(); client = RedisClient.create(uri); client.setOptions(ClientOptions.builder() .socketOptions(socketOptions) .build()); connection = client.connect(); RedisCommands<String, String> commands = connection.sync(); System.out.println(commands.set("foo", "bar")); System.out.println(commands.get("foo")); // 當應用退出,需銷毀資源時,調用此方法。此方法會斷開連接、釋放資源。 connection.close(); client.shutdown(); } }
執行上述代碼,預期會返回如下結果:
OK bar