Flutter Redis客户端插件ioredis的使用

Flutter Redis客户端插件ioredis的使用

ioredis简介

ioredis 是一个用于Dart的Redis客户端库，支持多种功能，包括发布/订阅（Pub/Sub）、连接池、自动重连、重试策略和数据库选择等。

功能特性

• 支持发布/订阅（Pub/Sub）
• 默认支持连接池
• 支持自动重连
• 支持重试策略
• 支持选择不同的数据库

基本用法

创建Redis实例

// 创建一个新的Redis实例，默认连接到本地的Redis服务器
Redis redis = new Redis();

// 指定主机和端口
Redis redis = new Redis(RedisOptions(host: '127.0.0.1', port: 6379));

// 指定用户名、密码和数据库
Redis redis = new Redis(
    RedisOptions(
        username: 'root', 
        password: 'password',
        db: 1,
    ),
);

设置键值对

// 设置一个键值对
await redis.set('key', 'value');

// 设置一个带有过期时间的键值对（10秒后过期）
await redis.set('key', 'value', 'EX', 10);

获取键值

// 获取单个键的值
String? value = await redis.get('key');

// 获取多个键的值
List<String?> values = await redis.mget(['key1', 'key2']);

发布/订阅 (Pub/Sub)

// 创建两个Redis客户端实例，一个用于订阅，一个用于发布
Redis subClient = new Redis();
Redis pubClient = subClient.duplicate();

// 订阅频道
RedisSubscriber subscriber = await subClient.subscribe('chat');
subscriber.onMessage = (String channel, String? message) {
    print('Channel: $channel, Message: $message');
};

// 发布消息
await pubClient.publish('chat', 'hello');

删除键

// 删除单个键
await redis.delete('key');

// 删除多个键
await redis.mdelete(['key1', 'key2']);

清空当前数据库

// 清空当前数据库中的所有键
await redis.flushdb();

发送自定义命令

// 发送自定义命令，例如 GET key
String? value = await redis.sendCommand(['GET', 'key']);

连接池

// 使用连接池，最大连接数为10
Redis redis = new Redis(RedisOptions(maxConnection: 10));
String? value = await redis.get('key');

管道操作 (Pipelining)

// 使用管道批量执行多个命令
List<dynamic> result = await redis.multi()
    .set('key', 'value')
    .set('key2', 'value2')
    .get('key')
    .get('key2')
    .exec();

// result => ['OK', 'OK', 'value', 'value2']

完整示例代码

以下是一个完整的示例代码，展示了如何在Flutter项目中使用ioredis与Redis进行交互：

import 'package:ioredis/ioredis.dart';

void main() async {
  // 创建一个新的Redis实例，连接到本地的Redis服务器
  Redis redis = Redis(RedisOptions(host: '127.0.0.1', port: 6379));

  try {
    // 设置一个键值对
    await redis.set('greeting', 'Hello, Redis!');

    // 获取键值
    String? greeting = await redis.get('greeting');
    print('Greeting: $greeting');

    // 设置一个带有过期时间的键值对（5秒后过期）
    await redis.set('temp_key', 'This will expire in 5 seconds', 'EX', 5);

    // 获取多个键的值
    List<String?> multipleValues = await redis.mget(['greeting', 'temp_key']);
    print('Multiple values: $multipleValues');

    // 发布/订阅 (Pub/Sub)
    Redis subClient = redis.duplicate();
    Redis pubClient = redis.duplicate();

    // 订阅频道
    RedisSubscriber subscriber = await subClient.subscribe('chat');
    subscriber.onMessage = (String channel, String? message) {
      print('Received message on channel $channel: $message');
    };

    // 发布消息
    await pubClient.publish('chat', 'Hello from the publisher!');

    // 等待几秒钟以确保消息被接收
    await Future.delayed(Duration(seconds: 2));

    // 删除键
    await redis.delete('greeting');
    await redis.delete('temp_key');

    // 清空当前数据库
    await redis.flushdb();

    // 关闭连接
    await redis.quit();
  } catch (e) {
    print('Error: $e');
  }
}