手把手教你玩儿一下 Redis Module 之模块解读

引子

Redis 现在的 Stable 版本是4.0.11, 对Redis比较关注的童鞋都知道,4.0引入了 Module 。
我们先一起看看 Redis 4.0都更新了啥?


官方说法

Redis 4.0 was released as GA in July 2017. Contains several big improvements: a modules system, much better replication (PSYNC2), improvements to eviction policies, threaded DEL/FLUSH, mixed RDB+AOF format, Raspberry Pi support as primary platform, the new MEMORY command, Redis Cluster support for Nat/Docker, active memory defragmentation, memory usage and performance improvements, much faster Redis Cluster key creation, many other smaller features and a number of behavior fixed.

简单总结一下:

  1. 自定义扩展 redis 的模块, 当然相比 redis lua 脚本来说,还是有些学习成本的…

  2. psync2 他的好处在于 redis 主从切换后,不需要重新进行 重新 fullsync 同步,只需要部分同步,有点类似 binlog 那种. 具体实现还没看,阿里自己是通过 timestamp 时间戳实现的.

  3. memory 指令可以估算内容大小

  4. 非数据命令的异步执行,我们知道 redis 处理请求是单线程的,执行数据偏大的 flush 及 del 会阻塞的,redis 4.0 加了异步操作的功能….

多图预告

file
file
file

咱们今天就玩儿一下 Redis Module

模块可以做什么

1. 站在巨人的肩膀上 (访问 Redis 数据空间)

官方模块教程 https://redis.io/topics/modules-intro

Redis 提供了两套数据访问的 API,一套是较高层的,类似于 Lua 脚本的 API,往往用来调用 API 没有提供支持的 Redis 命令。
另一套是底层 API,速度很快,基本和 Redis 原生命令一样快,也提供了一些对各种数据结构的进行处理的函数,是推荐的数据访问方式。

高层 API 使用RedisModule_Call调用 Redis 命令,如:

RedisModuleCallReply *reply;
reply = RedisModule_Call(ctx,"INCR","sc",argv[1],"10");

底层 API 使用RedisModule_OpenKey打开并获取 Key 指针继而进行后续处理,如:

RedisModuleKey *key;
key = RedisModule_OpenKey(ctx,"somekey",REDISMODULE_READ);

2. 走的更远 (实现新的数据结构)

对于简单的数据结构,可以使用 DMA(direct memory access) 将结构编码保存到 Redis 的 String 类型中,如:

// 获取字符串内存指针继而修改其内容
size_t len;
char *myptr = RedisModule_StringDMA(key,&len,REDISMODULE_WRITE);
//  增大,减少或创建字符串
RedisModule_StringTruncate(key,1024);

也可以使用 API 注册并实现新的数据结构,可以控制内存的分配与释放,RDB 序列化,AOF 重写等。这里是 Redis 官方的一个例子,好奇的同学可以自己点进去看看。

3. 灵活拓展 (实现阻塞命令)

阻塞命令(Blocking commands)会阻塞客户端,直到某个期望的事件发生才会返回,比如 List 的BLPOP命令。模块 API 也提供了实现阻塞命令的功能。
Redis 在内置命令集中有一些阻塞命令。其中最常用的是 BLPOP(或对称 BRPOP),它阻止等待到达列表的元素。
关于阻塞命令的有趣事实是它们不会阻塞整个服务器,而只是阻塞它们的客户端。通常阻塞的原因是我们期望发生一些外部事件:这可能是 Redis 数据结构中的一些变化,例如 BLPOP 情况,线程中发生的长计算,从网络接收一些数据,等等。

详细见文档: https://redis.io/topics/modules-blocking-ops

4. 自由发挥 (加载模块)

模块有两种加载方式,一是在配置文件redis.conf中使用
loadmodule /path/to/mymodule.so 在 Redis 启动时加载。

查看加载的模块:


file

另一种方式在运行时使用命令 MODULE LOAD /path/to/panda.so 加载。

