Tair (Redis® OSS-Compatible)：Panduan Koneksi

Spring Data Redis

Contoh ini menggunakan Maven untuk pembuatan. Anda juga dapat mengunduh secara manual klien Lettuce atau Jedis.

1. Buka kompiler dan buat proyek.

2. Tambahkan file pom berikut untuk mengunduh Lettuce atau Jedis.

   Penting

   Jika Anda menggunakan Lettuce, kami sarankan menggunakan versi 6.3.0.RELEASE atau yang lebih baru dan konfigurasikan parameter TCP_USER_TIMEOUT. Ini mencegah penyaringan blackhole pada klien Lettuce.

   <?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>

3. Masukkan kode berikut di editor Spring Data Redis dan modifikasi berdasarkan komentar.

   Dalam contoh ini, Spring Data Redis 2.4.2 digunakan.

   • Spring Data Redis dengan Jedis

     @Configuration
     public class RedisConfig {
         
         @Bean
         JedisConnectionFactory redisConnectionFactory() {
             //Contoh ini hanya untuk pengujian koneksi. Di lingkungan produksi, kami sarankan Anda menyimpan informasi koneksi di file konfigurasi dan mengambil informasi tersebut menggunakan anotasi @Value.
             //Anda dapat memperoleh endpoint (hostName) dan nomor port (port) dari bagian Informasi Koneksi halaman Informasi Instans. Pilih koneksi VPC atau publik berdasarkan lingkungan jaringan klien Anda.
             RedisStandaloneConfiguration config = new RedisStandaloneConfiguration("r-8vbwds91ie1rdl****.redis.zhangbei.rds.aliyuncs.com", 6379);
             //Masukkan kata sandi dalam format username:kata sandi. Contohnya, jika nama pengguna adalah testaccount dan kata sandi adalah Rp829dlwa, masukkan testaccount:Rp829dlwa sebagai kata sandi.
             //Jika Anda lupa nama pengguna atau kata sandi, klik Manajemen Akun di panel navigasi kiri halaman detail instans untuk mereset kata sandi atau membuat akun.
             config.setPassword(RedisPassword.of("username:password"));
             JedisPoolConfig jedisPoolConfig = new JedisPoolConfig();
             // Tentukan jumlah maksimum koneksi sesuai kebutuhan. Nilai ini tidak boleh melebihi jumlah maksimum koneksi yang didukung oleh tipe instans.
             jedisPoolConfig.setMaxTotal(30);
             // Tentukan jumlah maksimum koneksi idle sesuai kebutuhan. Nilai ini tidak boleh melebihi jumlah maksimum koneksi yang didukung oleh tipe instans.
             jedisPoolConfig.setMaxIdle(20);
             // Nonaktifkan testOn[Borrow|Return] untuk mencegah perintah PING tambahan dihasilkan.
             jedisPoolConfig.setTestOnBorrow(false);
             jedisPoolConfig.setTestOnReturn(false);
     
             JedisClientConfiguration jedisClientConfiguration = JedisClientConfiguration.builder().usePooling().poolConfig(
                     jedisPoolConfig).build();
     
             return new JedisConnectionFactory(config, jedisClientConfiguration);
         }
         @Bean
         public RedisTemplate<String, Object> redisTemplate() {
             RedisTemplate<String, Object> template = new RedisTemplate<>();
             template.setConnectionFactory(redisConnectionFactory());
             template.setKeySerializer(new StringRedisSerializer());
             template.setValueSerializer(new GenericJackson2JsonRedisSerializer());
             return template;
         }
     }

   • Spring Data Redis dengan Lettuce (termasuk konfigurasi parameter TCP_USER_TIMEOUT)

     @Configuration
     public class BeanConfig {
         /**
          * Aktifkan TCP keepalive dan konfigurasikan tiga parameter berikut:
          * TCP_KEEPIDLE = 30
          * TCP_KEEPINTVL = 10
          * TCP_KEEPCNT = 3
          */
         private static final int TCP_KEEPALIVE_IDLE = 30;
     
         /**
          * Parameter TCP_USER_TIMEOUT dapat mencegah Lettuce terus timeout dalam kasus kegagalan atau kerusakan.
          * Referensi: 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");
     
             // Konfigurasi 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;
         }
     }

Jedis

Contoh ini menggunakan Maven untuk pembuatan. Anda juga dapat mengunduh secara manual klien Jedis.

1. Buka kompiler dan buat proyek.

2. Tambahkan kode berikut ke file pom.xml.

   Dalam contoh ini, Jedis 4.3.0 digunakan.

   <dependency>
       <groupId>redis.clients</groupId>
       <artifactId>jedis</artifactId>
       <version>4.3.0</version>
   </dependency>

3. Masukkan kode berikut di editor dan modifikasi berdasarkan komentar:

   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();
           // Tentukan jumlah maksimum koneksi idle berdasarkan kebutuhan Anda. Nilai ini tidak boleh melebihi jumlah maksimum koneksi yang didukung oleh instans Redis.
           config.setMaxIdle(200);
           // Tentukan jumlah maksimum koneksi berdasarkan kebutuhan Anda. Nilai ini tidak boleh melebihi jumlah maksimum koneksi yang didukung oleh instans Redis.
           config.setMaxTotal(300);
           config.setTestOnBorrow(false);
           config.setTestOnReturn(false);
           // Ganti nilai hostname dan password dengan endpoint dan kata sandi instans.
           String hostname = "r-bp1s1bt2tlq3p1****pd.redis.rds.aliyuncs.com";
           // Untuk akun default, Anda dapat langsung memasukkan kata sandi. Untuk akun baru, masukkan kata sandi dalam format user:kata sandi. Contohnya, jika akun baru adalah testaccount dan kata sandi adalah Rp829dlwa, masukkan testaccount:Rp829dlwa.
           String password = "r-bp1s1bt2tlq3p1****:Database123";
           JedisPool pool = new JedisPool(config, hostname, 6379, 3000, password);
           Jedis jedis = null;
           try {
               jedis = pool.getResource();
               // Lakukan operasi terkait. Kode berikut memberikan contoh.
               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) {
               // Tangani timeout atau pengecualian lainnya.
               e.printStackTrace();
           }
           finally {
               if (jedis != null) {
                   jedis.close();
               }
           }
           pool.destroy();    // Saat aplikasi keluar dan sumber daya perlu dihancurkan, panggil metode ini. Metode ini memutuskan koneksi dan melepaskan sumber daya.
       }
   }

4. Jalankan proyek sebelumnya. Output berikut diharapkan:

   bar
   [bike, car]

redis-py

1. Unduh dan instal klien redis-py.

2. Masukkan kode berikut di editor Python dan modifikasi berdasarkan komentar.

   Dalam contoh ini, Python 3.9 dan redis-py 4.4.1 digunakan.

   #!/usr/bin/env python
   #-*- coding: utf-8 -*-
   import redis
   # Ganti nilai hostname dan port dengan endpoint dan nomor port instans.
   hostname = 'r-bp10noxlhcoim2****.redis.rds.aliyuncs.com'
   port = 6379
   # Ganti nilai pwd dengan kata sandi instans.
   # Untuk akun default, Anda dapat langsung memasukkan kata sandi. Untuk akun baru, masukkan kata sandi dalam format user:kata sandi. Contohnya, jika akun baru adalah testaccount dan kata sandi adalah Rp829dlwa, masukkan testaccount:Rp829dlwa.
   password = 'testaccount:Rp829dlwa'
   r = redis.Redis(host=hostname, port=port, password=password)
   # Setelah koneksi dibuat, Anda dapat melakukan operasi database. Kode berikut memberikan contoh cara menggunakan SET dan GET.
   r.set('foo', 'bar')
   print(r.get('foo'))

3. Jalankan proyek sebelumnya. Output berikut diharapkan:

   b'bar'

PhpRedis

1. Unduh dan instal klien PhpRedis.

2. Masukkan kode berikut di editor PHP dan modifikasi berdasarkan komentar.

   Dalam contoh ini, PHP 8.2.1 dan PhpRedis 5.3.7 digunakan.

   <?php
    /* Ganti nilai hostname dan port dengan endpoint dan nomor port instans. */
    $hostname = "r-bp10noxlhcoim2****.redis.rds.aliyuncs.com";
    $port = 6379;
    /* Ganti nilai user dan password dengan akun dan kata sandi instans. */
    $user = "testaccount";
    $password = "Rp829dlwa";
    $redis = new Redis();
    if ($redis->connect($hostname, $port) == false) {
            die($redis->getLastError());
      }
    if ($redis->auth([$user, $password]) == false) {
            die($redis->getLastError());
     }
     /* Setelah autentikasi, Anda dapat melakukan operasi database. Kode berikut memberikan contoh cara menggunakan SET dan GET. */
    if ($redis->set("foo", "bar") == false) {
            die($redis->getLastError());
    }
    $value = $redis->get("foo");
    echo $value;
    ?>

3. Jalankan kode sebelumnya.

   Catatan

   Kesalahan umum dan solusi:

   • Cannot assign requested address: Untuk informasi tentang penyebab dan solusi kesalahan ini, lihat Apa yang harus saya lakukan jika kesalahan "Cannot assign requested address" dikembalikan.

   • redis protocol error, got ' ' as reply type byte: Perbarui versi klien PhpRedis Anda. Untuk informasi lebih lanjut, kunjungi GitHub.

C atau C++

1. Unduh dan instal klien C.

2. Masukkan kode berikut di editor C atau C++ dan modifikasi berdasarkan komentar.

   Dalam contoh ini, hiredis 1.1.0 digunakan.

   #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 detik
       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. Kompilasi kode.

   gcc -o example -g example.c -I /usr/local/include/hiredis -lhiredis

4. Lakukan uji coba dan hubungkan ke instans.

    ./example r-bp10noxlhcoim2****.redis.rds.aliyuncs.com 6379 r-bp10noxlhcoim2**** password

.NET

1. Unduh dan instal StackExchange.Redis 2.7.20 atau yang lebih baru. Untuk informasi lebih lanjut, lihat Pemberitahuan tentang pembaruan StackExchange.Redis.

   Penting

   Kami sarankan Anda tidak menggunakan klien ServiceStack Redis atau CSRedis.

   • Jika Anda menggunakan ServiceStack Redis dan mengalami masalah terkait klien, Anda harus membeli dukungan teknis dari ServiceStack.

   • Dukungan untuk klien CSRedis telah dihentikan.

2. Masukkan kode berikut di editor StackExchange.Redis dan modifikasi berdasarkan komentar.

   Dalam contoh ini, StackExchange.Redis versi 2.7.20 digunakan.

   using StackExchange.Redis;
    // Atur endpoint, nomor port, dan kata sandi instans.
    private static ConfigurationOptions configurationOptions = ConfigurationOptions.Parse("r-bp10noxlhcoim2****.redis.rds.aliyuncs.com:6379,password=testaccount:Rp829dlwa,connectTimeout=2000");
     // kunci untuk 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;
    }

   Catatan

   • ConfigurationOptions adalah inti dari StackExchange.Redis. Ini dibagikan dan digunakan kembali oleh seluruh aplikasi dan harus disetel sebagai singleton. Untuk informasi lebih lanjut tentang pengaturan parameter, lihat ConfigurationOptions.

   • Objek yang dikembalikan oleh GetDatabase() ringan. Anda dapat mendapatkannya dari objek ConnectionMultiplexer setiap kali Anda menggunakannya.

      redisConn = getRedisConn();
      var db = redisConn.GetDatabase();

