您可以使用多种语言的客户端连接阿里云Redis。

连接前提

  • 将ECS实例的内网IP地址或本地主机的外网IP地址加入Redis白名单。
  • 如果使用自定义账号连接Redis，连接密码格式需为<user>:<password>。例如，自定义账号的用户名为admin，密码为Rp829dlwa，则连接Redis时的密码为admin:Rp829dlwa。
  • 通过直连模式访问Redis集群版实例需要先开通直连访问，然后使用直连地址访问Redis实例。

注意事项

  • 集群架构的Redis实例默认提供的连接地址为proxy（代理）连接地址，连接方式与连接标准架构的Redis实例相同。
    说明 如果开通了直连访问，通过直连地址连接实例时，连接方式与连接开源Redis Cluster相同。
  • 如果同一VPC内的实例开启了免密访问功能，则无需提供密码信息，即可连接数据库。
  • 如果连接遇到问题，请参见Redis连接问题排查与解决。

Redis客户端

由于云数据库Redis提供的数据库服务与原生的数据库服务完全兼容，连接数据库的方式也基本类似。任何兼容Redis协议的客户端都可以访问云数据库Redis版服务，您可以根据自身应用特点选用任何Redis客户端。

Redis的客户端请参见客户端支持。

Jedis客户端

Jedis客户端访问云数据库Redis版服务，有以下两种方法：

  • Jedis单链接（不推荐使用，单次超时后无法自动恢复）
  • JedisPool连接池连接（推荐使用）

操作步骤如下：

  1. 下载并安装Jedis客户端，详细步骤请参见Jedis使用说明。
  2. Jedis单连接示例
    1. 打开Eclipse客户端，创建一个Project，输入如下代码段： 
      import redis.clients.jedis.Jedis;
public class jedistest {
public static void main(String[] args) {
try {
     String host = "xx.kvstore.aliyuncs.com";//控制台显示访问地址
     int port = 6379;
     Jedis jedis = new Jedis(host, port);
     //鉴权信息
     jedis.auth("password");//password
     String key = "redis";
     String value = "aliyun-redis";
     //select db默认为0
     jedis.select(1);
     //set一个key
     jedis.set(key, value);
     System.out.println("Set Key " + key + " Value: " + value);
     //get 设置进去的key
     String getvalue = jedis.get(key);
     System.out.println("Get Key " + key + " ReturnValue: " + getvalue);
     jedis.quit();
     jedis.close();
} 
catch (Exception e) {
 e.printStackTrace();
 }
}
}
    2. 运行上述Project，在Eclipse的控制台输出如下运行结果则表示您已成功连接云数据库Redis。 
      Set Key redis Value aliyun-redis
Get Key redis ReturnValue aliyun-redis

      接下来您就可以通过自己的本地客户端Jedis操作您的云数据库Redis。您也可以通过JedisPool连接池来连接您的云数据库Redis。

  3. JedisPool连接池示例
    1. 打开Eclipse客户端，创建一个Project，配置pom文件，具体配置如下所示： 
      <dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>2.7.2</version>
<type>jar</type>
<scope>compile</scope>
</dependency>
    2. 在project中添加如下应用： 
      import org.apache.commons.pool2.PooledObject;
import org.apache.commons.pool2.PooledObjectFactory;
import org.apache.commons.pool2.impl.DefaultPooledObject;
import org.apache.commons.pool2.impl.GenericObjectPoolConfig;
import redis.clients.jedis.HostAndPort;
import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisPool;
import redis.clients.jedis.JedisPoolConfig;
    3. 如果您的Jedis客户端版本是Jedis-2.7.2，在Project中输入如下代码： 
      JedisPoolConfig config = new JedisPoolConfig();
//最大空闲连接数, 应用自己评估，不要超过ApsaraDB for Redis每个实例最大的连接数
config.setMaxIdle(200);
//最大连接数, 应用自己评估，不要超过ApsaraDB for Redis每个实例最大的连接数
config.setMaxTotal(300);
config.setTestOnBorrow(false);
config.setTestOnReturn(false);
String host = "*.aliyuncs.com";
String password = "密码";
JedisPool pool = new JedisPool(config, host, 6379, 3000, password);
Jedis jedis = null;
try {
jedis = pool.getResource();
/// ... do stuff here ... for example
jedis.set("foo", "bar");
String foobar = jedis.get("foo");
jedis.zadd("sose", 0, "car");
jedis.zadd("sose", 0, "bike");
Set<String> sose = jedis.zrange("sose", 0, -1);
} finally {
if (jedis != null) {
jedis.close();
}
}
/// ... when closing your application:
pool.destroy();
    4. 如果您的Jedis客户端版本是Jedis-2.6、Jedis-2.5，在Project中输入如下代码： 
      JedisPoolConfig config = new JedisPoolConfig();
