Redis 模块和阻塞命令

如何在 Redis 模块中实现阻塞命令

Redis 的内置命令集包含一些阻塞命令。最常用的命令之一是 BLPOP（或对称的 BRPOP），它会阻塞等待列表中的元素到达。

关于阻塞命令的一个有趣事实是，它们不会阻塞整个服务器，而只会阻塞调用它们的客户端。通常阻塞的原因是我们期望发生一些外部事件：这可以是 Redis 数据结构的某些变化，如 BLPOP 的情况，线程中发生的长时间计算，接收来自网络的数据等等。

Redis 模块也能够实现阻塞命令，本文档将展示 API 的工作原理，并描述一些可用于构建阻塞命令的模式。

阻塞和恢复的工作原理。

注意：您可能想查看 Redis 源代码树中 src/modules 目录下的 helloblock.c 示例，以获取关于如何应用阻塞 API 的简单易懂的示例。

在 Redis 模块中，命令由回调函数实现，当用户调用特定命令时，Redis 核心会调用这些函数。通常，回调函数会通过向客户端发送回复来终止执行。而使用以下函数，实现模块命令的函数可以请求将客户端置于阻塞状态

RedisModuleBlockedClient *RedisModule_BlockClient(RedisModuleCtx *ctx, RedisModuleCmdFunc reply_callback, RedisModuleCmdFunc timeout_callback, void (*free_privdata)(void*), long long timeout_ms);

该函数返回一个 RedisModuleBlockedClient 对象，该对象随后用于解除客户端的阻塞。参数含义如下

  • ctx 是命令执行上下文，与其他 API 一样。
  • reply_callback 是一个回调函数，与普通命令函数具有相同的原型，当客户端解除阻塞时调用，以便向客户端返回回复。
  • timeout_callback 是一个回调函数，与普通命令函数具有相同的原型，当客户端达到 ms 超时时调用。
  • free_privdata 是用于释放私有数据的回调函数。私有数据是指一个数据指针，该数据在用于解除客户端阻塞的 API 与向客户端发送回复的回调函数之间传递。我们将在本文档后面看到此机制的工作原理。
  • ms 是以毫秒为单位的超时时间。当达到超时时间时，将调用超时回调函数，并且客户端将自动中止。

客户端一旦被阻塞，可以使用以下 API 解除阻塞

int RedisModule_UnblockClient(RedisModuleBlockedClient *bc, void *privdata);

该函数以先前调用 RedisModule_BlockClient() 返回的阻塞客户端对象作为参数，并解除客户端的阻塞。在客户端解除阻塞之前，会立即调用阻塞客户端时指定的 reply_callback 函数：此函数将有权访问此处使用的 privdata 指针。

重要提示：上述函数是线程安全的，可以在执行某些工作的线程中调用，以实现阻塞客户端的命令。

当客户端解除阻塞时，将使用 free_privdata 回调自动释放 privdata 数据。这非常有用，因为在客户端超时或断开与服务器的连接的情况下，回复回调函数可能永远不会被调用，因此由外部函数负责在需要时释放传递的数据非常重要。

为了更好地理解 API 的工作原理，我们可以设想编写一个命令，该命令会阻塞客户端一秒钟，然后发送“Hello!”作为回复。

注意：此命令未实现参数个数检查和其他不重要的事情，以便示例简单易懂。

int Example_RedisCommand(RedisModuleCtx *ctx, RedisModuleString **argv,
                         int argc)
{
    RedisModuleBlockedClient *bc =
        RedisModule_BlockClient(ctx,reply_func,timeout_func,NULL,0);

    pthread_t tid;
    pthread_create(&tid,NULL,threadmain,bc);

    return REDISMODULE_OK;
}

void *threadmain(void *arg) {
    RedisModuleBlockedClient *bc = arg;

    sleep(1); /* Wait one second and unblock. */
    RedisModule_UnblockClient(bc,NULL);
}

上述命令会尽快阻塞客户端，并生成一个线程，该线程将等待一秒钟并解除客户端的阻塞。让我们检查回复和超时回调函数，在我们的示例中，它们非常相似，因为它们只是使用不同的回复类型回复客户端。

int reply_func(RedisModuleCtx *ctx, RedisModuleString **argv,
               int argc)
{
    return RedisModule_ReplyWithSimpleString(ctx,"Hello!");
}

int timeout_func(RedisModuleCtx *ctx, RedisModuleString **argv,
               int argc)
{
    return RedisModule_ReplyWithNull(ctx);
}

回复回调函数仅将“Hello!”字符串发送给客户端。这里的重点是，当客户端从线程解除阻塞时，会调用回复回调函数。

超时命令返回 NULL，这通常发生在实际 Redis 阻塞命令超时时。

解除阻塞时传递回复数据

上面的示例易于理解，但缺少实际阻塞命令实现的一个重要现实方面：回复函数通常需要知道要回复给客户端什么，而这些信息通常在客户端解除阻塞时提供。