node-redis

1. Unduh dan instal klien node-redis.

2. Masukkan kode berikut di klien node-redis dan modifikasi berdasarkan komentar.

   Dalam contoh ini, Node.js 19.4.0 dan node-redis 4.5.1 digunakan.

   import { createClient } from 'redis';
   
   // Atur nomor port, endpoint, akun, dan kata sandi instans.
   const hostname = 'r-bp10noxlhcoim2****.redis.rds.aliyuncs.com';
   const port = 6379;
   const username = 'testaccount';
   // Jika kata sandi mengandung karakter khusus (!@#$%^&*()+-=_), kami sarankan Anda mengkodekan kata sandi menggunakan encodeURIComponent: password = encodeURIComponent(password)
   const password = 'Rp829dlwa';
   const client = createClient({
     // redis://[[username]:[password]@[hostname][:port]/[db-number]
     url: `redis://${username}:${password}@${hostname}:${port}/0`
   });
   
   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();

   Catatan

   Jika kesalahan SyntaxError: Cannot use import statement outside a module dilaporkan, ubah ekstensi file .js menjadi .mjs dan tambahkan opsi --experimental-modules saat Anda memanggil file. Contoh: node --experimental-modules redis.mjs.

Go-redis

1. Unduh dan instal klien Go-redis.

2. Masukkan kode berikut di editor Go-redis dan modifikasi berdasarkan komentar.

   Dalam contoh ini, Go 1.18.5 dan Go-redis 8.11.5 digunakan.

   package main
   
   import (
   	"github.com/go-redis/redis"
   	"fmt"
   )
   
   func ExampleClient() {
   	client := redis.NewClient(&redis.Options{
           // Ganti dengan endpoint dan port instans.
   		Addr:     "r-bp10noxlhcoim2****.redis.rds.aliyuncs.com:6379",
           // Ganti dengan kata sandi instans.
   		Password: "testaccount:Rp829dlwa",
   		DB:       0,  // gunakan DB default
   	})
       // Kode berikut memberikan contoh cara menggunakan SET dan 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