//最大空闲连接数, 应用自己评估，不要超过ApsaraDB for Redis每个实例最大的连接数
config.setMaxIdle(200);
//最大连接数, 应用自己评估，不要超过ApsaraDB for Redis每个实例最大的连接数
config.setMaxTotal(300);
config.setTestOnBorrow(false);
config.setTestOnReturn(false);
String host = "*.aliyuncs.com";
String password = "密码";
JedisPool pool = new JedisPool(config, host, 6379, 3000, password);
Jedis jedis = null;
boolean broken = false;
try {
     jedis = pool.getResource();
     /// ... do stuff here ... for example
     jedis.set("foo", "bar");
     String foobar = jedis.get("foo");
     jedis.zadd("sose", 0, "car");
     jedis.zadd("sose", 0, "bike");
     Set<String> sose = jedis.zrange("sose", 0, -1);
} 
catch(Exception e)
{
     broken = true;
} finally {
if (broken) {
     pool.returnBrokenResource(jedis);
} else if (jedis != null) {
     pool.returnResource(jedis);
 }
}
    5. 运行上述Project，在Eclipse的控制台输出如下运行结果则表示您已成功连接云数据库Redis。 
      Set Key redis Value aliyun-redis
Get Key redis ReturnValue aliyun-redis

      接下来您就可以通过自己的本地客户端Jedis操作您的云数据库Redis。

Lettuce客户端

Lettuce支持完整Redis API的同步和异步通信使用。由于Lettuce客户端在请求多次请求超时后，不再自动重连，当云数据库Redis因故障等因素导致代理或者数据库节点发生切换时，可能出现连接超时导致无法重连。为避免此类风险，推荐您使用Jedis客户端。

详细说明请参见Lettuce。

TairJedis客户端

TairJedis是阿里云基于Jedis开发的Redis企业版专用客户端，除了Jedis的原有功能，还支持Redis企业版数据结构模块包含的命令。

详细说明请参见GitHub。

PhpRedis客户端

操作步骤如下所示：

  1. 下载并安装PhpRedis客户端，详细步骤请参见PhpRedis使用说明。
  2. 在任何一款可以编辑PHP的编辑器中输入如下代码： 
    <?php
 /* 这里替换为连接的实例host和port */
 $host = "localhost";
 $port = 6379;
 /* 这里替换为实例ID和实例的密码 */
 $user = "test_username";
 $pwd = "test_password";
 $redis = new Redis();
 if ($redis->connect($host, $port) == false) {
         die($redis->getLastError());
   }
 if ($redis->auth($pwd) == false) {
         die($redis->getLastError());
  }
  /* 认证后就可以进行数据库操作，详情请参见https://github.com/phpRedis/phpredis */
 if ($redis->set("foo", "bar") == false) {
         die($redis->getLastError());
 }
 $value = $redis->get("foo");
 echo $value;
 ?>
  3. 执行上述代码，您就可以通过自己的本地客户端PhpRedis访问您的云数据库Redis，详情请参见官方文档 。

redis-py客户端

操作步骤如下：

  1. 下载并安装redis-py客户端，详细步骤请参见redis-py使用说明。
  2. 在任何一款可以编辑Python的编辑器中输入如下代码，即可建立连接通过本地客户端redis-py进行数据库操作。
#!/usr/bin/env python
#-*- coding: utf-8 -*-
import redis
#这里替换为连接的实例host和port
host = 'localhost'
port = 6379
#这里替换为实例password
pwd = 'test_password'
r = redis.StrictRedis(host=host, port=port, password=pwd)
#连接建立后就可以进行数据库操作，详情请参见https://github.com/andymccurdy/redis-py
r.set('foo', 'bar');
print r.get('foo')

C/C++客户端

操作步骤如下所示：

  1. 下载并编译安装Ｃ客户端，编译安装代码如下所示： 
         git clone https://github.com/redis/hiredis.git
     cd hiredis
     make 
     sudo make install
  2. 在C/C++编辑器中编写如下代码： 
         #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 xxx.kvstore.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;
     }
  3. 编译上述代码。 
    gcc -o example -g example.c -I /usr/local/include/hiredis -lhiredis
  4. 测试运行。 
     example xxx.kvstore.aliyuncs.com 6379 instance_id password

至此完成通过C/C++客户端连接云数据库Redis。

.net客户端

