写在前面

Redis 4.0的一个重大提示是提供了插件化的模块机制，为用户的业务扩展提供了极大的便利。

在简单查看了几个博客之后，试着写了个简单的module样例，当然，参考了ID生成器 和 博客的设计。当然，作为第一个例子，尽量越简单、越使用，越好。

module简单介绍

Redis模块是一种动态库，可以用与Redis内核相似的运行速度和特性来扩展Redis内核的功能。作者认为lua脚本只是组合Redis内核的现有功能，但是Redis模块则可以扩展Redis内核的功能。主要提供以下几个方面的扩展

• 可以如lua脚本或者client一样，通过RedisModule_Call接口直接执行redis命令并获取执行结果。Redis称呼这种API为高层API。

• 可以通过RedisModule_OpenKey接口，获取底层键，并根据键的类型以及各类型提供的模块操作接口进行底层操作。

• 自动内存管理(Automatic memory management)，可以在回调函数中，调用RedisModule_AutoMemory打开自动内存管理功能，这样随后分配的RedisModuleString对象、open key等，redis会记录下来，当回调函数返回的时候，redis会把这些资源自动释放调。这意味着不能在自动内存管理打开的情况下，创建RedisModuleString等对象来初始化全局变量。

• redis本地类型(native types support)创建。通过提供RDB保存、RDB加载、AOF重写等回调函数，在Redis模块中可以创建类似redis内部dict、list之类的数据类型。例如可以在模块中创建一个链表，并提供对应的回调函数，这样redis在保存RDB文件的时候，就可以把模块中的数据保存在RDB中，在redis启动从rdb中加载数据的时候，进而可以恢复模块数据状态。

• 阻塞命令。在redis模块中可以将client阻塞，并设置超时时间。以实现类似BLPOP的阻塞命令。

module代码

 #include <stdio.h>
 #include<sys/time.h>
 #include "redismodule.h"

 int GetTimeCommand(RedisModuleCtx *ctx, RedisModuleString **argv, int argc) {
   struct timeval tp;
   gettimeofday(&tp, NULL);
   long int millisecs = tp.tv_sec * 1000 + tp.tv_usec/1000;
   RedisModule_ReplyWithLongLong(ctx, millisecs);
   return REDISMODULE_OK;
 }

 int RedisModule_OnLoad(RedisModuleCtx *ctx, RedisModuleString **argv, int argc) {
   if (RedisModule_Init(ctx, "time", 1, REDISMODULE_APIVER_1) ==
       REDISMODULE_ERR) {
     return REDISMODULE_ERR;
   }

   RedisModule_Log(ctx, "info", "time start up");

   if (RedisModule_CreateCommand(ctx, "timestamp.gettime", GetTimeCommand, "readonly",
                                 1, 1, 1) == REDISMODULE_ERR) {
     return REDISMODULE_ERR;
   }

   return REDISMODULE_OK;
 }

加载测试

• 加载进Redis

127.0.0.1:7000> module load /Users/sirshi/LNMP/src/redis_module_timestamp/redistimestampmodule.so

image.png

• 查看加载是否成功

127.0.0.1:7000> module list

image.png

*查看功能是否正常

127.0.0.1:7000> timestamp.gettime

image.png

总结

• RedisModule_OnLoad是每个Redis模块的入口函数，在加载模块的时候，就是通过查找这个函数的入口地址来开始执行redis模块代码的。

• RedisModule_Init是在调用redis模块API之前必须调用的初始化函数。一般应放在RedisModule_OnLoad的最开始位置。如果没有执行RedisModule_Init，就调用redis模块的API，则会产生空指针异常。

github

参考：
1、https://www.cnblogs.com/jabnih/p/7241866.html
2、https://github.com/erans/redissnowflake
3、https://redislabs.com/community/redis-modules-hub/
4、http://www.bubuko.com/infodetail-1877439.html