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;
}

功能相同，但有些人会更喜欢将大部分命令逻辑集中在一个函数中的简洁实现。

在线程内处理数据副本

为了使用实现命令慢速部分的线程，一个有趣的模式是使用数据的副本，以便在某个键中执行某个操作时，用户继续看到旧版本。然而，当线程终止其工作时，表示会交换，并使用新的处理版本。

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

未来工作

目前正在进行一项 API 工作，以便允许从线程中以安全的方式调用 Redis 模块 API，以便线程化命令可以访问数据空间并执行增量操作。

此功能没有预计到达时间，但它可能会在 Redis 4.0 发布过程中某个时间出现。

对本页进行评分