操作步骤如下所示：

  1. 下载并使用.net客户端。 
     git clone https://github.com/ServiceStack/ServiceStack.Redis
  2. 在.net 客户端中新建.net项目。
  3. 添加客户端引用，引用文件在库文件的ServiceStack.Redis/lib/tests中。
  4. 在新建的.net项目中输入如下代码来连接云数据库Redis。详细的接口用法请参见接口说明 。 
    using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
 using ServiceStack.Redis;
 namespace ServiceStack.Redis.Tests
 {
         class Program
 {
 public static void RedisClientTest()
 {
         string host = "127.0.0.1";/*访问host地址*/
         string password = "password";/*密码*/
         RedisClient redisClient = new RedisClient(host, 6379, password);
         string key = "test-aliyun";
         string value = "test-aliyun-value";
         redisClient.Set(key, value);
         string listKey = "test-aliyun-list";
         System.Console.WriteLine("set key " + key + " value " + value);
         string getValue = System.Text.Encoding.Default.GetString(redisClient.Get(key));
         System.Console.WriteLine("get key " + getValue);
         System.Console.Read();
 }
 public static void RedisPoolClientTest()
 {
         string[] testReadWriteHosts = new[] {
         "redis://password@127.0.0.1:6379"/*redis://密码@访问地址:端口*/
 };
 RedisConfig.VerifyMasterConnections = false;//需要设置
 PooledRedisClientManager redisPoolManager = new PooledRedisClientManager(10/*连接池个数*/, 10/*连接池超时时间*/, testReadWriteHosts);
 for (int i = 0; i < 100; i++){
         IRedisClient redisClient = redisPoolManager.GetClient();//获取连接
         RedisNativeClient redisNativeClient = (RedisNativeClient)redisClient;
         redisNativeClient.Client = null;//ApsaraDB for Redis不支持client setname所以这里需要显示的把client对象置为null
 try
 {
         string key = "test-aliyun1111";
         string value = "test-aliyun-value1111";
         redisClient.Set(key, value);
         string listKey = "test-aliyun-list";
         redisClient.AddItemToList(listKey, value);
         System.Console.WriteLine("set key " + key + " value " + value);
         string getValue = redisClient.GetValue(key);
         System.Console.WriteLine("get key " + getValue);
         redisClient.Dispose();//
 }catch (Exception e)
 {
         System.Console.WriteLine(e.Message);
 }
 }
         System.Console.Read();
 }
 static void Main(string[] args)
 {
         //单链接模式
         RedisClientTest();
         //连接池模式
         RedisPoolClientTest();
 }
 }
 }

node-redis客户端

操作步骤如下所示：

  1. 下载并安装node-redis。 
    npm install hiredis redis
  2. 在node-redis客户端中输入如下代码并执行以此连接云数据Redis版。 
     var redis = require("redis"),
 client = redis.createClient(<port>, <"host">, {detect_buffers: true});
 client.auth("password", redis.print)
    说明 port为端口，默认为6379；host为连接地址。例如： 
    client = redis.createClient(6379, "r-abcdefg.redis.rds.aliyuncs.com", {detect_buffers: true});
  3. 使用云数据Redis版。 
       // 写入数据
 client.set("key", "OK");
 // 获取数据，返回String
 client.get("key", function (err, reply) {
 console.log(reply.toString()); // print `OK`
 });
 // 如果传入一个Buffer，返回也是一个Buffer
 client.get(new Buffer("key"), function (err, reply) {
 console.log(reply.toString()); // print `<Buffer 4f 4b>`
 });
 client.quit();

C#客户端StackExchange.Redis

说明 为避免StackExchange.Redis通过执行CLUSTER NODES命令，将Redis实例判断集群模式而导致不支持多数据库功能，您需要将cluster_compat_enable设置为0，相关操作，请参见参数说明及设置方法。

操作步骤如下所示：

  1. 下载并安装StackExchange.Redis。
  2. 添加引用。 
    using StackExchange.Redis;
  3. 初始化ConnectionMultiplexer。

    ConnectionMultiplexer是StackExchange.Redis的核心，它被整个应用程序共享和重用，应该设置为单例，它的初始化如下：

     // redis config
 private static ConfigurationOptions configurationOptions = ConfigurationOptions.Parse("127.0.0.1:6379,password=xxx,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包含很多选项，例如keepAlive、connectRetry、name，详情请参见StackExchange.Redis.ConfigurationOptions。

  4. GetDatabase()返回的对象是轻量级的，每次用的时候从ConnectionMultiplexer对象中获取即可。 
     redisConn = getRedisConn();
 var db = redisConn.GetDatabase();
  5. 下面给出5种数据结构的demo，它们的API和原生略有不同，分别用String、Hash、List、Set、Sorted Set开头代表5种数据结构。

    • 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();