Redis模块使用和开发

一、介绍：
Redis4.0之后的版本便支持模块扩展功能，开发人员可以通过模块开发来增强Redis的功能、自定义类型，如实现redis的json解析。本文主要讲解如何引用一个Redis模块，以及如何来实现一个简单的模块化开发。

二、模块列表：
官方提供的一些扩展模块：Redis Module，有兴趣的同学可以看下有没有满足自己需求的模块，同时这些都是托管在githup上面，开发同学可以学习下别人的模块是如何开发的。

三、RedisJson模块介绍：
RedisJson支持了完全支持JSON标准，实现类似于jsonpath的语法，用于选择文档内的元素，支持写入各种json数据和读取，关于更多介绍，请看：RedisJson详细介绍

四、安装RedisJson模块：
1、从githup下载：
$ git clone https://github.com/RedisJSON/RedisJSON.git
2、编译为一个动态链接库：
$ cd RedisJSON
$ make
3、编译成功：
如果成功，则看到对应生成的库文件：
$ ls src/rejson.so
4、通过redis-cli连接到redis-server
$ redis-cli -h 127.0.0.1
5、加载RedisJson模块
127.0.0.1:6379> MODULE load /opt/study/RedisJSON/src/rejson.so，返回"OK"
6、查看已经加载的模块
127.0.0.1:6379> MODULE list，返回 name为ReJSON的模块名，并且返回对应的版本号
7、测试模块功能：
此时已经正确地安装成功了，我们测试下：
1）写入：JSON.SET amoreinterestingexample . '[ true, { "answer": 42 }, null ]'
内容可以为普通字符串或者json字符串
2）读取：JSON.GET amoreinterestingexample [1].answer
3）删除：JSON.DEL amoreinterestingexample [-1]
完整使用命令：https://oss.redislabs.com/redisjson/commands/

五、模块开发流程：
具有c开发能力的同学可以尝试自己完成一个模块，利用强大的Redis Module相关Api可以操作Redis的内存数据。本小节只做为一个简单的演示以及讲解相关语法，主要目的是为了把整个模块开发流程跑通。
1、代码演示：
将如下代码保存为redis_lai.c

//
// Created by 赖来基 on 2019/12/1.
//
#include "redismodule.h"
#include 
int SayHi_RedisCommand(RedisModuleCtx *ctx, RedisModuleString **argv, int argc){
    RedisModule_ReplyWithCString(ctx, "Hi,Lailaiji.");
    return REDISMODULE_OK;

}
int RedisModule_OnLoad(RedisModuleCtx *ctx, RedisModuleString **argv, int argc){
    int ret = 0;
    ret = RedisModule_Init(ctx, "lai", 1, REDISMODULE_APIVER_1);
    assert(ret == REDISMODULE_OK);
    ret = RedisModule_CreateCommand(ctx, "lai.say", SayHi_RedisCommand, "readonly", 0, 0, 0);
    assert(ret == REDISMODULE_OK);
    return REDISMODULE_OK;
}

2、手工编译动态链接库
$ gcc -o lai.so --shared -fPIC redis_HelloWorld.c -I/opt/study/redis/src/
-I参数：redismodule.h文件所在路径，该文件可以直接从redis源码github下载
3、加载
上面编译成功成会生成一个lai.so文件，我们把其加载到redis:
127.0.0.1:6379> module load /Users/lailaiji/CLionProjects/RedisModuleTest/lai.so
4、测试：
127.0.0.1:6379> lai.say 成功返回："Hi,Lailaiji."

六、演示代码分解：
上面示例主要是通过实现了两个函数来完成输出功能。
1、RedisModule_OnLoad（模块加载入口）
该函数为RedisModule加载的入口函数，该函数的参数为固定
我们需要在该函数体实现模块注册（RedisModule_Init），建立命令与命令函数绑定（RedisModule_CreateCommand）

RedisModule_Init 函数：向Redis内核注册模块名及版本

int RedisModule_Init(RedisModuleCtx *ctx, const char *modulename, int module_version, int api_version);
ctx:RedisModule上下文，直接引用即可
modulename: 通知Redis内核该模块的名称
module_version: 该模块的自定义版本
api_version: Redis模块支持的API版本，如果该版本与Redis的API版本不兼容时会报错。

RedisModule_CreateCommand 函数 ：创建命令

int RedisModule_CreateCommand(RedisModuleCtx *ctx, const char *name, RedisModuleCmdFunc cmdfunc, const char *strflags, int firstkey, int lastkey, int keystep);
ctx:RedisModule上下文，直接引用即可
name:命令名
cmdfunc:调用的函数
strflags:指定命令的行为，如读写（可通过空格来指定多种行为）
firstkey:输入命令行中参数的第几个位置为第一个模块参数
lastkey:输入命令行中参数的第几个位置为最后一个模块参数
keystep:参数位置步调，如mset命令key,val,key,val

提示：在官方演示例子：https://redis.io/topics/modules-intro，RedisModule_CreateCommand使用的4个参数是错误的

2、SayHi_RedisCommand 回调自定义命令函数
上面由RedisModule_CreateCommand进行命令与回调的绑定后，我们就可以在该函数完成我们需要的工作

int RedisModule_ReplyWithCString(RedisModuleCtx *ctx, const char *buf);
ctx:RedisModule上下文，直接引用即可
buf:普通C的字符串

提示：该函数必须返回REDISMODULE_OK，才能有效
六：其他
1、如何让redis-server启动时自动加载某些模块？
可以通过redis.conf在最后添加一行：

loadmodule /Users/lailaiji/CLionProjects/RedisModuleTest/lai.so

七：小结
这篇文章给大家展示Redis模块的使用及简单的开发过程，需要深入了解Redis模块和开发API，最好的教程是官方的文档：https://redis.io/topics/modules-api-ref，上面还有很多本文没有介绍到的一些强大的API，利用它们才能将Redis module发挥到极致。