file

使用MODULE UNLOAD panda卸载。

file

在载入的模块的时候可以传入参数,如:loadmodule panda.so hello panda 1234,
参数会被传入模块的OnLoad方法中。

5. 人多力量大 (对 Redis Cluster 的支持)

官方文档提供了两个API

RedisModule_IsKeysPositionRequest(ctx);
RedisModule_KeyAtPos(ctx,pos);

在首次RedisModule_CreateCommand() 时需要 调用API方法

int RedisModule_CreateCommand(RedisModuleCtx *ctx, const char *name, RedisModuleCmdFunc cmdfunc, const char *strflags, int firstkey, int lastkey, int keystep);

其中的strflags参数的一个 flag 为getkeys-api,意思是这个方法是否支持返回参数中 key。一个方法接收的参数有多个,但并不是每一个都是 key,比如LRANGE key start stop中,只有第一个参数是 key。而 Redis 需要知道一个命令涉及到哪些 key,才能在集群中找到对应的服务器并执行命令。

可以参考这个模块的代码 https://github.com/RedisLabsModules/redex/blob/master/src/rxzsets.c

官方模块仓库 (Redis Module Hub)

官方模块仓库收录很多优质的模块:


file

新数据结构,如:

rejson 提供了对原生 JSON 格式支持,允许对 JSON 数据内的值进行获取与修改

Redis Graph 添加了对图数据库的支持
等等

对现有数据结构功能的扩展,如:

rxkeys 提供了按正则表达式批量获取与删除条目的功能
rxhashes 提供了在 Hash 中改变现有条目的值并返回原值的原子操做
rxlists 提供了 7 个新的列表操作方法。

百闻不如一run

写了一个非常简单的Redis Module 用于学习

redis-module-panda

A simple redis module , Just for fun

Inspire And Thanks

https://redis.io/topics/modules-intro
https://redislabs.com/community/redis-modules-hub/
https://github.com/erans/redissnowflake
https://github.com/dayeshisir/redis_module_timestamp

安装

1. 克隆代码

git clone https://github.com/wujunze/redis-module-panda.git

2. make

make
file

3. 加载模块

redis 的版本必须大于4.0

file

查看已经安装的模块

file

加载模块

file

Run

127.0.0.1:6379> panda.hello
file

测试命令

file

卸载模块

file

完整的测试过程

file

代码仓库: https://github.com/wujunze/redis-module-panda

觉得有收获请star哦, 还有下集,Thanks

Inspire And Thanks

https://redis.io/topics/modules-intro

https://redislabs.com/community/redis-modules-hub/

https://liangshuang.name/2017/08/19/redis-module/

https://github.com/erans/redissnowflake

https://github.com/dayeshisir/redis_module_timestamp

笔者才疏学浅,仓促成文,如有不当之处,还请大家斧正.

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,242评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,769评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,484评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,133评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,007评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,080评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,496评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,190评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,464评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,549评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,330评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,205评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,567评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,889评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,160评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,475评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,650评论 2 335

推荐阅读更多精彩内容

  • 关于Mongodb的全面总结 MongoDB的内部构造《MongoDB The Definitive Guide》...
    中v中阅读 31,862评论 2 89
  • 1.1 资料 ,最好的入门小册子,可以先于一切文档之前看,免费。 作者Antirez的博客,Antirez维护的R...
    JefferyLcm阅读 17,016评论 1 51
  • iOS第三方类库(转载)
    CoderZXS阅读 68评论 0 0
  • 1.电商改变了供给中物资、财产、资料等需要的人使用率,使更多的人更方便的获得他们想要的,为人们提供便捷。电商没有改...
    d8e61f2c6cdf阅读 132评论 1 1
  • 走在空旷的街,回望身后来时的路,像是在阴暗潮湿的隧道里,一步步艰难的蠕动。那种充满挫败,暗无天日的日子,终究还...
    安陌沫阅读 242评论 0 1