我们可以修改上面的示例，以便线程在等待一秒钟后生成一个随机数。您可以将其视为某种实际的昂贵操作。然后可以将此随机数传递给回复函数，以便将其返回给命令调用者。为了实现此功能，我们按如下方式修改函数

void *threadmain(void *arg) {
    RedisModuleBlockedClient *bc = arg;

    sleep(1); /* Wait one second and unblock. */

    long *mynumber = RedisModule_Alloc(sizeof(long));
    *mynumber = rand();
    RedisModule_UnblockClient(bc,mynumber);
}

如您所见，现在解除阻塞调用会将一些私有数据，即 mynumber 指针，传递给回复回调函数。为了获取此私有数据，回复回调函数将使用以下函数

void *RedisModule_GetBlockedClientPrivateData(RedisModuleCtx *ctx);

因此，我们的回复回调函数修改如下

int reply_func(RedisModuleCtx *ctx, RedisModuleString **argv,
               int argc)
{
    long *mynumber = RedisModule_GetBlockedClientPrivateData(ctx);
    /* IMPORTANT: don't free mynumber here, but in the
     * free privdata callback. */
    return RedisModule_ReplyWithLongLong(ctx,mynumber);
}

请注意，在使用 RedisModule_BlockClient() 阻塞客户端时，我们还需要传递一个 free_privdata 函数，因为必须释放分配的长整型值。我们的回调函数将如下所示

void free_privdata(void *privdata) {
    RedisModule_Free(privdata);
}

注意：重要的是要强调，私有数据最好在 free_privdata 回调函数中释放，因为如果客户端断开连接或超时，可能不会调用回复函数。

另请注意，私有数据也可从超时回调函数访问，始终使用 GetBlockedClientPrivateData() API。

中止客户端的阻塞

有时出现的一个问题是，我们需要分配资源来实现非阻塞命令。因此，我们阻塞客户端，然后，例如，尝试创建一个线程，但线程创建函数返回错误。在这种情况下，为了恢复，该怎么办？我们不想让客户端保持阻塞状态，也不想调用 UnblockClient()，因为这会触发回复回调函数被调用。

在这种情况下，最好的办法是使用以下函数

int RedisModule_AbortBlock(RedisModuleBlockedClient *bc);

实际使用方法如下

int Example_RedisCommand(RedisModuleCtx *ctx, RedisModuleString **argv,
                         int argc)
{
    RedisModuleBlockedClient *bc =
        RedisModule_BlockClient(ctx,reply_func,timeout_func,NULL,0);

    pthread_t tid;
    if (pthread_create(&tid,NULL,threadmain,bc) != 0) {
        RedisModule_AbortBlock(bc);
        RedisModule_ReplyWithError(ctx,"Sorry can't create a thread");
    }

    return REDISMODULE_OK;
}

客户端将被解除阻塞，但回复回调函数不会被调用。

使用单个函数实现命令、回复和超时回调

可以使用以下函数，以便使用实现主要命令函数的同一函数来实现回复和回调

int RedisModule_IsBlockedReplyRequest(RedisModuleCtx *ctx);
int RedisModule_IsBlockedTimeoutRequest(RedisModuleCtx *ctx);

因此，我可以重写示例命令，而不使用单独的回复和超时回调函数

int Example_RedisCommand(RedisModuleCtx *ctx, RedisModuleString **argv,
                         int argc)
{
    if (RedisModule_IsBlockedReplyRequest(ctx)) {
        long *mynumber = RedisModule_GetBlockedClientPrivateData(ctx);
        return RedisModule_ReplyWithLongLong(ctx,mynumber);
    } else if (RedisModule_IsBlockedTimeoutRequest) {
        return RedisModule_ReplyWithNull(ctx);
    }

    RedisModuleBlockedClient *bc =
        RedisModule_BlockClient(ctx,reply_func,timeout_func,NULL,0);

    pthread_t tid;
    if (pthread_create(&tid,NULL,threadmain,bc) != 0) {
        RedisModule_AbortBlock(bc);
        RedisModule_ReplyWithError(ctx,"Sorry can't create a thread");
    }

    return REDISMODULE_OK;
}

功能上是一样的，但有些人更喜欢不太冗长的实现，因为它将大部分命令逻辑集中在一个函数中。

在线程内部处理数据副本

使用线程实现命令慢速部分的有趣模式是处理数据副本，这样当对某个键执行某些操作时，用户仍然会看到旧版本。然而，当线程完成其工作时，表示会被交换，并使用新的、已处理的版本。

此方法的一个示例是 Neural Redis 模块，其中神经网络在不同的线程中进行训练，而用户仍然可以执行和检查它们的旧版本。

未来工作

目前正在开发一个 API，以允许从线程安全地调用 Redis 模块 API，从而使线程化命令可以访问数据空间并执行增量操作。

此功能没有预计完成时间 (ETA)，但可能会在 Redis 4.0 版本发布期间的某个时候出现。

评价此页
返回顶部 ↑